{ "schema_version": 2, "generated_by": "BuildTools/docs_api.py", "source_parser": "BuildTools/codegen.py", "scope": { "repository": "cvet/fonline", "surface": "engine-native-codegen", "default_stability": "experimental", "contract": { "selector": "scope:native-codegen", "stability": "experimental", "since": "2022.1.0.wip", "symbol_count": 2555, "inventory_sha256": "7a8bef24e97c589f0113e44ee76aaacfc531585cd0203ca075b38bbbe8560ccf", "examples": [], "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "The native-codegen surface is offered for evaluation only, and stays revision-pinned until supported release lines exist.\nSymbolCount and InventorySha256 force owner review of every addition, removal or stable-ID change" }, "included": [ "native script enums, value types, reference types, entities, properties, methods, and events", "engine settings parsed from ExportSettings", "native migration rules", "source-authored API contracts parsed from ApiContract" ], "excluded": [ "project-authored script metadata, including remote calls", "CMake options and stage helpers", "BuildTools command-line interfaces", "package layouts and native extension ABI details" ] }, "parser_contract": { "export_targets": [ "server", "client", "mapper", "common" ], "registration_targets": [ "server", "client", "mapper" ], "engine_hook_names": [ "ApplicationInitHook", "ApplicationShutdownHook", "ServerInitHook", "ClientInitHook", "ClientStartupSettingsHook", "SetupBakersHook", "CheckCritterVisibilityHook", "CheckItemVisibilityHook" ], "migration_rule_kinds": [ "Version", "Property", "Proto", "Component", "Remove" ], "api_stability_labels": [ "stable", "experimental", "internal", "deprecated" ], "api_contract_scope_selector": "scope:native-codegen" }, "summary": { "symbol_count": 2555, "symbols_by_kind": { "entity": 7, "enum": 58, "enum-value": 773, "event": 122, "method": 997, "migration-rule": 28, "property": 132, "ref-field": 41, "ref-method": 28, "ref-type": 6, "setting": 279, "value-field": 62, "value-type": 22 }, "symbols_by_stability": { "experimental": 2554, "internal": 1 }, "explicit_contract_declaration_count": 3, "explicit_contract_symbol_count": 2555, "default_contract_symbol_count": 0, "explicit_contracts_by_stability": { "experimental": 2554, "internal": 1 }, "described_symbol_count": 2555, "missing_description_count": 0, "symbols_without_source_count": 14, "metadata_source_file_count": 43, "contract_source_file_count": 2 }, "metadata_source_files": [ "Source/Client/Client.h", "Source/Client/EffectManager.h", "Source/Client/FontManager.h", "Source/Client/MapSprite.h", "Source/Client/MapView.h", "Source/Client/SpriteManager.h", "Source/Common/Common.h", "Source/Common/Entity.h", "Source/Common/EntityProperties.h", "Source/Common/Geometry.h", "Source/Common/ImGuiExt/ImGuiStuff.h", "Source/Common/Movement.h", "Source/Common/Settings.inc", "Source/Common/TextPack.h", "Source/Common/TimeEvents.h", "Source/Essentials/ExtendedTypes.h", "Source/Essentials/TimeRelated.h", "Source/Frontend/Application.h", "Source/Frontend/Rendering.h", "Source/Scripting/ClientCritterScriptMethods.cpp", "Source/Scripting/ClientEntityScriptMethods.cpp", "Source/Scripting/ClientGlobalScriptMethods.cpp", "Source/Scripting/ClientImGuiScriptMethods.cpp", "Source/Scripting/ClientItemScriptMethods.cpp", "Source/Scripting/ClientMapScriptMethods.cpp", "Source/Scripting/CommonGlobalScriptMethods.cpp", "Source/Scripting/CommonImGuiScriptMethods.cpp", "Source/Scripting/MapperGlobalScriptMethods.cpp", "Source/Scripting/ServerCritterScriptMethods.cpp", "Source/Scripting/ServerEntityScriptMethods.cpp", "Source/Scripting/ServerGlobalScriptMethods.cpp", "Source/Scripting/ServerItemScriptMethods.cpp", "Source/Scripting/ServerLocationScriptMethods.cpp", "Source/Scripting/ServerMapScriptMethods.cpp", "Source/Scripting/ServerPlayerScriptMethods.cpp", "Source/Server/Critter.h", "Source/Server/Item.h", "Source/Server/Location.h", "Source/Server/Map.h", "Source/Server/Player.h", "Source/Server/Server.h", "Source/Server/ServerConnection.h", "Source/Tools/Mapper.h" ], "symbols": [ { "id": "migration.Property.Critter.Cond", "family_id": "migration.Property.Critter.Cond", "kind": "migration-rule", "name": "Cond", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Critter Cond Condition", "description": "Maps the legacy Critter property name Cond to Condition during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 375 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Critter", "replacement": "Condition" }, { "id": "migration.Property.Critter.IsControlledByPlayer", "family_id": "migration.Property.Critter.IsControlledByPlayer", "kind": "migration-rule", "name": "IsControlledByPlayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Critter IsControlledByPlayer ControlledByPlayer", "description": "Maps the legacy Critter property name IsControlledByPlayer to ControlledByPlayer during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 349 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Critter", "replacement": "ControlledByPlayer" }, { "id": "migration.Property.Critter.IsNoFlatten", "family_id": "migration.Property.Critter.IsNoFlatten", "kind": "migration-rule", "name": "IsNoFlatten", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Critter IsNoFlatten DeadDrawNoFlatten", "description": "Maps the legacy Critter property name IsNoFlatten to DeadDrawNoFlatten during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 386 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Critter", "replacement": "DeadDrawNoFlatten" }, { "id": "migration.Property.Critter.ScriptId", "family_id": "migration.Property.Critter.ScriptId", "kind": "migration-rule", "name": "ScriptId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Critter ScriptId InitScript", "description": "Maps the legacy Critter property name ScriptId to InitScript during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 302 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Critter", "replacement": "InitScript" }, { "id": "migration.Property.Item.Accessory", "family_id": "migration.Property.Item.Accessory", "kind": "migration-rule", "name": "Accessory", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item Accessory Ownership", "description": "Maps the legacy Item property name Accessory to Ownership during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 121 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "Ownership" }, { "id": "migration.Property.Item.BlockLines", "family_id": "migration.Property.Item.BlockLines", "kind": "migration-rule", "name": "BlockLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item BlockLines MultihexLines", "description": "Maps the legacy Item property name BlockLines to MultihexLines during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 170 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "MultihexLines" }, { "id": "migration.Property.Item.CritId", "family_id": "migration.Property.Item.CritId", "kind": "migration-rule", "name": "CritId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item CritId CritterId", "description": "Maps the legacy Item property name CritId to CritterId during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "CritterId" }, { "id": "migration.Property.Item.CritSlot", "family_id": "migration.Property.Item.CritSlot", "kind": "migration-rule", "name": "CritSlot", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item CritSlot CritterSlot", "description": "Maps the legacy Item property name CritSlot to CritterSlot during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 140 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "CritterSlot" }, { "id": "migration.Property.Item.IsColorize", "family_id": "migration.Property.Item.IsColorize", "kind": "migration-rule", "name": "IsColorize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsColorize Colorize", "description": "Maps the legacy Item property name IsColorize to Colorize during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 285 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "Colorize" }, { "id": "migration.Property.Item.IsFlat", "family_id": "migration.Property.Item.IsFlat", "kind": "migration-rule", "name": "IsFlat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsFlat DrawFlatten", "description": "Maps the legacy Item property name IsFlat to DrawFlatten during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 264 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "DrawFlatten" }, { "id": "migration.Property.Item.IsHidden", "family_id": "migration.Property.Item.IsHidden", "kind": "migration-rule", "name": "IsHidden", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsHidden Hidden", "description": "Maps the legacy Item property name IsHidden to Hidden during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 187 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "Hidden" }, { "id": "migration.Property.Item.IsHiddenPicture", "family_id": "migration.Property.Item.IsHiddenPicture", "kind": "migration-rule", "name": "IsHiddenPicture", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsHiddenPicture AlwaysHideSprite", "description": "Maps the legacy Item property name IsHiddenPicture to AlwaysHideSprite during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 195 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "AlwaysHideSprite" }, { "id": "migration.Property.Item.IsLight", "family_id": "migration.Property.Item.IsLight", "kind": "migration-rule", "name": "IsLight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsLight LightSource", "description": "Maps the legacy Item property name IsLight to LightSource during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 215 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "LightSource" }, { "id": "migration.Property.Item.IsLightThru", "family_id": "migration.Property.Item.IsLightThru", "kind": "migration-rule", "name": "IsLightThru", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsLightThru LightThru", "description": "Maps the legacy Item property name IsLightThru to LightThru during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "LightThru" }, { "id": "migration.Property.Item.IsNoBlock", "family_id": "migration.Property.Item.IsNoBlock", "kind": "migration-rule", "name": "IsNoBlock", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsNoBlock NoBlock", "description": "Maps the legacy Item property name IsNoBlock to NoBlock during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 200 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "NoBlock" }, { "id": "migration.Property.Item.IsNoHighlight", "family_id": "migration.Property.Item.IsNoHighlight", "kind": "migration-rule", "name": "IsNoHighlight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsNoHighlight NoHighlight", "description": "Maps the legacy Item property name IsNoHighlight to NoHighlight during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 272 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "NoHighlight" }, { "id": "migration.Property.Item.IsNoLightInfluence", "family_id": "migration.Property.Item.IsNoLightInfluence", "kind": "migration-rule", "name": "IsNoLightInfluence", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsNoLightInfluence NoLightInfluence", "description": "Maps the legacy Item property name IsNoLightInfluence to NoLightInfluence during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 277 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "NoLightInfluence" }, { "id": "migration.Property.Item.IsShootThru", "family_id": "migration.Property.Item.IsShootThru", "kind": "migration-rule", "name": "IsShootThru", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsShootThru ShootThru", "description": "Maps the legacy Item property name IsShootThru to ShootThru during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 205 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "ShootThru" }, { "id": "migration.Property.Item.IsStatic", "family_id": "migration.Property.Item.IsStatic", "kind": "migration-rule", "name": "IsStatic", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item IsStatic Static", "description": "Maps the legacy Item property name IsStatic to Static during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 116 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "Static" }, { "id": "migration.Property.Item.SceneryScript", "family_id": "migration.Property.Item.SceneryScript", "kind": "migration-rule", "name": "SceneryScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item SceneryScript StaticScript", "description": "Maps the legacy Item property name SceneryScript to StaticScript during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 235 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "StaticScript" }, { "id": "migration.Property.Item.ScriptId", "family_id": "migration.Property.Item.ScriptId", "kind": "migration-rule", "name": "ScriptId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item ScriptId InitScript", "description": "Maps the legacy Item property name ScriptId to InitScript during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "InitScript" }, { "id": "migration.Property.Item.Slot", "family_id": "migration.Property.Item.Slot", "kind": "migration-rule", "name": "Slot", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item Slot CritterSlot", "description": "Maps the legacy Item property name Slot to CritterSlot during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 142 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "CritterSlot" }, { "id": "migration.Property.Item.SubItemIds", "family_id": "migration.Property.Item.SubItemIds", "kind": "migration-rule", "name": "SubItemIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Item SubItemIds InnerItemIds", "description": "Maps the legacy Item property name SubItemIds to InnerItemIds during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 153 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Item", "replacement": "InnerItemIds" }, { "id": "migration.Property.Location.ScriptId", "family_id": "migration.Property.Location.ScriptId", "kind": "migration-rule", "name": "ScriptId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Location ScriptId InitScript", "description": "Maps the legacy Location property name ScriptId to InitScript during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 493 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Location", "replacement": "InitScript" }, { "id": "migration.Property.Map.CurDayTime", "family_id": "migration.Property.Map.CurDayTime", "kind": "migration-rule", "name": "CurDayTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Map CurDayTime FixedDayTime", "description": "Maps the legacy Map property name CurDayTime to FixedDayTime during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 456 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Map", "replacement": "FixedDayTime" }, { "id": "migration.Property.Map.DayTime", "family_id": "migration.Property.Map.DayTime", "kind": "migration-rule", "name": "DayTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Map DayTime DayColorTime", "description": "Maps the legacy Map property name DayTime to DayColorTime during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 461 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Map", "replacement": "DayColorTime" }, { "id": "migration.Property.Map.ScriptId", "family_id": "migration.Property.Map.ScriptId", "kind": "migration-rule", "name": "ScriptId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Property Map ScriptId InitScript", "description": "Maps the legacy Map property name ScriptId to InitScript during Engine migration lookup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 418 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Property", "scope": "Map", "replacement": "InitScript" }, { "id": "migration.Version.0.0", "family_id": "migration.Version.0.0", "kind": "migration-rule", "name": "0", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "Version 0 0 66", "description": "Force change of compatability version", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "rule_kind": "Version", "scope": "0", "replacement": "66" }, { "id": "script.entity.Critter", "family_id": "script.entity.Critter", "kind": "entity", "name": "Critter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity Critter", "description": "Prototype-backed character entity used for player bodies and NPCs, with inventory, movement, and map or global-map state.", "flags": [ "HasProtos", "HasTimeEvents" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 48 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "Critter", "client_class": "CritterView", "capabilities": { "global": false, "prototypes": true, "statics": false, "abstract": false, "time_events": true } }, { "id": "script.entity.Game", "family_id": "script.entity.Game", "kind": "entity", "name": "Game", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity Game", "description": "Global singleton script receiver for the current server, client, or Mapper engine; it exposes engine services, events, and game properties rather than a persistent world object.", "flags": [ "Global" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 44 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "ServerEngine", "client_class": "ClientEngine", "capabilities": { "global": true, "prototypes": false, "statics": false, "abstract": false, "time_events": false } }, { "id": "script.entity.ImGui", "family_id": "script.entity.ImGui", "kind": "entity", "name": "ImGui", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity ImGui", "description": "Global script receiver bound to the current engine's Dear ImGui context; individual methods define their active-frame and balanced-scope requirements.", "flags": [ "Global" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "ScriptImGui", "client_class": "ScriptImGui", "capabilities": { "global": true, "prototypes": false, "statics": false, "abstract": false, "time_events": false } }, { "id": "script.entity.Item", "family_id": "script.entity.Item", "kind": "entity", "name": "Item", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity Item", "description": "Prototype-backed item entity that can belong to a map, critter inventory, container, or custom holder and also exposes static and abstract variants.", "flags": [ "HasProtos", "HasStatics", "HasAbstract", "HasTimeEvents" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 49 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "Item", "client_class": "ItemView", "capabilities": { "global": false, "prototypes": true, "statics": true, "abstract": true, "time_events": true } }, { "id": "script.entity.Location", "family_id": "script.entity.Location", "kind": "entity", "name": "Location", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity Location", "description": "Prototype-backed world-location entity that owns instantiated maps on the server and is represented by LocationView on clients.", "flags": [ "HasProtos", "HasTimeEvents" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 46 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "Location", "client_class": "LocationView", "capabilities": { "global": false, "prototypes": true, "statics": false, "abstract": false, "time_events": true } }, { "id": "script.entity.Map", "family_id": "script.entity.Map", "kind": "entity", "name": "Map", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity Map", "description": "Prototype-backed instantiated map entity containing runtime critters and items; clients operate on its replicated MapView.", "flags": [ "HasProtos", "HasTimeEvents" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "Map", "client_class": "MapView", "capabilities": { "global": false, "prototypes": true, "statics": false, "abstract": false, "time_events": true } }, { "id": "script.entity.Player", "family_id": "script.entity.Player", "kind": "entity", "name": "Player", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "entity Player", "description": "Player account and connection-session entity, distinct from the Critter it may control; clients receive its replicated PlayerView.", "flags": [ "HasTimeEvents" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 45 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "server_class": "Player", "client_class": "PlayerView", "capabilities": { "global": false, "prototypes": false, "statics": false, "abstract": false, "time_events": true } }, { "id": "script.enum-value.CornerType.East", "family_id": "script.enum-value.CornerType.East", "kind": "enum-value", "name": "East", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CornerType", "signature": "CornerType.East = 2", "description": "Selects the east-facing wall-corner orientation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1073 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CornerType", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.CornerType.EastWest", "family_id": "script.enum-value.CornerType.EastWest", "kind": "enum-value", "name": "EastWest", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CornerType", "signature": "CornerType.EastWest = 5", "description": "Selects the combined east-west wall-corner orientation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1076 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CornerType", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.CornerType.North", "family_id": "script.enum-value.CornerType.North", "kind": "enum-value", "name": "North", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CornerType", "signature": "CornerType.North = 4", "description": "Selects the north-facing wall-corner orientation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1075 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CornerType", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.CornerType.NorthSouth", "family_id": "script.enum-value.CornerType.NorthSouth", "kind": "enum-value", "name": "NorthSouth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CornerType", "signature": "CornerType.NorthSouth = 0", "description": "Selects the combined north-south wall-corner orientation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1071 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CornerType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CornerType.South", "family_id": "script.enum-value.CornerType.South", "kind": "enum-value", "name": "South", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CornerType", "signature": "CornerType.South = 3", "description": "Selects the south-facing wall-corner orientation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1074 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CornerType", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.CornerType.West", "family_id": "script.enum-value.CornerType.West", "kind": "enum-value", "name": "West", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CornerType", "signature": "CornerType.West = 1", "description": "Selects the west-facing wall-corner orientation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1072 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CornerType", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterAction.Connect", "family_id": "script.enum-value.CritterAction.Connect", "kind": "enum-value", "name": "Connect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.Connect = 20", "description": "Notifies observers that the player-controlled critter connected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 991 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "20", "evaluated_value": 20, "generated": false }, { "id": "script.enum-value.CritterAction.Dead", "family_id": "script.enum-value.CritterAction.Dead", "kind": "enum-value", "name": "Dead", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.Dead = 19", "description": "Notifies observers that the critter entered the dead condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 990 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "19", "evaluated_value": 19, "generated": false }, { "id": "script.enum-value.CritterAction.Disconnect", "family_id": "script.enum-value.CritterAction.Disconnect", "kind": "enum-value", "name": "Disconnect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.Disconnect = 21", "description": "Notifies observers that the player-controlled critter disconnected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 992 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "21", "evaluated_value": 21, "generated": false }, { "id": "script.enum-value.CritterAction.DropItem", "family_id": "script.enum-value.CritterAction.DropItem", "kind": "enum-value", "name": "DropItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.DropItem = 5", "description": "Notifies observers that the critter dropped an item from a slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 987 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.CritterAction.Knockout", "family_id": "script.enum-value.CritterAction.Knockout", "kind": "enum-value", "name": "Knockout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.Knockout = 16", "description": "Notifies observers that the critter entered the knockout condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 988 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.CritterAction.MoveItem", "family_id": "script.enum-value.CritterAction.MoveItem", "kind": "enum-value", "name": "MoveItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.MoveItem = 2", "description": "Notifies observers that an item moved between critter slots", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 985 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.CritterAction.None", "family_id": "script.enum-value.CritterAction.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.None = 0", "description": "No critter action notification is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 984 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterAction.Refresh", "family_id": "script.enum-value.CritterAction.Refresh", "kind": "enum-value", "name": "Refresh", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.Refresh = 23", "description": "Requests observers to refresh the critter's visual action state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 994 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "23", "evaluated_value": 23, "generated": false }, { "id": "script.enum-value.CritterAction.Respawn", "family_id": "script.enum-value.CritterAction.Respawn", "kind": "enum-value", "name": "Respawn", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.Respawn = 22", "description": "Notifies observers that the critter returned to the alive condition outside knockout recovery", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 993 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "22", "evaluated_value": 22, "generated": false }, { "id": "script.enum-value.CritterAction.StandUp", "family_id": "script.enum-value.CritterAction.StandUp", "kind": "enum-value", "name": "StandUp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.StandUp = 17", "description": "Notifies observers that the critter recovered from knockout and stood up", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 989 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "17", "evaluated_value": 17, "generated": false }, { "id": "script.enum-value.CritterAction.SwapItems", "family_id": "script.enum-value.CritterAction.SwapItems", "kind": "enum-value", "name": "SwapItems", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterAction", "signature": "CritterAction.SwapItems = 3", "description": "Notifies observers about the second item participating in a slot swap", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 986 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterAction", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.CritterActionAnim.DeadFront", "family_id": "script.enum-value.CritterActionAnim.DeadFront", "kind": "enum-value", "name": "DeadFront", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.DeadFront = 102", "description": "Requests the front-facing death animation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1022 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "102", "evaluated_value": 102, "generated": false }, { "id": "script.enum-value.CritterActionAnim.Idle", "family_id": "script.enum-value.CritterActionAnim.Idle", "kind": "enum-value", "name": "Idle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.Idle = 1", "description": "Requests the standing idle animation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1010 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterActionAnim.IdleProneFront", "family_id": "script.enum-value.CritterActionAnim.IdleProneFront", "kind": "enum-value", "name": "IdleProneFront", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.IdleProneFront = 86", "description": "Requests the front-facing prone idle animation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1021 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "86", "evaluated_value": 86, "generated": false }, { "id": "script.enum-value.CritterActionAnim.Limp", "family_id": "script.enum-value.CritterActionAnim.Limp", "kind": "enum-value", "name": "Limp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.Limp = 4", "description": "Requests the limping movement animation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1013 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.CritterActionAnim.None", "family_id": "script.enum-value.CritterActionAnim.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.None = 0", "description": "No action animation is requested", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1009 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterActionAnim.PanicRun", "family_id": "script.enum-value.CritterActionAnim.PanicRun", "kind": "enum-value", "name": "PanicRun", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.PanicRun = 6", "description": "Requests the panic-running animation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1018 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "6", "evaluated_value": 6, "generated": false }, { "id": "script.enum-value.CritterActionAnim.Run", "family_id": "script.enum-value.CritterActionAnim.Run", "kind": "enum-value", "name": "Run", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.Run = 5", "description": "Requests forward running", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1014 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.CritterActionAnim.RunBack", "family_id": "script.enum-value.CritterActionAnim.RunBack", "kind": "enum-value", "name": "RunBack", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.RunBack = 16", "description": "Requests backward running", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1015 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.CritterActionAnim.SneakRun", "family_id": "script.enum-value.CritterActionAnim.SneakRun", "kind": "enum-value", "name": "SneakRun", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.SneakRun = 8", "description": "Requests running in the sneaking posture", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1020 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.CritterActionAnim.SneakWalk", "family_id": "script.enum-value.CritterActionAnim.SneakWalk", "kind": "enum-value", "name": "SneakWalk", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.SneakWalk = 7", "description": "Requests walking in the sneaking posture", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1019 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "7", "evaluated_value": 7, "generated": false }, { "id": "script.enum-value.CritterActionAnim.TurnLeft", "family_id": "script.enum-value.CritterActionAnim.TurnLeft", "kind": "enum-value", "name": "TurnLeft", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.TurnLeft = 18", "description": "Requests an in-place left turn", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1017 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "18", "evaluated_value": 18, "generated": false }, { "id": "script.enum-value.CritterActionAnim.TurnRight", "family_id": "script.enum-value.CritterActionAnim.TurnRight", "kind": "enum-value", "name": "TurnRight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.TurnRight = 17", "description": "Requests an in-place right turn", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1016 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "17", "evaluated_value": 17, "generated": false }, { "id": "script.enum-value.CritterActionAnim.Walk", "family_id": "script.enum-value.CritterActionAnim.Walk", "kind": "enum-value", "name": "Walk", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.Walk = 3", "description": "Requests forward walking", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1011 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.CritterActionAnim.WalkBack", "family_id": "script.enum-value.CritterActionAnim.WalkBack", "kind": "enum-value", "name": "WalkBack", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterActionAnim", "signature": "CritterActionAnim.WalkBack = 15", "description": "Requests backward walking", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1012 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterActionAnim", "value": "15", "evaluated_value": 15, "generated": false }, { "id": "script.enum-value.CritterCondition.Alive", "family_id": "script.enum-value.CritterCondition.Alive", "kind": "enum-value", "name": "Alive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterCondition", "signature": "CritterCondition.Alive = 0", "description": "Critter is alive and may perform normal gameplay actions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 974 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterCondition", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterCondition.Dead", "family_id": "script.enum-value.CritterCondition.Dead", "kind": "enum-value", "name": "Dead", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterCondition", "signature": "CritterCondition.Dead = 2", "description": "Critter is dead and uses death-state handling and animation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 976 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterCondition", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.CritterCondition.Knockout", "family_id": "script.enum-value.CritterCondition.Knockout", "kind": "enum-value", "name": "Knockout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterCondition", "signature": "CritterCondition.Knockout = 1", "description": "Critter is alive but incapacitated until it stands up or changes condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 975 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterCondition", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterFindType.Any", "family_id": "script.enum-value.CritterFindType.Any", "kind": "enum-value", "name": "Any", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.Any = 0", "description": "Selects critters without filtering life state or player ownership", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1046 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterFindType.Dead", "family_id": "script.enum-value.CritterFindType.Dead", "kind": "enum-value", "name": "Dead", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.Dead = 0x02", "description": "Selects dead critters regardless of player ownership", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1048 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x02", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.CritterFindType.DeadNpc", "family_id": "script.enum-value.CritterFindType.DeadNpc", "kind": "enum-value", "name": "DeadNpc", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.DeadNpc = 0x22", "description": "Selects dead non-player critters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1054 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x22", "evaluated_value": 34, "generated": false }, { "id": "script.enum-value.CritterFindType.DeadPlayers", "family_id": "script.enum-value.CritterFindType.DeadPlayers", "kind": "enum-value", "name": "DeadPlayers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.DeadPlayers = 0x12", "description": "Selects dead player-controlled critters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1052 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x12", "evaluated_value": 18, "generated": false }, { "id": "script.enum-value.CritterFindType.NonDead", "family_id": "script.enum-value.CritterFindType.NonDead", "kind": "enum-value", "name": "NonDead", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.NonDead = 0x01", "description": "Selects alive and knocked-out critters while excluding dead critters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1047 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x01", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterFindType.NonDeadNpc", "family_id": "script.enum-value.CritterFindType.NonDeadNpc", "kind": "enum-value", "name": "NonDeadNpc", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.NonDeadNpc = 0x21", "description": "Selects non-player critters that are not dead", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1053 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x21", "evaluated_value": 33, "generated": false }, { "id": "script.enum-value.CritterFindType.NonDeadPlayers", "family_id": "script.enum-value.CritterFindType.NonDeadPlayers", "kind": "enum-value", "name": "NonDeadPlayers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.NonDeadPlayers = 0x11", "description": "Selects player-controlled critters that are not dead", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1051 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x11", "evaluated_value": 17, "generated": false }, { "id": "script.enum-value.CritterFindType.Npc", "family_id": "script.enum-value.CritterFindType.Npc", "kind": "enum-value", "name": "Npc", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.Npc = 0x20", "description": "Selects non-player critters regardless of life state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1050 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x20", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.CritterFindType.Players", "family_id": "script.enum-value.CritterFindType.Players", "kind": "enum-value", "name": "Players", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterFindType", "signature": "CritterFindType.Players = 0x10", "description": "Selects player-controlled critters regardless of life state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1049 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterFindType", "value": "0x10", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.CritterItemSlot.Inventory", "family_id": "script.enum-value.CritterItemSlot.Inventory", "kind": "enum-value", "name": "Inventory", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterItemSlot", "signature": "CritterItemSlot.Inventory = 0", "description": "Places the item in the critter's unequipped inventory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 965 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterItemSlot", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterItemSlot.Main", "family_id": "script.enum-value.CritterItemSlot.Main", "kind": "enum-value", "name": "Main", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterItemSlot", "signature": "CritterItemSlot.Main = 1", "description": "Places the item in the critter's main equipped slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 966 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterItemSlot", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterItemSlot.Outside", "family_id": "script.enum-value.CritterItemSlot.Outside", "kind": "enum-value", "name": "Outside", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterItemSlot", "signature": "CritterItemSlot.Outside = 255", "description": "Marks the item as outside the critter's owned inventory slots", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 967 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterItemSlot", "value": "255", "evaluated_value": 255, "generated": false }, { "id": "script.enum-value.CritterProperty.AttachMaster", "family_id": "script.enum-value.CritterProperty.AttachMaster", "kind": "enum-value", "name": "AttachMaster", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.AttachMaster = 23", "description": "Identifier of the attachment master; zero when the critter is not attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 363 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "23", "evaluated_value": 23, "generated": true }, { "id": "script.enum-value.CritterProperty.Condition", "family_id": "script.enum-value.CritterProperty.Condition", "kind": "enum-value", "name": "Condition", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.Condition = 27", "description": "Current life-state condition used by animation, filtering, and gameplay queries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 377 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "27", "evaluated_value": 27, "generated": true }, { "id": "script.enum-value.CritterProperty.ControlledByPlayer", "family_id": "script.enum-value.CritterProperty.ControlledByPlayer", "kind": "enum-value", "name": "ControlledByPlayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ControlledByPlayer = 19", "description": "Classifies the critter as player-controllable independently of its current online state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 351 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "19", "evaluated_value": 19, "generated": true }, { "id": "script.enum-value.CritterProperty.CustomHolderEntry", "family_id": "script.enum-value.CritterProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.CritterProperty.CustomHolderId", "family_id": "script.enum-value.CritterProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.CritterProperty.DeadDrawNoFlatten", "family_id": "script.enum-value.CritterProperty.DeadDrawNoFlatten", "kind": "enum-value", "name": "DeadDrawNoFlatten", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.DeadDrawNoFlatten = 30", "description": "Keeps a dead critter in the normal critter draw order instead of the flattened dead-critter order", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 388 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "30", "evaluated_value": 30, "generated": true }, { "id": "script.enum-value.CritterProperty.Dir", "family_id": "script.enum-value.CritterProperty.Dir", "kind": "enum-value", "name": "Dir", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.Dir = 10", "description": "Current facing direction on the map grid", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 322 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "10", "evaluated_value": 10, "generated": true }, { "id": "script.enum-value.CritterProperty.Elevation", "family_id": "script.enum-value.CritterProperty.Elevation", "kind": "enum-value", "name": "Elevation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.Elevation = 9", "description": "Vertical rendering elevation of the critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 319 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "9", "evaluated_value": 9, "generated": true }, { "id": "script.enum-value.CritterProperty.ExplicitlyPersistent", "family_id": "script.enum-value.CritterProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.CritterProperty.GlobalMapTripId", "family_id": "script.enum-value.CritterProperty.GlobalMapTripId", "kind": "enum-value", "name": "GlobalMapTripId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.GlobalMapTripId = 6", "description": "Server-assigned identifier shared by members of the same current global-map trip", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 310 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "6", "evaluated_value": 6, "generated": true }, { "id": "script.enum-value.CritterProperty.Hex", "family_id": "script.enum-value.CritterProperty.Hex", "kind": "enum-value", "name": "Hex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.Hex = 7", "description": "Origin hex currently occupied by the critter on its map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 313 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "7", "evaluated_value": 7, "generated": true }, { "id": "script.enum-value.CritterProperty.HexOffset", "family_id": "script.enum-value.CritterProperty.HexOffset", "kind": "enum-value", "name": "HexOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.HexOffset = 8", "description": "Sub-hex map-space offset used by movement interpolation and rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 316 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "8", "evaluated_value": 8, "generated": true }, { "id": "script.enum-value.CritterProperty.HideSprite", "family_id": "script.enum-value.CritterProperty.HideSprite", "kind": "enum-value", "name": "HideSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.HideSprite = 24", "description": "Hides the current client map sprite without removing the critter's map presence", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 366 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "24", "evaluated_value": 24, "generated": true }, { "id": "script.enum-value.CritterProperty.InitScript", "family_id": "script.enum-value.CritterProperty.InitScript", "kind": "enum-value", "name": "InitScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.InitScript = 4", "description": "Server initialization function called after the critter-init event for a newly created or restored critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 304 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "4", "evaluated_value": 4, "generated": true }, { "id": "script.enum-value.CritterProperty.IsAttached", "family_id": "script.enum-value.CritterProperty.IsAttached", "kind": "enum-value", "name": "IsAttached", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.IsAttached = 22", "description": "Reports that this critter currently follows another critter as an attachment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 360 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "22", "evaluated_value": 22, "generated": true }, { "id": "script.enum-value.CritterProperty.IsChosen", "family_id": "script.enum-value.CritterProperty.IsChosen", "kind": "enum-value", "name": "IsChosen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.IsChosen = 20", "description": "Reports that this critter is the locally chosen critter on the current client", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 354 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "20", "evaluated_value": 20, "generated": true }, { "id": "script.enum-value.CritterProperty.IsPlayerOffline", "family_id": "script.enum-value.CritterProperty.IsPlayerOffline", "kind": "enum-value", "name": "IsPlayerOffline", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.IsPlayerOffline = 21", "description": "Client-side connection state reported for a player-controlled critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 357 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "21", "evaluated_value": 21, "generated": true }, { "id": "script.enum-value.CritterProperty.ItemIds", "family_id": "script.enum-value.CritterProperty.ItemIds", "kind": "enum-value", "name": "ItemIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ItemIds = 11", "description": "Persistent identifiers of the items directly held in the critter's inventory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "11", "evaluated_value": 11, "generated": true }, { "id": "script.enum-value.CritterProperty.LightColor", "family_id": "script.enum-value.CritterProperty.LightColor", "kind": "enum-value", "name": "LightColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.LightColor = 35", "description": "RGBA color emitted by the critter's client-side light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 403 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "35", "evaluated_value": 35, "generated": true }, { "id": "script.enum-value.CritterProperty.LightDistance", "family_id": "script.enum-value.CritterProperty.LightDistance", "kind": "enum-value", "name": "LightDistance", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.LightDistance = 33", "description": "Radius in hexes reached by the critter's client-side light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 397 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "33", "evaluated_value": 33, "generated": true }, { "id": "script.enum-value.CritterProperty.LightFlags", "family_id": "script.enum-value.CritterProperty.LightFlags", "kind": "enum-value", "name": "LightFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.LightFlags = 34", "description": "Bit mask controlling global, inverse, and direction-blocking behavior of the light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 400 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "34", "evaluated_value": 34, "generated": true }, { "id": "script.enum-value.CritterProperty.LightIntensity", "family_id": "script.enum-value.CritterProperty.LightIntensity", "kind": "enum-value", "name": "LightIntensity", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.LightIntensity = 32", "description": "Signed percentage intensity of the critter's client-side light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 394 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "32", "evaluated_value": 32, "generated": true }, { "id": "script.enum-value.CritterProperty.LightSource", "family_id": "script.enum-value.CritterProperty.LightSource", "kind": "enum-value", "name": "LightSource", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.LightSource = 31", "description": "Enables a client-side map light source centered on this critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 391 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "31", "evaluated_value": 31, "generated": true }, { "id": "script.enum-value.CritterProperty.LookDistance", "family_id": "script.enum-value.CritterProperty.LookDistance", "kind": "enum-value", "name": "LookDistance", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.LookDistance = 29", "description": "Maximum map-view distance in hexes used by server visibility processing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 383 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "29", "evaluated_value": 29, "generated": true }, { "id": "script.enum-value.CritterProperty.MapId", "family_id": "script.enum-value.CritterProperty.MapId", "kind": "enum-value", "name": "MapId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.MapId = 5", "description": "Identifier of the map currently containing the critter; zero while it is on the global map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 307 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "5", "evaluated_value": 5, "generated": true }, { "id": "script.enum-value.CritterProperty.ModelLayers", "family_id": "script.enum-value.CritterProperty.ModelLayers", "kind": "enum-value", "name": "ModelLayers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ModelLayers = 18", "description": "Fixed-size client values passed to the 3D model layer and animation resolver", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "18", "evaluated_value": 18, "generated": true }, { "id": "script.enum-value.CritterProperty.ModelName", "family_id": "script.enum-value.CritterProperty.ModelName", "kind": "enum-value", "name": "ModelName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ModelName = 12", "description": "Sprite or 3D model resource used to present the critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 328 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "12", "evaluated_value": 12, "generated": true }, { "id": "script.enum-value.CritterProperty.MovingSpeed", "family_id": "script.enum-value.CritterProperty.MovingSpeed", "kind": "enum-value", "name": "MovingSpeed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.MovingSpeed = 25", "description": "Current server movement speed published for active movement", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 369 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "25", "evaluated_value": 25, "generated": true }, { "id": "script.enum-value.CritterProperty.Multihex", "family_id": "script.enum-value.CritterProperty.Multihex", "kind": "enum-value", "name": "Multihex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.Multihex = 13", "description": "Radius in hexes occupied by the critter in movement, pathfinding, and distance checks", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 331 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "13", "evaluated_value": 13, "generated": true }, { "id": "script.enum-value.CritterProperty.NameOffset", "family_id": "script.enum-value.CritterProperty.NameOffset", "kind": "enum-value", "name": "NameOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.NameOffset = 28", "description": "Vertical pixel adjustment applied to the critter name label", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 380 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "28", "evaluated_value": 28, "generated": true }, { "id": "script.enum-value.CritterProperty.None", "family_id": "script.enum-value.CritterProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.None = 0", "description": "Sentinel indicating that no Critter property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.CritterProperty.ScaleFactor", "family_id": "script.enum-value.CritterProperty.ScaleFactor", "kind": "enum-value", "name": "ScaleFactor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ScaleFactor = 14", "description": "3D model scale in thousandths; zero selects the default scale of 1000", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 334 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "14", "evaluated_value": 14, "generated": true }, { "id": "script.enum-value.CritterProperty.ShowCritterDist1", "family_id": "script.enum-value.CritterProperty.ShowCritterDist1", "kind": "enum-value", "name": "ShowCritterDist1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ShowCritterDist1 = 15", "description": "Optional first visibility-event distance in hexes; zero disables this distance group", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "15", "evaluated_value": 15, "generated": true }, { "id": "script.enum-value.CritterProperty.ShowCritterDist2", "family_id": "script.enum-value.CritterProperty.ShowCritterDist2", "kind": "enum-value", "name": "ShowCritterDist2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ShowCritterDist2 = 16", "description": "Optional second visibility-event distance in hexes; zero disables this distance group", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 340 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "16", "evaluated_value": 16, "generated": true }, { "id": "script.enum-value.CritterProperty.ShowCritterDist3", "family_id": "script.enum-value.CritterProperty.ShowCritterDist3", "kind": "enum-value", "name": "ShowCritterDist3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.ShowCritterDist3 = 17", "description": "Optional third visibility-event distance in hexes; zero disables this distance group", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 343 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "17", "evaluated_value": 17, "generated": true }, { "id": "script.enum-value.CritterProperty.VisibilityMode", "family_id": "script.enum-value.CritterProperty.VisibilityMode", "kind": "enum-value", "name": "VisibilityMode", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterProperty", "signature": "CritterProperty.VisibilityMode = 26", "description": "Visibility detail mode assigned to this critter from the current client's viewpoint", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 372 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterProperty", "value": "26", "evaluated_value": 26, "generated": true }, { "id": "script.enum-value.CritterSeeType.Any", "family_id": "script.enum-value.CritterSeeType.Any", "kind": "enum-value", "name": "Any", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterSeeType", "signature": "CritterSeeType.Any = 0", "description": "Returns the union of incoming and outgoing critter visibility relations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1029 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterSeeType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterSeeType.WhoISee", "family_id": "script.enum-value.CritterSeeType.WhoISee", "kind": "enum-value", "name": "WhoISee", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterSeeType", "signature": "CritterSeeType.WhoISee = 2", "description": "Selects critters currently visible to this critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1031 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterSeeType", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.CritterSeeType.WhoSeeMe", "family_id": "script.enum-value.CritterSeeType.WhoSeeMe", "kind": "enum-value", "name": "WhoSeeMe", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterSeeType", "signature": "CritterSeeType.WhoSeeMe = 1", "description": "Selects critters whose visibility relation currently includes this critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1030 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterSeeType", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterStateAnim.None", "family_id": "script.enum-value.CritterStateAnim.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterStateAnim", "signature": "CritterStateAnim.None = 0", "description": "No persistent critter animation posture is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1001 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterStateAnim", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.CritterStateAnim.Unarmed", "family_id": "script.enum-value.CritterStateAnim.Unarmed", "kind": "enum-value", "name": "Unarmed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterStateAnim", "signature": "CritterStateAnim.Unarmed = 1", "description": "Selects the unarmed persistent animation posture", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1002 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterStateAnim", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterVisibilityMode.Full", "family_id": "script.enum-value.CritterVisibilityMode.Full", "kind": "enum-value", "name": "Full", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterVisibilityMode", "signature": "CritterVisibilityMode.Full = 1", "description": "Forces the target into full visibility for the selected relation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1039 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterVisibilityMode", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.CritterVisibilityMode.None", "family_id": "script.enum-value.CritterVisibilityMode.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "CritterVisibilityMode", "signature": "CritterVisibilityMode.None = 0", "description": "Applies no full-visibility override and uses normal perception rules", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1038 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.CritterVisibilityMode", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.DisconnectReason.ClientClosed", "family_id": "script.enum-value.DisconnectReason.ClientClosed", "kind": "enum-value", "name": "ClientClosed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.ClientClosed = 1", "description": "Indicates that the transport reported the peer disappearing; voluntary quit and network loss are indistinguishable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.DisconnectReason.InactivityTimeout", "family_id": "script.enum-value.DisconnectReason.InactivityTimeout", "kind": "enum-value", "name": "InactivityTimeout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.InactivityTimeout = 2", "description": "Indicates that no inbound message arrived before the configured inactivity deadline", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.DisconnectReason.LoginFailed", "family_id": "script.enum-value.DisconnectReason.LoginFailed", "kind": "enum-value", "name": "LoginFailed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.LoginFailed = 9", "description": "Indicates that login was rolled back after a server-side failure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "9", "evaluated_value": 9, "generated": false }, { "id": "script.enum-value.DisconnectReason.LoginTimeout", "family_id": "script.enum-value.DisconnectReason.LoginTimeout", "kind": "enum-value", "name": "LoginTimeout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.LoginTimeout = 4", "description": "Indicates that a pre-login connection made no progress before the configured login deadline", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 53 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.DisconnectReason.None", "family_id": "script.enum-value.DisconnectReason.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.None = 0", "description": "Indicates that the connection has not recorded a close cause", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 49 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.DisconnectReason.PingTimeout", "family_id": "script.enum-value.DisconnectReason.PingTimeout", "kind": "enum-value", "name": "PingTimeout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.PingTimeout = 3", "description": "Indicates that the peer did not answer the previous server ping", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 52 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.DisconnectReason.ProtocolError", "family_id": "script.enum-value.DisconnectReason.ProtocolError", "kind": "enum-value", "name": "ProtocolError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.ProtocolError = 5", "description": "Indicates malformed or unexpected protocol data or failed connection publication", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.DisconnectReason.ReplacedByReconnect", "family_id": "script.enum-value.DisconnectReason.ReplacedByReconnect", "kind": "enum-value", "name": "ReplacedByReconnect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.ReplacedByReconnect = 10", "description": "Indicates that a new login for the same account replaced this session", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "10", "evaluated_value": 10, "generated": false }, { "id": "script.enum-value.DisconnectReason.ScriptRequest", "family_id": "script.enum-value.DisconnectReason.ScriptRequest", "kind": "enum-value", "name": "ScriptRequest", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.ScriptRequest = 8", "description": "Indicates that server script called Player.HardDisconnect()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.DisconnectReason.ServerShutdown", "family_id": "script.enum-value.DisconnectReason.ServerShutdown", "kind": "enum-value", "name": "ServerShutdown", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.ServerShutdown = 7", "description": "Indicates an orderly server shutdown", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "7", "evaluated_value": 7, "generated": false }, { "id": "script.enum-value.DisconnectReason.UpdaterError", "family_id": "script.enum-value.DisconnectReason.UpdaterError", "kind": "enum-value", "name": "UpdaterError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DisconnectReason", "signature": "DisconnectReason.UpdaterError = 6", "description": "Indicates that the client requested an invalid updater file or range", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DisconnectReason", "value": "6", "evaluated_value": 6, "generated": false }, { "id": "script.enum-value.DrawOrderType.AfterLight", "family_id": "script.enum-value.DrawOrderType.AfterLight", "kind": "enum-value", "name": "AfterLight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.AfterLight = 11", "description": "Primitive layer rendered immediately after map light accumulation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 64 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "11", "evaluated_value": 11, "generated": false }, { "id": "script.enum-value.DrawOrderType.Critter", "family_id": "script.enum-value.DrawOrderType.Critter", "kind": "enum-value", "name": "Critter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Critter = 25", "description": "Depth-sorted critter layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 72 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "25", "evaluated_value": 25, "generated": false }, { "id": "script.enum-value.DrawOrderType.DeadCritter", "family_id": "script.enum-value.DrawOrderType.DeadCritter", "kind": "enum-value", "name": "DeadCritter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.DeadCritter = 13", "description": "Flat dead-critter layer rendered after lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "13", "evaluated_value": 13, "generated": false }, { "id": "script.enum-value.DrawOrderType.FlatEnd", "family_id": "script.enum-value.DrawOrderType.FlatEnd", "kind": "enum-value", "name": "FlatEnd", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.FlatEnd = 18", "description": "Upper ordering boundary for flat post-light sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "18", "evaluated_value": 18, "generated": false }, { "id": "script.enum-value.DrawOrderType.FlatItemAfterLight", "family_id": "script.enum-value.DrawOrderType.FlatItemAfterLight", "kind": "enum-value", "name": "FlatItemAfterLight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.FlatItemAfterLight = 16", "description": "Flat item layer rendered after map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 67 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.DrawOrderType.FlatItemPreLight", "family_id": "script.enum-value.DrawOrderType.FlatItemPreLight", "kind": "enum-value", "name": "FlatItemPreLight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.FlatItemPreLight = 6", "description": "Flat item layer rendered before map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "6", "evaluated_value": 6, "generated": false }, { "id": "script.enum-value.DrawOrderType.HexGrid", "family_id": "script.enum-value.DrawOrderType.HexGrid", "kind": "enum-value", "name": "HexGrid", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.HexGrid = 8", "description": "Hex-grid overlay layer rendered before lighting primitives", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.DrawOrderType.Item", "family_id": "script.enum-value.DrawOrderType.Item", "kind": "enum-value", "name": "Item", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Item = 22", "description": "Depth-sorted normal item layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 71 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "22", "evaluated_value": 22, "generated": false }, { "id": "script.enum-value.DrawOrderType.Last", "family_id": "script.enum-value.DrawOrderType.Last", "kind": "enum-value", "name": "Last", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Last = 39", "description": "Highest valid draw-order marker reserved by the map-sprite sorter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 83 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "39", "evaluated_value": 39, "generated": false }, { "id": "script.enum-value.DrawOrderType.Light", "family_id": "script.enum-value.DrawOrderType.Light", "kind": "enum-value", "name": "Light", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Light = 10", "description": "Map light accumulation layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 63 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "10", "evaluated_value": 10, "generated": false }, { "id": "script.enum-value.DrawOrderType.NormalBegin", "family_id": "script.enum-value.DrawOrderType.NormalBegin", "kind": "enum-value", "name": "NormalBegin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.NormalBegin = 19", "description": "Lower ordering boundary for depth-sorted normal sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 70 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "19", "evaluated_value": 19, "generated": false }, { "id": "script.enum-value.DrawOrderType.NormalEnd", "family_id": "script.enum-value.DrawOrderType.NormalEnd", "kind": "enum-value", "name": "NormalEnd", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.NormalEnd = 31", "description": "Upper ordering boundary for depth-sorted normal sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 74 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "31", "evaluated_value": 31, "generated": false }, { "id": "script.enum-value.DrawOrderType.Particles", "family_id": "script.enum-value.DrawOrderType.Particles", "kind": "enum-value", "name": "Particles", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Particles = 28", "description": "Depth-sorted map-particle layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 73 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "28", "evaluated_value": 28, "generated": false }, { "id": "script.enum-value.DrawOrderType.PreLight", "family_id": "script.enum-value.DrawOrderType.PreLight", "kind": "enum-value", "name": "PreLight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.PreLight = 9", "description": "Primitive layer rendered immediately before map light accumulation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "9", "evaluated_value": 9, "generated": false }, { "id": "script.enum-value.DrawOrderType.Roof", "family_id": "script.enum-value.DrawOrderType.Roof", "kind": "enum-value", "name": "Roof", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Roof = 33", "description": "Base roof-sprite layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "33", "evaluated_value": 33, "generated": false }, { "id": "script.enum-value.DrawOrderType.Roof1", "family_id": "script.enum-value.DrawOrderType.Roof1", "kind": "enum-value", "name": "Roof1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Roof1 = 34", "description": "First additional roof-sprite layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "34", "evaluated_value": 34, "generated": false }, { "id": "script.enum-value.DrawOrderType.Roof2", "family_id": "script.enum-value.DrawOrderType.Roof2", "kind": "enum-value", "name": "Roof2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Roof2 = 35", "description": "Second additional roof-sprite layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 78 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "35", "evaluated_value": 35, "generated": false }, { "id": "script.enum-value.DrawOrderType.Roof3", "family_id": "script.enum-value.DrawOrderType.Roof3", "kind": "enum-value", "name": "Roof3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Roof3 = 36", "description": "Third additional roof-sprite layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 79 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "36", "evaluated_value": 36, "generated": false }, { "id": "script.enum-value.DrawOrderType.Roof4", "family_id": "script.enum-value.DrawOrderType.Roof4", "kind": "enum-value", "name": "Roof4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Roof4 = 37", "description": "Fourth additional roof-sprite layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 80 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "37", "evaluated_value": 37, "generated": false }, { "id": "script.enum-value.DrawOrderType.RoofParticles", "family_id": "script.enum-value.DrawOrderType.RoofParticles", "kind": "enum-value", "name": "RoofParticles", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.RoofParticles = 38", "description": "Particle layer rendered with roof sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 81 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "38", "evaluated_value": 38, "generated": false }, { "id": "script.enum-value.DrawOrderType.Tile", "family_id": "script.enum-value.DrawOrderType.Tile", "kind": "enum-value", "name": "Tile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Tile = 0", "description": "Base flat tile layer rendered before map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.DrawOrderType.Tile1", "family_id": "script.enum-value.DrawOrderType.Tile1", "kind": "enum-value", "name": "Tile1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Tile1 = 1", "description": "First additional flat tile layer rendered before map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.DrawOrderType.Tile2", "family_id": "script.enum-value.DrawOrderType.Tile2", "kind": "enum-value", "name": "Tile2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Tile2 = 2", "description": "Second additional flat tile layer rendered before map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.DrawOrderType.Tile3", "family_id": "script.enum-value.DrawOrderType.Tile3", "kind": "enum-value", "name": "Tile3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Tile3 = 3", "description": "Third additional flat tile layer rendered before map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.DrawOrderType.Tile4", "family_id": "script.enum-value.DrawOrderType.Tile4", "kind": "enum-value", "name": "Tile4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "DrawOrderType", "signature": "DrawOrderType.Tile4 = 4", "description": "Fourth additional flat tile layer rendered before map lighting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.DrawOrderType", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.EffectType.CritterSprite", "family_id": "script.enum-value.EffectType.CritterSprite", "kind": "enum-value", "name": "CritterSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.CritterSprite = 0x00000002", "description": "Replaces the default critter-sprite effect or one map critter's draw effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00000002", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.EffectType.FlushFog", "family_id": "script.enum-value.EffectType.FlushFog", "kind": "enum-value", "name": "FlushFog", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.FlushFog = 0x20000000", "description": "Replaces the effect used to composite the fog buffer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x20000000", "evaluated_value": 536870912, "generated": false }, { "id": "script.enum-value.EffectType.FlushLight", "family_id": "script.enum-value.EffectType.FlushLight", "kind": "enum-value", "name": "FlushLight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.FlushLight = 0x10000000", "description": "Replaces the effect used to composite the light buffer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x10000000", "evaluated_value": 268435456, "generated": false }, { "id": "script.enum-value.EffectType.FlushMap", "family_id": "script.enum-value.EffectType.FlushMap", "kind": "enum-value", "name": "FlushMap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.FlushMap = 0x08000000", "description": "Replaces the effect used to composite the rendered map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 67 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x08000000", "evaluated_value": 134217728, "generated": false }, { "id": "script.enum-value.EffectType.FlushPrimitive", "family_id": "script.enum-value.EffectType.FlushPrimitive", "kind": "enum-value", "name": "FlushPrimitive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.FlushPrimitive = 0x04000000", "description": "Replaces the effect used to flush primitive rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x04000000", "evaluated_value": 67108864, "generated": false }, { "id": "script.enum-value.EffectType.FlushRenderTarget", "family_id": "script.enum-value.EffectType.FlushRenderTarget", "kind": "enum-value", "name": "FlushRenderTarget", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.FlushRenderTarget = 0x01000000", "description": "Replaces the effect used to flush a render-target texture", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 65 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x01000000", "evaluated_value": 16777216, "generated": false }, { "id": "script.enum-value.EffectType.Fog", "family_id": "script.enum-value.EffectType.Fog", "kind": "enum-value", "name": "Fog", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.Fog = 0x00400000", "description": "Replaces the primitive effect used for map fog rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 64 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00400000", "evaluated_value": 4194304, "generated": false }, { "id": "script.enum-value.EffectType.Font", "family_id": "script.enum-value.EffectType.Font", "kind": "enum-value", "name": "Font", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.Font = 0x00010000", "description": "Replaces the default font effect or the effect of one font slot selected by subtype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00010000", "evaluated_value": 65536, "generated": false }, { "id": "script.enum-value.EffectType.GenericSprite", "family_id": "script.enum-value.EffectType.GenericSprite", "kind": "enum-value", "name": "GenericSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.GenericSprite = 0x00000001", "description": "Replaces the default generic-sprite effect or one map item's draw effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00000001", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.EffectType.Interface", "family_id": "script.enum-value.EffectType.Interface", "kind": "enum-value", "name": "Interface", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.Interface = 0x00001000", "description": "Replaces the default interface-sprite effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00001000", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.EffectType.Light", "family_id": "script.enum-value.EffectType.Light", "kind": "enum-value", "name": "Light", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.Light = 0x00200000", "description": "Replaces the primitive effect used for map light accumulation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 63 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00200000", "evaluated_value": 2097152, "generated": false }, { "id": "script.enum-value.EffectType.None", "family_id": "script.enum-value.EffectType.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.None = 0", "description": "Selects no effect category", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 53 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.EffectType.Offscreen", "family_id": "script.enum-value.EffectType.Offscreen", "kind": "enum-value", "name": "Offscreen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.Offscreen = 0x40000000", "description": "Registers the effect in an indexed offscreen-effect subtype slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 70 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x40000000", "evaluated_value": 1073741824, "generated": false }, { "id": "script.enum-value.EffectType.Primitive", "family_id": "script.enum-value.EffectType.Primitive", "kind": "enum-value", "name": "Primitive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.Primitive = 0x00100000", "description": "Replaces the default generic primitive effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00100000", "evaluated_value": 1048576, "generated": false }, { "id": "script.enum-value.EffectType.RainSprite", "family_id": "script.enum-value.EffectType.RainSprite", "kind": "enum-value", "name": "RainSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.RainSprite = 0x00000010", "description": "Replaces the default rain-sprite effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00000010", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.EffectType.RoofSprite", "family_id": "script.enum-value.EffectType.RoofSprite", "kind": "enum-value", "name": "RoofSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.RoofSprite = 0x00000008", "description": "Replaces the default roof-sprite effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00000008", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.EffectType.SkinnedMesh", "family_id": "script.enum-value.EffectType.SkinnedMesh", "kind": "enum-value", "name": "SkinnedMesh", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.SkinnedMesh = 0x00000400", "description": "Replaces the default skinned-model effect when 3D rendering is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00000400", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.EffectType.TileSprite", "family_id": "script.enum-value.EffectType.TileSprite", "kind": "enum-value", "name": "TileSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EffectType", "signature": "EffectType.TileSprite = 0x00000004", "description": "Replaces the default flat tile-sprite effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EffectType", "value": "0x00000004", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.EggAppearenceType.Always", "family_id": "script.enum-value.EggAppearenceType.Always", "kind": "enum-value", "name": "Always", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EggAppearenceType", "signature": "EggAppearenceType.Always = 1", "description": "Applies a valid transparency-egg mask regardless of relative map hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 91 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EggAppearenceType", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.EggAppearenceType.ByX", "family_id": "script.enum-value.EggAppearenceType.ByX", "kind": "enum-value", "name": "ByX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EggAppearenceType", "signature": "EggAppearenceType.ByX = 2", "description": "Applies the mask when the sprite hex X is at or beyond the egg hex X", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EggAppearenceType", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.EggAppearenceType.ByXAndY", "family_id": "script.enum-value.EggAppearenceType.ByXAndY", "kind": "enum-value", "name": "ByXAndY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EggAppearenceType", "signature": "EggAppearenceType.ByXAndY = 4", "description": "Applies the mask when either adjusted X or Y is at or beyond the corresponding egg coordinate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 94 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EggAppearenceType", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.EggAppearenceType.ByXOrY", "family_id": "script.enum-value.EggAppearenceType.ByXOrY", "kind": "enum-value", "name": "ByXOrY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EggAppearenceType", "signature": "EggAppearenceType.ByXOrY = 5", "description": "Applies the mask only when both adjusted X and Y are at or beyond the corresponding egg coordinates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 95 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EggAppearenceType", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.EggAppearenceType.ByY", "family_id": "script.enum-value.EggAppearenceType.ByY", "kind": "enum-value", "name": "ByY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EggAppearenceType", "signature": "EggAppearenceType.ByY = 3", "description": "Applies the mask when the sprite hex Y is at or beyond the egg hex Y", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EggAppearenceType", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.EggAppearenceType.None", "family_id": "script.enum-value.EggAppearenceType.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EggAppearenceType", "signature": "EggAppearenceType.None = 0", "description": "Never applies a transparency-egg mask to this sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 90 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EggAppearenceType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.KickedFromGame", "family_id": "script.enum-value.EngineInfoMessage.KickedFromGame", "kind": "enum-value", "name": "KickedFromGame", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.KickedFromGame = 5000", "description": "Identifies forced removal of the player from the active game session", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 453 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "5000", "evaluated_value": 5000, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetBan", "family_id": "script.enum-value.EngineInfoMessage.NetBan", "kind": "enum-value", "name": "NetBan", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetBan = 1046", "description": "Identifies the primary notification that the player or account has been banned", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 448 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1046", "evaluated_value": 1046, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetBanReason", "family_id": "script.enum-value.EngineInfoMessage.NetBanReason", "kind": "enum-value", "name": "NetBanReason", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetBanReason = 1047", "description": "Identifies detailed ban metadata such as issuer, duration, and reason supplied by the project", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 449 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1047", "evaluated_value": 1047, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetBanned", "family_id": "script.enum-value.EngineInfoMessage.NetBanned", "kind": "enum-value", "name": "NetBanned", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetBanned = 1034", "description": "Identifies an account that is blocked from logging in", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 439 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1034", "evaluated_value": 1034, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetBannedIp", "family_id": "script.enum-value.EngineInfoMessage.NetBannedIp", "kind": "enum-value", "name": "NetBannedIp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetBannedIp = 1043", "description": "Identifies a connection rejected because its source IP address is blocked", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 446 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1043", "evaluated_value": 1043, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetBdError", "family_id": "script.enum-value.EngineInfoMessage.NetBdError", "kind": "enum-value", "name": "NetBdError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetBdError = 1023", "description": "Identifies a backend database failure while processing the requested account or game operation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 428 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1023", "evaluated_value": 1023, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetBeginEndSpaces", "family_id": "script.enum-value.EngineInfoMessage.NetBeginEndSpaces", "kind": "enum-value", "name": "NetBeginEndSpaces", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetBeginEndSpaces = 1032", "description": "Identifies a name rejected because it begins or ends with whitespace", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 437 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1032", "evaluated_value": 1032, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetConnError", "family_id": "script.enum-value.EngineInfoMessage.NetConnError", "kind": "enum-value", "name": "NetConnError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetConnError = 1008", "description": "Identifies a generic connection error after a connection attempt or active session failure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 420 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1008", "evaluated_value": 1008, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetConnFail", "family_id": "script.enum-value.EngineInfoMessage.NetConnFail", "kind": "enum-value", "name": "NetConnFail", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetConnFail = 1018", "description": "Identifies failure to establish a connection to the game server", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 424 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1018", "evaluated_value": 1018, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetConnSuccess", "family_id": "script.enum-value.EngineInfoMessage.NetConnSuccess", "kind": "enum-value", "name": "NetConnSuccess", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetConnSuccess = 1010", "description": "Identifies successful transport connection before or during authentication", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 421 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1010", "evaluated_value": 1010, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetConnection", "family_id": "script.enum-value.EngineInfoMessage.NetConnection", "kind": "enum-value", "name": "NetConnection", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetConnection = 1007", "description": "Identifies the client status while it is initiating a server connection", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 419 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1007", "evaluated_value": 1007, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetDataTransErr", "family_id": "script.enum-value.EngineInfoMessage.NetDataTransErr", "kind": "enum-value", "name": "NetDataTransErr", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetDataTransErr = 1025", "description": "Identifies an error while transferring or decoding connection data", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 430 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1025", "evaluated_value": 1025, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetDifferentLang", "family_id": "script.enum-value.EngineInfoMessage.NetDifferentLang", "kind": "enum-value", "name": "NetDifferentLang", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetDifferentLang = 1030", "description": "Identifies a name rejected for mixing characters from different language alphabets", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 435 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1030", "evaluated_value": 1030, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetDisconnByDemand", "family_id": "script.enum-value.EngineInfoMessage.NetDisconnByDemand", "kind": "enum-value", "name": "NetDisconnByDemand", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetDisconnByDemand = 1013", "description": "Identifies a disconnect requested explicitly by the player or client", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1013", "evaluated_value": 1013, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetFailRunStartScript", "family_id": "script.enum-value.EngineInfoMessage.NetFailRunStartScript", "kind": "enum-value", "name": "NetFailRunStartScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetFailRunStartScript = 1038", "description": "Identifies client startup failure while executing the project's start script", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 443 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1038", "evaluated_value": 1038, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetFailToLoadIface", "family_id": "script.enum-value.EngineInfoMessage.NetFailToLoadIface", "kind": "enum-value", "name": "NetFailToLoadIface", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetFailToLoadIface = 1037", "description": "Identifies client startup failure while loading the user interface", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 442 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1037", "evaluated_value": 1037, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetHexesBusy", "family_id": "script.enum-value.EngineInfoMessage.NetHexesBusy", "kind": "enum-value", "name": "NetHexesBusy", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetHexesBusy = 1012", "description": "Identifies entry or spawning rejected because the required destination hexes are occupied", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 422 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1012", "evaluated_value": 1012, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetKnockKnock", "family_id": "script.enum-value.EngineInfoMessage.NetKnockKnock", "kind": "enum-value", "name": "NetKnockKnock", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetKnockKnock = 1041", "description": "Reserves the legacy knock-knock informational slot; embedding scripts define its concrete liveness or status use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 445 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1041", "evaluated_value": 1041, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetLanguageNotSupported", "family_id": "script.enum-value.EngineInfoMessage.NetLanguageNotSupported", "kind": "enum-value", "name": "NetLanguageNotSupported", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetLanguageNotSupported = 1039", "description": "Identifies an unsupported selected language and the need to use a project-defined fallback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 444 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1039", "evaluated_value": 1039, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetLoginOk", "family_id": "script.enum-value.EngineInfoMessage.NetLoginOk", "kind": "enum-value", "name": "NetLoginOk", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetLoginOk = 1028", "description": "Identifies successful authentication and transition to game-state or map loading", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 433 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1028", "evaluated_value": 1028, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetLoginScriptFail", "family_id": "script.enum-value.EngineInfoMessage.NetLoginScriptFail", "kind": "enum-value", "name": "NetLoginScriptFail", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetLoginScriptFail = 1048", "description": "Identifies authentication rejected because a project login script failed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 450 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1048", "evaluated_value": 1048, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetManySymbols", "family_id": "script.enum-value.EngineInfoMessage.NetManySymbols", "kind": "enum-value", "name": "NetManySymbols", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetManySymbols = 1031", "description": "Identifies a name rejected because too much of it consists of non-letter symbols", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 436 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1031", "evaluated_value": 1031, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetNameWrongChars", "family_id": "script.enum-value.EngineInfoMessage.NetNameWrongChars", "kind": "enum-value", "name": "NetNameWrongChars", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetNameWrongChars = 1035", "description": "Identifies a name containing characters forbidden by the project's account policy", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 440 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1035", "evaluated_value": 1035, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetNetMsgErr", "family_id": "script.enum-value.EngineInfoMessage.NetNetMsgErr", "kind": "enum-value", "name": "NetNetMsgErr", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetNetMsgErr = 1026", "description": "Identifies a malformed, invalid, or otherwise unacceptable network message", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 431 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1026", "evaluated_value": 1026, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetPassWrongChars", "family_id": "script.enum-value.EngineInfoMessage.NetPassWrongChars", "kind": "enum-value", "name": "NetPassWrongChars", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetPassWrongChars = 1036", "description": "Identifies a password containing characters forbidden by the project's account policy", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 441 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1036", "evaluated_value": 1036, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetPermanentDeath", "family_id": "script.enum-value.EngineInfoMessage.NetPermanentDeath", "kind": "enum-value", "name": "NetPermanentDeath", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetPermanentDeath = 1049", "description": "Identifies a project-defined permanent-death state that prevents continuing with the affected character or account", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 451 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1049", "evaluated_value": 1049, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetPlayerAlready", "family_id": "script.enum-value.EngineInfoMessage.NetPlayerAlready", "kind": "enum-value", "name": "NetPlayerAlready", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetPlayerAlready = 1003", "description": "Identifies account creation rejected because the requested login already exists", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 417 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1003", "evaluated_value": 1003, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetPlayerInGame", "family_id": "script.enum-value.EngineInfoMessage.NetPlayerInGame", "kind": "enum-value", "name": "NetPlayerInGame", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetPlayerInGame = 1004", "description": "Identifies login rejected because the account already has an active game session", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 418 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1004", "evaluated_value": 1004, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetSetProtoErr", "family_id": "script.enum-value.EngineInfoMessage.NetSetProtoErr", "kind": "enum-value", "name": "NetSetProtoErr", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetSetProtoErr = 1027", "description": "Identifies an internal server failure while assigning or initializing required prototype state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 432 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1027", "evaluated_value": 1027, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetStartCoordFail", "family_id": "script.enum-value.EngineInfoMessage.NetStartCoordFail", "kind": "enum-value", "name": "NetStartCoordFail", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetStartCoordFail = 1022", "description": "Identifies failure to resolve starting map coordinates during player entry or creation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 427 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1022", "evaluated_value": 1022, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetStartLocFail", "family_id": "script.enum-value.EngineInfoMessage.NetStartLocFail", "kind": "enum-value", "name": "NetStartLocFail", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetStartLocFail = 1020", "description": "Identifies failure to resolve the starting location during player entry or creation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 425 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1020", "evaluated_value": 1020, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetStartMapFail", "family_id": "script.enum-value.EngineInfoMessage.NetStartMapFail", "kind": "enum-value", "name": "NetStartMapFail", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetStartMapFail = 1021", "description": "Identifies failure to resolve the starting map during player entry or creation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 426 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1021", "evaluated_value": 1021, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetTimeLeft", "family_id": "script.enum-value.EngineInfoMessage.NetTimeLeft", "kind": "enum-value", "name": "NetTimeLeft", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetTimeLeft = 1045", "description": "Identifies a temporary restriction or session timer whose remaining duration is supplied by project text or extra data", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 447 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1045", "evaluated_value": 1045, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetTwoSpace", "family_id": "script.enum-value.EngineInfoMessage.NetTwoSpace", "kind": "enum-value", "name": "NetTwoSpace", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetTwoSpace = 1033", "description": "Identifies a name rejected because it contains consecutive spaces", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 438 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1033", "evaluated_value": 1033, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetWrongLogin", "family_id": "script.enum-value.EngineInfoMessage.NetWrongLogin", "kind": "enum-value", "name": "NetWrongLogin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetWrongLogin = 1001", "description": "Identifies a login rejection caused by an invalid account or login identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 415 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1001", "evaluated_value": 1001, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetWrongNetProto", "family_id": "script.enum-value.EngineInfoMessage.NetWrongNetProto", "kind": "enum-value", "name": "NetWrongNetProto", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetWrongNetProto = 1024", "description": "Identifies a client/server network-protocol version mismatch", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 429 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetWrongPass", "family_id": "script.enum-value.EngineInfoMessage.NetWrongPass", "kind": "enum-value", "name": "NetWrongPass", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetWrongPass = 1002", "description": "Identifies a login rejection caused by an invalid password or equivalent authentication secret", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 416 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1002", "evaluated_value": 1002, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.NetWrongTagSkill", "family_id": "script.enum-value.EngineInfoMessage.NetWrongTagSkill", "kind": "enum-value", "name": "NetWrongTagSkill", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.NetWrongTagSkill = 1029", "description": "Identifies character creation rejected because the required tagged-skill selection is invalid", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 434 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "1029", "evaluated_value": 1029, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.None", "family_id": "script.enum-value.EngineInfoMessage.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.None = 0", "description": "Selects no conventional engine information-message slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 413 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.EngineInfoMessage.ServerLog", "family_id": "script.enum-value.EngineInfoMessage.ServerLog", "kind": "enum-value", "name": "ServerLog", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EngineInfoMessage", "signature": "EngineInfoMessage.ServerLog = 5001", "description": "Identifies a server-log message whose reader-facing payload is carried in extraText", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 454 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EngineInfoMessage", "value": "5001", "evaluated_value": 5001, "generated": false }, { "id": "script.enum-value.EventPriority.High", "family_id": "script.enum-value.EventPriority.High", "kind": "enum-value", "name": "High", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventPriority", "signature": "EventPriority.High = 3000000", "description": "Runs after the highest callback and before normal-priority callbacks", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 161 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventPriority", "value": "3000000", "evaluated_value": 3000000, "generated": false }, { "id": "script.enum-value.EventPriority.Highest", "family_id": "script.enum-value.EventPriority.Highest", "kind": "enum-value", "name": "Highest", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventPriority", "signature": "EventPriority.Highest = 4000000", "description": "Runs before callbacks with lower numeric priority; only one callback may occupy the highest band", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 162 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventPriority", "value": "4000000", "evaluated_value": 4000000, "generated": false }, { "id": "script.enum-value.EventPriority.Low", "family_id": "script.enum-value.EventPriority.Low", "kind": "enum-value", "name": "Low", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventPriority", "signature": "EventPriority.Low = 1000000", "description": "Runs after normal-priority callbacks and before the lowest callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 159 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventPriority", "value": "1000000", "evaluated_value": 1000000, "generated": false }, { "id": "script.enum-value.EventPriority.Lowest", "family_id": "script.enum-value.EventPriority.Lowest", "kind": "enum-value", "name": "Lowest", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventPriority", "signature": "EventPriority.Lowest = 0", "description": "Runs after callbacks with higher numeric priority; only one callback may occupy the lowest band", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 158 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventPriority", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.EventPriority.Normal", "family_id": "script.enum-value.EventPriority.Normal", "kind": "enum-value", "name": "Normal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventPriority", "signature": "EventPriority.Normal = 2000000", "description": "Default callback priority between the low and high bands", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventPriority", "value": "2000000", "evaluated_value": 2000000, "generated": false }, { "id": "script.enum-value.EventResult.ContinueChain", "family_id": "script.enum-value.EventResult.ContinueChain", "kind": "enum-value", "name": "ContinueChain", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventResult", "signature": "EventResult.ContinueChain = 0", "description": "Continues dispatching callbacks with lower priority", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 148 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventResult", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.EventResult.StopChain", "family_id": "script.enum-value.EventResult.StopChain", "kind": "enum-value", "name": "StopChain", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "EventResult", "signature": "EventResult.StopChain = 1", "description": "Stops the current event callback chain immediately", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 149 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.EventResult", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.FontFlag.AlignBottom", "family_id": "script.enum-value.FontFlag.AlignBottom", "kind": "enum-value", "name": "AlignBottom", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.AlignBottom = 0x0020", "description": "Aligns the text block to the bottom and makes SkipLines count from the trailing lines", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 73 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0020", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.FontFlag.AlignRight", "family_id": "script.enum-value.FontFlag.AlignRight", "kind": "enum-value", "name": "AlignRight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.AlignRight = 0x0010", "description": "Right-aligns each rendered line within the target rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 72 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0010", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.FontFlag.Bordered", "family_id": "script.enum-value.FontFlag.Bordered", "kind": "enum-value", "name": "Bordered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.Bordered = 0x0200", "description": "Uses the bordered or outlined font-texture variant for glyph rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0200", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.FontFlag.CenterX", "family_id": "script.enum-value.FontFlag.CenterX", "kind": "enum-value", "name": "CenterX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.CenterX = 0x0004", "description": "Horizontally centers each rendered line within the target rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 70 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0004", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.FontFlag.CenterY", "family_id": "script.enum-value.FontFlag.CenterY", "kind": "enum-value", "name": "CenterY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.CenterY = 0x0008", "description": "Vertically centers the complete text block within the target rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 71 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0008", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.FontFlag.Justify", "family_id": "script.enum-value.FontFlag.Justify", "kind": "enum-value", "name": "Justify", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.Justify = 0x0100", "description": "Distributes extra spacing between words to fill each line's target width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0100", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.FontFlag.KeepTail", "family_id": "script.enum-value.FontFlag.KeepTail", "kind": "enum-value", "name": "KeepTail", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.KeepTail = 0x0040", "description": "Renders the tail of a text block that is taller than the target rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 74 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0040", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.FontFlag.NoColorize", "family_id": "script.enum-value.FontFlag.NoColorize", "kind": "enum-value", "name": "NoColorize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.NoColorize = 0x0080", "description": "Removes inline color tags while retaining the supplied base text color", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 75 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0080", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.FontFlag.NoWrap", "family_id": "script.enum-value.FontFlag.NoWrap", "kind": "enum-value", "name": "NoWrap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.NoWrap = 0x0001", "description": "Truncates the remaining text at rectangle-width overflow instead of wrapping it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0001", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.FontFlag.None", "family_id": "script.enum-value.FontFlag.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.None = 0", "description": "Applies no optional text-layout or glyph-rendering flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 67 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.FontFlag.TruncateLine", "family_id": "script.enum-value.FontFlag.TruncateLine", "kind": "enum-value", "name": "TruncateLine", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontFlag", "signature": "FontFlag.TruncateLine = 0x0002", "description": "Skips overflowing glyphs through the next newline instead of wrapping the current line", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontFlag", "value": "0x0002", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.FontType.Default", "family_id": "script.enum-value.FontType.Default", "kind": "enum-value", "name": "Default", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "FontType", "signature": "FontType.Default = 0", "description": "Built-in default font slot used when no project-defined slot is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.FontType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.GameProperty.CustomHolderEntry", "family_id": "script.enum-value.GameProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.GameProperty.CustomHolderId", "family_id": "script.enum-value.GameProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.GameProperty.ExplicitlyPersistent", "family_id": "script.enum-value.GameProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.GameProperty.FrameDeltaTime", "family_id": "script.enum-value.GameProperty.FrameDeltaTime", "kind": "enum-value", "name": "FrameDeltaTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.FrameDeltaTime = 8", "description": "Elapsed monotonic time between the current and previous frame advances", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "8", "evaluated_value": 8, "generated": true }, { "id": "script.enum-value.GameProperty.FrameTime", "family_id": "script.enum-value.GameProperty.FrameTime", "kind": "enum-value", "name": "FrameTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.FrameTime = 7", "description": "Monotonic engine time captured for the current frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 63 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "7", "evaluated_value": 7, "generated": true }, { "id": "script.enum-value.GameProperty.FramesPerSecond", "family_id": "script.enum-value.GameProperty.FramesPerSecond", "kind": "enum-value", "name": "FramesPerSecond", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.FramesPerSecond = 9", "description": "Frame count measured during the most recently completed one-second sampling interval", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "9", "evaluated_value": 9, "generated": true }, { "id": "script.enum-value.GameProperty.GlobalDayTime", "family_id": "script.enum-value.GameProperty.GlobalDayTime", "kind": "enum-value", "name": "GlobalDayTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.GlobalDayTime = 11", "description": "Current position of the global day-light cycle, measured in minutes and controlled by game scripts", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 75 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "11", "evaluated_value": 11, "generated": true }, { "id": "script.enum-value.GameProperty.HistoryRecordsId", "family_id": "script.enum-value.GameProperty.HistoryRecordsId", "kind": "enum-value", "name": "HistoryRecordsId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.HistoryRecordsId = 6", "description": "Persistent high-water mark used to allocate server history-record identifiers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "6", "evaluated_value": 6, "generated": true }, { "id": "script.enum-value.GameProperty.LastEntityId", "family_id": "script.enum-value.GameProperty.LastEntityId", "kind": "enum-value", "name": "LastEntityId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.LastEntityId = 5", "description": "Persistent high-water mark used to allocate durable entity identifiers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "5", "evaluated_value": 5, "generated": true }, { "id": "script.enum-value.GameProperty.LastGlobalMapTripId", "family_id": "script.enum-value.GameProperty.LastGlobalMapTripId", "kind": "enum-value", "name": "LastGlobalMapTripId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.LastGlobalMapTripId = 10", "description": "Last server-assigned identifier for a global-map trip", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 72 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "10", "evaluated_value": 10, "generated": true }, { "id": "script.enum-value.GameProperty.None", "family_id": "script.enum-value.GameProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.None = 0", "description": "Sentinel indicating that no Game property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.GameProperty.SynchronizedTime", "family_id": "script.enum-value.GameProperty.SynchronizedTime", "kind": "enum-value", "name": "SynchronizedTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GameProperty", "signature": "GameProperty.SynchronizedTime = 4", "description": "Current synchronized game time shared by the server and clients and persisted by the server", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.GameProperty", "value": "4", "evaluated_value": 4, "generated": true }, { "id": "script.enum-value.ImGuiProperty.CustomHolderEntry", "family_id": "script.enum-value.ImGuiProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGuiProperty", "signature": "ImGuiProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGuiProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.ImGuiProperty.CustomHolderId", "family_id": "script.enum-value.ImGuiProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGuiProperty", "signature": "ImGuiProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGuiProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.ImGuiProperty.ExplicitlyPersistent", "family_id": "script.enum-value.ImGuiProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGuiProperty", "signature": "ImGuiProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGuiProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.ImGuiProperty.None", "family_id": "script.enum-value.ImGuiProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGuiProperty", "signature": "ImGuiProperty.None = 0", "description": "Sentinel indicating that no ImGui property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGuiProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.ImGui_ButtonFlags.EnableNav", "family_id": "script.enum-value.ImGui_ButtonFlags.EnableNav", "kind": "enum-value", "name": "EnableNav", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ButtonFlags", "signature": "ImGui_ButtonFlags.EnableNav = 8", "description": "InvisibleButton(): do not disable navigation/tabbing. Otherwise disabled by default", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 411 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ButtonFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_ButtonFlags.MouseButtonLeft", "family_id": "script.enum-value.ImGui_ButtonFlags.MouseButtonLeft", "kind": "enum-value", "name": "MouseButtonLeft", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ButtonFlags", "signature": "ImGui_ButtonFlags.MouseButtonLeft = 1", "description": "React on left mouse button (default)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 408 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ButtonFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_ButtonFlags.MouseButtonMiddle", "family_id": "script.enum-value.ImGui_ButtonFlags.MouseButtonMiddle", "kind": "enum-value", "name": "MouseButtonMiddle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ButtonFlags", "signature": "ImGui_ButtonFlags.MouseButtonMiddle = 4", "description": "React on center mouse button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 410 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ButtonFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_ButtonFlags.MouseButtonRight", "family_id": "script.enum-value.ImGui_ButtonFlags.MouseButtonRight", "kind": "enum-value", "name": "MouseButtonRight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ButtonFlags", "signature": "ImGui_ButtonFlags.MouseButtonRight = 2", "description": "React on right mouse button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 409 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ButtonFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_ButtonFlags.None", "family_id": "script.enum-value.ImGui_ButtonFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ButtonFlags", "signature": "ImGui_ButtonFlags.None = 0", "description": "Applies no optional low-level button behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 407 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ButtonFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.AlwaysAutoResize", "family_id": "script.enum-value.ImGui_ChildFlags.AlwaysAutoResize", "kind": "enum-value", "name": "AlwaysAutoResize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.AlwaysAutoResize = 64", "description": "With automatic sizing enabled, measures hidden content, always reports the child as visible, and disables clipping optimization; this expensive mode is not recommended for routine use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.AlwaysUseWindowPadding", "family_id": "script.enum-value.ImGui_ChildFlags.AlwaysUseWindowPadding", "kind": "enum-value", "name": "AlwaysUseWindowPadding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.AlwaysUseWindowPadding = 2", "description": "Uses style.WindowPadding even when the child window has no border", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 108 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.AutoResizeX", "family_id": "script.enum-value.ImGui_ChildFlags.AutoResizeX", "kind": "enum-value", "name": "AutoResizeX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.AutoResizeX = 16", "description": "Derives the child-window width from its measured content", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.AutoResizeY", "family_id": "script.enum-value.ImGui_ChildFlags.AutoResizeY", "kind": "enum-value", "name": "AutoResizeY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.AutoResizeY = 32", "description": "Derives the child-window height from its measured content", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 112 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.Border", "family_id": "script.enum-value.ImGui_ChildFlags.Border", "kind": "enum-value", "name": "Border", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.Border = 1", "description": "Draws an outer border and enables the child window's standard window padding", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 107 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.FrameStyle", "family_id": "script.enum-value.ImGui_ChildFlags.FrameStyle", "kind": "enum-value", "name": "FrameStyle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.FrameStyle = 128", "description": "Styles the child window as a framed item by using frame colors, rounding, border size, and padding", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 114 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.NavFlattened", "family_id": "script.enum-value.ImGui_ChildFlags.NavFlattened", "kind": "enum-value", "name": "NavFlattened", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.NavFlattened = 256", "description": "Beta behavior that shares focus scope and allows keyboard or gamepad navigation across the parent border and sibling child windows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 115 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.None", "family_id": "script.enum-value.ImGui_ChildFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.None = 0", "description": "Applies no optional child-window behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 106 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.ResizeX", "family_id": "script.enum-value.ImGui_ChildFlags.ResizeX", "kind": "enum-value", "name": "ResizeX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.ResizeX = 4", "description": "Allows resizing from the right layout border and persists the width unless window settings are disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 109 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_ChildFlags.ResizeY", "family_id": "script.enum-value.ImGui_ChildFlags.ResizeY", "kind": "enum-value", "name": "ResizeY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ChildFlags", "signature": "ImGui_ChildFlags.ResizeY = 8", "description": "Allows resizing from the bottom layout border and persists the height unless window settings are disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 110 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ChildFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_Col.Border", "family_id": "script.enum-value.ImGui_Col.Border", "kind": "enum-value", "name": "Border", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.Border = 5", "description": "Selects the border color slot for windows, child windows, popups, and framed widgets", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 455 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.ImGui_Col.Button", "family_id": "script.enum-value.ImGui_Col.Button", "kind": "enum-value", "name": "Button", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.Button = 22", "description": "Selects the normal button color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 467 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "22", "evaluated_value": 22, "generated": false }, { "id": "script.enum-value.ImGui_Col.ButtonActive", "family_id": "script.enum-value.ImGui_Col.ButtonActive", "kind": "enum-value", "name": "ButtonActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ButtonActive = 24", "description": "Selects the active button color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 469 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "24", "evaluated_value": 24, "generated": false }, { "id": "script.enum-value.ImGui_Col.ButtonHovered", "family_id": "script.enum-value.ImGui_Col.ButtonHovered", "kind": "enum-value", "name": "ButtonHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ButtonHovered = 23", "description": "Selects the hovered button color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 468 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "23", "evaluated_value": 23, "generated": false }, { "id": "script.enum-value.ImGui_Col.CheckMark", "family_id": "script.enum-value.ImGui_Col.CheckMark", "kind": "enum-value", "name": "CheckMark", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.CheckMark = 18", "description": "Checkbox tick and RadioButton circle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 464 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "18", "evaluated_value": 18, "generated": false }, { "id": "script.enum-value.ImGui_Col.ChildBg", "family_id": "script.enum-value.ImGui_Col.ChildBg", "kind": "enum-value", "name": "ChildBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ChildBg = 3", "description": "Background of child windows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 453 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.ImGui_Col.FrameBg", "family_id": "script.enum-value.ImGui_Col.FrameBg", "kind": "enum-value", "name": "FrameBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.FrameBg = 7", "description": "Background of checkbox, radio button, plot, slider, text input", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 456 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "7", "evaluated_value": 7, "generated": false }, { "id": "script.enum-value.ImGui_Col.FrameBgActive", "family_id": "script.enum-value.ImGui_Col.FrameBgActive", "kind": "enum-value", "name": "FrameBgActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.FrameBgActive = 9", "description": "Selects the frame background color slot while the frame is active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 458 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "9", "evaluated_value": 9, "generated": false }, { "id": "script.enum-value.ImGui_Col.FrameBgHovered", "family_id": "script.enum-value.ImGui_Col.FrameBgHovered", "kind": "enum-value", "name": "FrameBgHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.FrameBgHovered = 8", "description": "Selects the frame background color slot while the frame is hovered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 457 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_Col.Header", "family_id": "script.enum-value.ImGui_Col.Header", "kind": "enum-value", "name": "Header", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.Header = 25", "description": "Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 470 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "25", "evaluated_value": 25, "generated": false }, { "id": "script.enum-value.ImGui_Col.HeaderActive", "family_id": "script.enum-value.ImGui_Col.HeaderActive", "kind": "enum-value", "name": "HeaderActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.HeaderActive = 27", "description": "Selects the active header color slot used by headers, tree nodes, and selectables", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 472 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "27", "evaluated_value": 27, "generated": false }, { "id": "script.enum-value.ImGui_Col.HeaderHovered", "family_id": "script.enum-value.ImGui_Col.HeaderHovered", "kind": "enum-value", "name": "HeaderHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.HeaderHovered = 26", "description": "Selects the hovered header color slot used by headers, tree nodes, and selectables", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 471 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "26", "evaluated_value": 26, "generated": false }, { "id": "script.enum-value.ImGui_Col.MenuBarBg", "family_id": "script.enum-value.ImGui_Col.MenuBarBg", "kind": "enum-value", "name": "MenuBarBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.MenuBarBg = 13", "description": "Selects the menu-bar background color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 461 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "13", "evaluated_value": 13, "generated": false }, { "id": "script.enum-value.ImGui_Col.PopupBg", "family_id": "script.enum-value.ImGui_Col.PopupBg", "kind": "enum-value", "name": "PopupBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.PopupBg = 4", "description": "Background of popups, menus, tooltips windows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 454 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_Col.ResizeGrip", "family_id": "script.enum-value.ImGui_Col.ResizeGrip", "kind": "enum-value", "name": "ResizeGrip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ResizeGrip = 31", "description": "Resize grip in lower-right and lower-left corners of windows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 476 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "31", "evaluated_value": 31, "generated": false }, { "id": "script.enum-value.ImGui_Col.ResizeGripActive", "family_id": "script.enum-value.ImGui_Col.ResizeGripActive", "kind": "enum-value", "name": "ResizeGripActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ResizeGripActive = 33", "description": "Selects the active resize-grip color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 478 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "33", "evaluated_value": 33, "generated": false }, { "id": "script.enum-value.ImGui_Col.ResizeGripHovered", "family_id": "script.enum-value.ImGui_Col.ResizeGripHovered", "kind": "enum-value", "name": "ResizeGripHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ResizeGripHovered = 32", "description": "Selects the hovered resize-grip color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 477 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_Col.ScrollbarBg", "family_id": "script.enum-value.ImGui_Col.ScrollbarBg", "kind": "enum-value", "name": "ScrollbarBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ScrollbarBg = 14", "description": "Selects the scrollbar-track background color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 462 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "14", "evaluated_value": 14, "generated": false }, { "id": "script.enum-value.ImGui_Col.ScrollbarGrab", "family_id": "script.enum-value.ImGui_Col.ScrollbarGrab", "kind": "enum-value", "name": "ScrollbarGrab", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.ScrollbarGrab = 15", "description": "Selects the normal scrollbar-grab color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 463 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "15", "evaluated_value": 15, "generated": false }, { "id": "script.enum-value.ImGui_Col.Separator", "family_id": "script.enum-value.ImGui_Col.Separator", "kind": "enum-value", "name": "Separator", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.Separator = 28", "description": "Selects the normal separator color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 473 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "28", "evaluated_value": 28, "generated": false }, { "id": "script.enum-value.ImGui_Col.SeparatorActive", "family_id": "script.enum-value.ImGui_Col.SeparatorActive", "kind": "enum-value", "name": "SeparatorActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.SeparatorActive = 30", "description": "Selects the active separator color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 475 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "30", "evaluated_value": 30, "generated": false }, { "id": "script.enum-value.ImGui_Col.SeparatorHovered", "family_id": "script.enum-value.ImGui_Col.SeparatorHovered", "kind": "enum-value", "name": "SeparatorHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.SeparatorHovered = 29", "description": "Selects the hovered separator color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 474 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "29", "evaluated_value": 29, "generated": false }, { "id": "script.enum-value.ImGui_Col.SliderGrab", "family_id": "script.enum-value.ImGui_Col.SliderGrab", "kind": "enum-value", "name": "SliderGrab", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.SliderGrab = 20", "description": "Selects the normal slider-grab color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 465 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "20", "evaluated_value": 20, "generated": false }, { "id": "script.enum-value.ImGui_Col.SliderGrabActive", "family_id": "script.enum-value.ImGui_Col.SliderGrabActive", "kind": "enum-value", "name": "SliderGrabActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.SliderGrabActive = 21", "description": "Selects the active slider-grab color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 466 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "21", "evaluated_value": 21, "generated": false }, { "id": "script.enum-value.ImGui_Col.Tab", "family_id": "script.enum-value.ImGui_Col.Tab", "kind": "enum-value", "name": "Tab", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.Tab = 36", "description": "Tab background, when tab-bar is focused & tab is unselected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 479 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "36", "evaluated_value": 36, "generated": false }, { "id": "script.enum-value.ImGui_Col.TabDimmed", "family_id": "script.enum-value.ImGui_Col.TabDimmed", "kind": "enum-value", "name": "TabDimmed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TabDimmed = 39", "description": "Tab background, when tab-bar is unfocused & tab is unselected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 482 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "39", "evaluated_value": 39, "generated": false }, { "id": "script.enum-value.ImGui_Col.TabDimmedSelected", "family_id": "script.enum-value.ImGui_Col.TabDimmedSelected", "kind": "enum-value", "name": "TabDimmedSelected", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TabDimmedSelected = 40", "description": "Tab background, when tab-bar is unfocused & tab is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 483 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "40", "evaluated_value": 40, "generated": false }, { "id": "script.enum-value.ImGui_Col.TabHovered", "family_id": "script.enum-value.ImGui_Col.TabHovered", "kind": "enum-value", "name": "TabHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TabHovered = 35", "description": "Tab background, when hovered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 480 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "35", "evaluated_value": 35, "generated": false }, { "id": "script.enum-value.ImGui_Col.TabSelected", "family_id": "script.enum-value.ImGui_Col.TabSelected", "kind": "enum-value", "name": "TabSelected", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TabSelected = 37", "description": "Tab background, when tab-bar is focused & tab is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 481 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "37", "evaluated_value": 37, "generated": false }, { "id": "script.enum-value.ImGui_Col.TableHeaderBg", "family_id": "script.enum-value.ImGui_Col.TableHeaderBg", "kind": "enum-value", "name": "TableHeaderBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TableHeaderBg = 46", "description": "Table header background", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 484 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "46", "evaluated_value": 46, "generated": false }, { "id": "script.enum-value.ImGui_Col.TableRowBg", "family_id": "script.enum-value.ImGui_Col.TableRowBg", "kind": "enum-value", "name": "TableRowBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TableRowBg = 49", "description": "Table row background (even rows)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 485 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "49", "evaluated_value": 49, "generated": false }, { "id": "script.enum-value.ImGui_Col.TableRowBgAlt", "family_id": "script.enum-value.ImGui_Col.TableRowBgAlt", "kind": "enum-value", "name": "TableRowBgAlt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TableRowBgAlt = 50", "description": "Table row background (odd rows)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 486 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "50", "evaluated_value": 50, "generated": false }, { "id": "script.enum-value.ImGui_Col.Text", "family_id": "script.enum-value.ImGui_Col.Text", "kind": "enum-value", "name": "Text", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.Text = 0", "description": "Selects the primary text color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 450 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_Col.TextDisabled", "family_id": "script.enum-value.ImGui_Col.TextDisabled", "kind": "enum-value", "name": "TextDisabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TextDisabled = 1", "description": "Selects the disabled-text color slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 451 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_Col.TitleBg", "family_id": "script.enum-value.ImGui_Col.TitleBg", "kind": "enum-value", "name": "TitleBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TitleBg = 10", "description": "Title bar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 459 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "10", "evaluated_value": 10, "generated": false }, { "id": "script.enum-value.ImGui_Col.TitleBgActive", "family_id": "script.enum-value.ImGui_Col.TitleBgActive", "kind": "enum-value", "name": "TitleBgActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.TitleBgActive = 11", "description": "Title bar when focused", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 460 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "11", "evaluated_value": 11, "generated": false }, { "id": "script.enum-value.ImGui_Col.WindowBg", "family_id": "script.enum-value.ImGui_Col.WindowBg", "kind": "enum-value", "name": "WindowBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Col", "signature": "ImGui_Col.WindowBg = 2", "description": "Background of normal windows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 452 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Col", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.AlphaBar", "family_id": "script.enum-value.ImGui_ColorEditFlags.AlphaBar", "kind": "enum-value", "name": "AlphaBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.AlphaBar = 262144", "description": "ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 432 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "262144", "evaluated_value": 262144, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.AlphaNoBg", "family_id": "script.enum-value.ImGui_ColorEditFlags.AlphaNoBg", "kind": "enum-value", "name": "AlphaNoBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.AlphaNoBg = 8192", "description": "ColorEdit, ColorPicker, ColorButton: disable rendering a checkerboard background behind transparent color", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 430 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "8192", "evaluated_value": 8192, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.AlphaOpaque", "family_id": "script.enum-value.ImGui_ColorEditFlags.AlphaOpaque", "kind": "enum-value", "name": "AlphaOpaque", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.AlphaOpaque = 4096", "description": "Hides alpha in the preview while still allowing ColorEdit4 and ColorPicker4 to edit it; for ColorButton this is equivalent to NoAlpha", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 429 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.AlphaPreviewHalf", "family_id": "script.enum-value.ImGui_ColorEditFlags.AlphaPreviewHalf", "kind": "enum-value", "name": "AlphaPreviewHalf", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.AlphaPreviewHalf = 16384", "description": "ColorEdit, ColorPicker, ColorButton: display half opaque / half transparent preview", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 431 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "16384", "evaluated_value": 16384, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.DefaultOptions", "family_id": "script.enum-value.ImGui_ColorEditFlags.DefaultOptions", "kind": "enum-value", "name": "DefaultOptions", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.DefaultOptions = 311427072", "description": "Selects 8-bit RGB display and input with the hue-bar picker as the default color-editor options", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 443 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "311427072", "evaluated_value": 311427072, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.DisplayHSV", "family_id": "script.enum-value.ImGui_ColorEditFlags.DisplayHSV", "kind": "enum-value", "name": "DisplayHSV", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.DisplayHSV = 2097152", "description": "Displays and edits color components in HSV form", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 435 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "2097152", "evaluated_value": 2097152, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.DisplayHex", "family_id": "script.enum-value.ImGui_ColorEditFlags.DisplayHex", "kind": "enum-value", "name": "DisplayHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.DisplayHex = 4194304", "description": "Displays and edits the color as a hexadecimal value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 436 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "4194304", "evaluated_value": 4194304, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.DisplayRGB", "family_id": "script.enum-value.ImGui_ColorEditFlags.DisplayRGB", "kind": "enum-value", "name": "DisplayRGB", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.DisplayRGB = 1048576", "description": "ColorEdit: override _display_ type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 434 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "1048576", "evaluated_value": 1048576, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.Float", "family_id": "script.enum-value.ImGui_ColorEditFlags.Float", "kind": "enum-value", "name": "Float", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.Float = 16777216", "description": "ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 438 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "16777216", "evaluated_value": 16777216, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.HDR", "family_id": "script.enum-value.ImGui_ColorEditFlags.HDR", "kind": "enum-value", "name": "HDR", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.HDR = 524288", "description": "(WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 433 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "524288", "evaluated_value": 524288, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.InputHSV", "family_id": "script.enum-value.ImGui_ColorEditFlags.InputHSV", "kind": "enum-value", "name": "InputHSV", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.InputHSV = 536870912", "description": "ColorEdit, ColorPicker: input and output data in HSV format", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 442 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "536870912", "evaluated_value": 536870912, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.InputRGB", "family_id": "script.enum-value.ImGui_ColorEditFlags.InputRGB", "kind": "enum-value", "name": "InputRGB", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.InputRGB = 268435456", "description": "ColorEdit, ColorPicker: input and output data in RGB format", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 441 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "268435456", "evaluated_value": 268435456, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoAlpha", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoAlpha", "kind": "enum-value", "name": "NoAlpha", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoAlpha = 2", "description": "ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 419 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoBorder", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoBorder", "kind": "enum-value", "name": "NoBorder", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoBorder = 1024", "description": "ColorButton: disable border (which is enforced by default)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 428 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoDragDrop", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoDragDrop", "kind": "enum-value", "name": "NoDragDrop", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoDragDrop = 512", "description": "ColorEdit: disable drag and drop target/source. ColorButton: disable drag and drop source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 427 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoInputs", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoInputs", "kind": "enum-value", "name": "NoInputs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoInputs = 32", "description": "ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoLabel", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoLabel", "kind": "enum-value", "name": "NoLabel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoLabel = 128", "description": "ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 425 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoOptions", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoOptions", "kind": "enum-value", "name": "NoOptions", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoOptions = 8", "description": "ColorEdit: disable toggling options menu when right-clicking on inputs/small preview", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 421 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoPicker", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoPicker", "kind": "enum-value", "name": "NoPicker", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoPicker = 4", "description": "ColorEdit: disable picker when clicking on color square", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 420 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoSidePreview", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoSidePreview", "kind": "enum-value", "name": "NoSidePreview", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoSidePreview = 256", "description": "ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 426 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoSmallPreview", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoSmallPreview", "kind": "enum-value", "name": "NoSmallPreview", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoSmallPreview = 16", "description": "ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 422 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.NoTooltip", "family_id": "script.enum-value.ImGui_ColorEditFlags.NoTooltip", "kind": "enum-value", "name": "NoTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.NoTooltip = 64", "description": "ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 424 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.None", "family_id": "script.enum-value.ImGui_ColorEditFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.None = 0", "description": "Applies no optional color-editor behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 418 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.PickerHueBar", "family_id": "script.enum-value.ImGui_ColorEditFlags.PickerHueBar", "kind": "enum-value", "name": "PickerHueBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.PickerHueBar = 33554432", "description": "ColorPicker: bar for Hue, rectangle for Sat/Value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 439 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "33554432", "evaluated_value": 33554432, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.PickerHueWheel", "family_id": "script.enum-value.ImGui_ColorEditFlags.PickerHueWheel", "kind": "enum-value", "name": "PickerHueWheel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.PickerHueWheel = 67108864", "description": "ColorPicker: wheel for Hue, triangle for Sat/Value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 440 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "67108864", "evaluated_value": 67108864, "generated": false }, { "id": "script.enum-value.ImGui_ColorEditFlags.Uint8", "family_id": "script.enum-value.ImGui_ColorEditFlags.Uint8", "kind": "enum-value", "name": "Uint8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ColorEditFlags", "signature": "ImGui_ColorEditFlags.Uint8 = 8388608", "description": "ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 437 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ColorEditFlags", "value": "8388608", "evaluated_value": 8388608, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.HeightLarge", "family_id": "script.enum-value.ImGui_ComboFlags.HeightLarge", "kind": "enum-value", "name": "HeightLarge", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.HeightLarge = 8", "description": "Max ~20 items visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 327 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.HeightLargest", "family_id": "script.enum-value.ImGui_ComboFlags.HeightLargest", "kind": "enum-value", "name": "HeightLargest", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.HeightLargest = 16", "description": "As many fitting items as possible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 328 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.HeightRegular", "family_id": "script.enum-value.ImGui_ComboFlags.HeightRegular", "kind": "enum-value", "name": "HeightRegular", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.HeightRegular = 4", "description": "Max ~8 items visible (default)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 326 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.HeightSmall", "family_id": "script.enum-value.ImGui_ComboFlags.HeightSmall", "kind": "enum-value", "name": "HeightSmall", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.HeightSmall = 2", "description": "Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.NoArrowButton", "family_id": "script.enum-value.ImGui_ComboFlags.NoArrowButton", "kind": "enum-value", "name": "NoArrowButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.NoArrowButton = 32", "description": "Display on the preview box without the square arrow button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 329 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.NoPreview", "family_id": "script.enum-value.ImGui_ComboFlags.NoPreview", "kind": "enum-value", "name": "NoPreview", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.NoPreview = 64", "description": "Display only a square arrow button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 330 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.None", "family_id": "script.enum-value.ImGui_ComboFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.None = 0", "description": "Applies no optional combo-box behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 323 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.PopupAlignLeft", "family_id": "script.enum-value.ImGui_ComboFlags.PopupAlignLeft", "kind": "enum-value", "name": "PopupAlignLeft", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.PopupAlignLeft = 1", "description": "Align the popup toward the left by default", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 324 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_ComboFlags.WidthFitPreview", "family_id": "script.enum-value.ImGui_ComboFlags.WidthFitPreview", "kind": "enum-value", "name": "WidthFitPreview", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_ComboFlags", "signature": "ImGui_ComboFlags.WidthFitPreview = 128", "description": "Width dynamically calculated from preview contents", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 331 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_ComboFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_Cond.Always", "family_id": "script.enum-value.ImGui_Cond.Always", "kind": "enum-value", "name": "Always", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Cond", "signature": "ImGui_Cond.Always = 1", "description": "No condition (always set the variable), same as _None", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 123 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Cond", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_Cond.Appearing", "family_id": "script.enum-value.ImGui_Cond.Appearing", "kind": "enum-value", "name": "Appearing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Cond", "signature": "ImGui_Cond.Appearing = 8", "description": "Set the variable if the object/window is appearing after being hidden/inactive (or the first time)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 126 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Cond", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_Cond.FirstUseEver", "family_id": "script.enum-value.ImGui_Cond.FirstUseEver", "kind": "enum-value", "name": "FirstUseEver", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Cond", "signature": "ImGui_Cond.FirstUseEver = 4", "description": "Set the variable if the object/window has no persistently saved data (no entry in .ini file)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 125 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Cond", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_Cond.None", "family_id": "script.enum-value.ImGui_Cond.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Cond", "signature": "ImGui_Cond.None = 0", "description": "No condition (always set the variable), same as _Always", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 122 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Cond", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_Cond.Once", "family_id": "script.enum-value.ImGui_Cond.Once", "kind": "enum-value", "name": "Once", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Cond", "signature": "ImGui_Cond.Once = 2", "description": "Set the variable once per runtime session (only the first call will succeed)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 124 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Cond", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_Dir.Down", "family_id": "script.enum-value.ImGui_Dir.Down", "kind": "enum-value", "name": "Down", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Dir", "signature": "ImGui_Dir.Down = 3", "description": "Selects the downward cardinal direction", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 385 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Dir", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.ImGui_Dir.Left", "family_id": "script.enum-value.ImGui_Dir.Left", "kind": "enum-value", "name": "Left", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Dir", "signature": "ImGui_Dir.Left = 0", "description": "Selects the left cardinal direction", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 382 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Dir", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_Dir.None", "family_id": "script.enum-value.ImGui_Dir.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Dir", "signature": "ImGui_Dir.None = -1", "description": "Indicates that no cardinal direction is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 381 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Dir", "value": "-1", "evaluated_value": -1, "generated": false }, { "id": "script.enum-value.ImGui_Dir.Right", "family_id": "script.enum-value.ImGui_Dir.Right", "kind": "enum-value", "name": "Right", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Dir", "signature": "ImGui_Dir.Right = 1", "description": "Selects the right cardinal direction", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 383 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Dir", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_Dir.Up", "family_id": "script.enum-value.ImGui_Dir.Up", "kind": "enum-value", "name": "Up", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_Dir", "signature": "ImGui_Dir.Up = 2", "description": "Selects the upward cardinal direction", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 384 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_Dir", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_FocusedFlags.AnyWindow", "family_id": "script.enum-value.ImGui_FocusedFlags.AnyWindow", "kind": "enum-value", "name": "AnyWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_FocusedFlags", "signature": "ImGui_FocusedFlags.AnyWindow = 4", "description": "Return true if any window is focused. Important: If you are trying to tell how to dispatch your low-level inputs, do NOT use this. Use 'io.WantCaptureMouse' instead! Please read the FAQ!", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 171 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_FocusedFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_FocusedFlags.ChildWindows", "family_id": "script.enum-value.ImGui_FocusedFlags.ChildWindows", "kind": "enum-value", "name": "ChildWindows", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_FocusedFlags", "signature": "ImGui_FocusedFlags.ChildWindows = 1", "description": "Return true if any children of the window is focused", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 169 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_FocusedFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_FocusedFlags.NoPopupHierarchy", "family_id": "script.enum-value.ImGui_FocusedFlags.NoPopupHierarchy", "kind": "enum-value", "name": "NoPopupHierarchy", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_FocusedFlags", "signature": "ImGui_FocusedFlags.NoPopupHierarchy = 8", "description": "Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 172 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_FocusedFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_FocusedFlags.None", "family_id": "script.enum-value.ImGui_FocusedFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_FocusedFlags", "signature": "ImGui_FocusedFlags.None = 0", "description": "Tests focus only for the current window without expanding the query scope", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 168 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_FocusedFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_FocusedFlags.RootAndChildWindows", "family_id": "script.enum-value.ImGui_FocusedFlags.RootAndChildWindows", "kind": "enum-value", "name": "RootAndChildWindows", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_FocusedFlags", "signature": "ImGui_FocusedFlags.RootAndChildWindows = 3", "description": "Tests the root window and all of its child windows for focus", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 173 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_FocusedFlags", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.ImGui_FocusedFlags.RootWindow", "family_id": "script.enum-value.ImGui_FocusedFlags.RootWindow", "kind": "enum-value", "name": "RootWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_FocusedFlags", "signature": "ImGui_FocusedFlags.RootWindow = 2", "description": "Test from root window (top most parent of the current hierarchy)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 170 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_FocusedFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AllowWhenBlockedByActiveItem", "family_id": "script.enum-value.ImGui_HoveredFlags.AllowWhenBlockedByActiveItem", "kind": "enum-value", "name": "AllowWhenBlockedByActiveItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AllowWhenBlockedByActiveItem = 128", "description": "Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 186 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AllowWhenBlockedByPopup", "family_id": "script.enum-value.ImGui_HoveredFlags.AllowWhenBlockedByPopup", "kind": "enum-value", "name": "AllowWhenBlockedByPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AllowWhenBlockedByPopup = 32", "description": "Return true even if a popup window is normally blocking access to this item/window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 185 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AllowWhenDisabled", "family_id": "script.enum-value.ImGui_HoveredFlags.AllowWhenDisabled", "kind": "enum-value", "name": "AllowWhenDisabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AllowWhenDisabled = 1024", "description": "IsItemHovered() only: Return true even if the item is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 189 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AllowWhenOverlapped", "family_id": "script.enum-value.ImGui_HoveredFlags.AllowWhenOverlapped", "kind": "enum-value", "name": "AllowWhenOverlapped", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AllowWhenOverlapped = 768", "description": "Allows a hover result when another item or window overlaps the tested rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 191 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "768", "evaluated_value": 768, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AllowWhenOverlappedByItem", "family_id": "script.enum-value.ImGui_HoveredFlags.AllowWhenOverlappedByItem", "kind": "enum-value", "name": "AllowWhenOverlappedByItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AllowWhenOverlappedByItem = 256", "description": "IsItemHovered() only: Return true even if the item uses AllowOverlap mode and is overlapped by another hoverable item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 187 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AllowWhenOverlappedByWindow", "family_id": "script.enum-value.ImGui_HoveredFlags.AllowWhenOverlappedByWindow", "kind": "enum-value", "name": "AllowWhenOverlappedByWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AllowWhenOverlappedByWindow = 512", "description": "IsItemHovered() only: Return true even if the position is obstructed or overlapped by another window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 188 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.AnyWindow", "family_id": "script.enum-value.ImGui_HoveredFlags.AnyWindow", "kind": "enum-value", "name": "AnyWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.AnyWindow = 4", "description": "IsWindowHovered() only: Return true if any window is hovered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 183 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.ChildWindows", "family_id": "script.enum-value.ImGui_HoveredFlags.ChildWindows", "kind": "enum-value", "name": "ChildWindows", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.ChildWindows = 1", "description": "IsWindowHovered() only: Return true if any children of the window is hovered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 181 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.ForTooltip", "family_id": "script.enum-value.ImGui_HoveredFlags.ForTooltip", "kind": "enum-value", "name": "ForTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.ForTooltip = 4096", "description": "Shortcut for standard flags when using IsItemHovered() + SetTooltip() sequence", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 193 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.NoNavOverride", "family_id": "script.enum-value.ImGui_HoveredFlags.NoNavOverride", "kind": "enum-value", "name": "NoNavOverride", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.NoNavOverride = 2048", "description": "IsItemHovered() only: Disable using keyboard/gamepad navigation state when active, always query mouse", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 190 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.NoPopupHierarchy", "family_id": "script.enum-value.ImGui_HoveredFlags.NoPopupHierarchy", "kind": "enum-value", "name": "NoPopupHierarchy", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.NoPopupHierarchy = 8", "description": "IsWindowHovered() only: Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 184 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.None", "family_id": "script.enum-value.ImGui_HoveredFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.None = 0", "description": "Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 180 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.RectOnly", "family_id": "script.enum-value.ImGui_HoveredFlags.RectOnly", "kind": "enum-value", "name": "RectOnly", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.RectOnly = 928", "description": "Uses the item or window rectangle while ignoring popup, active-item, and overlap blocking", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 192 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "928", "evaluated_value": 928, "generated": false }, { "id": "script.enum-value.ImGui_HoveredFlags.RootWindow", "family_id": "script.enum-value.ImGui_HoveredFlags.RootWindow", "kind": "enum-value", "name": "RootWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_HoveredFlags", "signature": "ImGui_HoveredFlags.RootWindow = 2", "description": "IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 182 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_HoveredFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.AutoSelectAll", "family_id": "script.enum-value.ImGui_InputTextFlags.AutoSelectAll", "kind": "enum-value", "name": "AutoSelectAll", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.AutoSelectAll = 4096", "description": "Select entire text when first taking mouse focus", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.CharsDecimal", "family_id": "script.enum-value.ImGui_InputTextFlags.CharsDecimal", "kind": "enum-value", "name": "CharsDecimal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.CharsDecimal = 1", "description": "Allow 0123456789.+-*/", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 339 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.CharsHexadecimal", "family_id": "script.enum-value.ImGui_InputTextFlags.CharsHexadecimal", "kind": "enum-value", "name": "CharsHexadecimal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.CharsHexadecimal = 2", "description": "Allow 0123456789ABCDEFabcdef", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 340 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.CharsNoBlank", "family_id": "script.enum-value.ImGui_InputTextFlags.CharsNoBlank", "kind": "enum-value", "name": "CharsNoBlank", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.CharsNoBlank = 16", "description": "Filter out spaces, tabs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 343 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.CharsScientific", "family_id": "script.enum-value.ImGui_InputTextFlags.CharsScientific", "kind": "enum-value", "name": "CharsScientific", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.CharsScientific = 4", "description": "Allow 0123456789.+-*/eE (Scientific notation input)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 341 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.CharsUppercase", "family_id": "script.enum-value.ImGui_InputTextFlags.CharsUppercase", "kind": "enum-value", "name": "CharsUppercase", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.CharsUppercase = 8", "description": "Turn a..z into A..Z", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 342 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.DisplayEmptyRefVal", "family_id": "script.enum-value.ImGui_InputTextFlags.DisplayEmptyRefVal", "kind": "enum-value", "name": "DisplayEmptyRefVal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.DisplayEmptyRefVal = 16384", "description": "InputFloat(), InputInt(), InputScalar() etc. only: when value is zero, do not display it. Generally used with ImGuiInputTextFlags_ParseEmptyRefVal", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 349 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "16384", "evaluated_value": 16384, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.EnterReturnsTrue", "family_id": "script.enum-value.ImGui_InputTextFlags.EnterReturnsTrue", "kind": "enum-value", "name": "EnterReturnsTrue", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.EnterReturnsTrue = 64", "description": "Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider disabling LiveEdit! or using IsItemDeactivatedAfterEdit() instead!", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 344 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.None", "family_id": "script.enum-value.ImGui_InputTextFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.None = 0", "description": "Applies no optional text-input behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 338 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.ParseEmptyRefVal", "family_id": "script.enum-value.ImGui_InputTextFlags.ParseEmptyRefVal", "kind": "enum-value", "name": "ParseEmptyRefVal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.ParseEmptyRefVal = 8192", "description": "InputFloat(), InputInt(), InputScalar() etc. only: parse empty string as zero value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 348 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "8192", "evaluated_value": 8192, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.Password", "family_id": "script.enum-value.ImGui_InputTextFlags.Password", "kind": "enum-value", "name": "Password", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.Password = 1024", "description": "Password mode, display all characters as '*', disable copy", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_InputTextFlags.ReadOnly", "family_id": "script.enum-value.ImGui_InputTextFlags.ReadOnly", "kind": "enum-value", "name": "ReadOnly", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_InputTextFlags", "signature": "ImGui_InputTextFlags.ReadOnly = 512", "description": "Read-only mode", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 345 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_InputTextFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_MouseButton.Left", "family_id": "script.enum-value.ImGui_MouseButton.Left", "kind": "enum-value", "name": "Left", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_MouseButton", "signature": "ImGui_MouseButton.Left = 0", "description": "Identifies the left mouse button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 372 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_MouseButton", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_MouseButton.Middle", "family_id": "script.enum-value.ImGui_MouseButton.Middle", "kind": "enum-value", "name": "Middle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_MouseButton", "signature": "ImGui_MouseButton.Middle = 2", "description": "Identifies the middle mouse button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 374 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_MouseButton", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_MouseButton.Right", "family_id": "script.enum-value.ImGui_MouseButton.Right", "kind": "enum-value", "name": "Right", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_MouseButton", "signature": "ImGui_MouseButton.Right = 1", "description": "Identifies the right mouse button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 373 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_MouseButton", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.AnyPopup", "family_id": "script.enum-value.ImGui_PopupFlags.AnyPopup", "kind": "enum-value", "name": "AnyPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.AnyPopup = 3072", "description": "Tests any popup identifier at any level of the popup stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "3072", "evaluated_value": 3072, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.AnyPopupId", "family_id": "script.enum-value.ImGui_PopupFlags.AnyPopupId", "kind": "enum-value", "name": "AnyPopupId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.AnyPopupId = 1024", "description": "For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 363 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.AnyPopupLevel", "family_id": "script.enum-value.ImGui_PopupFlags.AnyPopupLevel", "kind": "enum-value", "name": "AnyPopupLevel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.AnyPopupLevel = 2048", "description": "For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 364 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.MouseButtonLeft", "family_id": "script.enum-value.ImGui_PopupFlags.MouseButtonLeft", "kind": "enum-value", "name": "MouseButtonLeft", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.MouseButtonLeft = 4", "description": "For BeginPopupContext*(): open on Left Mouse release. Only one button allowed!", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 357 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.MouseButtonMiddle", "family_id": "script.enum-value.ImGui_PopupFlags.MouseButtonMiddle", "kind": "enum-value", "name": "MouseButtonMiddle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.MouseButtonMiddle = 12", "description": "For BeginPopupContext*(): open on Middle Mouse release. Only one button allowed!", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 359 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "12", "evaluated_value": 12, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.MouseButtonRight", "family_id": "script.enum-value.ImGui_PopupFlags.MouseButtonRight", "kind": "enum-value", "name": "MouseButtonRight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.MouseButtonRight = 8", "description": "For BeginPopupContext*(): open on Right Mouse release. Only one button allowed! (default)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 358 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.NoOpenOverExistingPopup", "family_id": "script.enum-value.ImGui_PopupFlags.NoOpenOverExistingPopup", "kind": "enum-value", "name": "NoOpenOverExistingPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.NoOpenOverExistingPopup = 128", "description": "For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 361 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.NoOpenOverItems", "family_id": "script.enum-value.ImGui_PopupFlags.NoOpenOverItems", "kind": "enum-value", "name": "NoOpenOverItems", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.NoOpenOverItems = 256", "description": "For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 362 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.NoReopen", "family_id": "script.enum-value.ImGui_PopupFlags.NoReopen", "kind": "enum-value", "name": "NoReopen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.NoReopen = 32", "description": "For OpenPopup*(), BeginPopupContext*(): don't reopen same popup if already open (won't reposition, won't reinitialize navigation)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 360 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_PopupFlags.None", "family_id": "script.enum-value.ImGui_PopupFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_PopupFlags", "signature": "ImGui_PopupFlags.None = 0", "description": "Applies the default popup mouse-button and stack-level behavior", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 356 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_PopupFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_SelectableFlags.AllowDoubleClick", "family_id": "script.enum-value.ImGui_SelectableFlags.AllowDoubleClick", "kind": "enum-value", "name": "AllowDoubleClick", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SelectableFlags", "signature": "ImGui_SelectableFlags.AllowDoubleClick = 4", "description": "Generate press events on double clicks too", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 136 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SelectableFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_SelectableFlags.AllowOverlap", "family_id": "script.enum-value.ImGui_SelectableFlags.AllowOverlap", "kind": "enum-value", "name": "AllowOverlap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SelectableFlags", "signature": "ImGui_SelectableFlags.AllowOverlap = 16", "description": "Hit testing will allow subsequent widgets to overlap this one. Require previous frame HoveredId to match before being usable. Shortcut to calling SetNextItemAllowOverlap()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SelectableFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_SelectableFlags.Disabled", "family_id": "script.enum-value.ImGui_SelectableFlags.Disabled", "kind": "enum-value", "name": "Disabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SelectableFlags", "signature": "ImGui_SelectableFlags.Disabled = 8", "description": "Cannot be selected, display grayed out text", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 137 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SelectableFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_SelectableFlags.NoAutoClosePopups", "family_id": "script.enum-value.ImGui_SelectableFlags.NoAutoClosePopups", "kind": "enum-value", "name": "NoAutoClosePopups", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SelectableFlags", "signature": "ImGui_SelectableFlags.NoAutoClosePopups = 1", "description": "Clicking this doesn't close parent popup window (overrides ImGuiItemFlags_AutoClosePopups)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 134 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SelectableFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_SelectableFlags.None", "family_id": "script.enum-value.ImGui_SelectableFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SelectableFlags", "signature": "ImGui_SelectableFlags.None = 0", "description": "Applies no optional selectable-item behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 133 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SelectableFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_SelectableFlags.SpanAllColumns", "family_id": "script.enum-value.ImGui_SelectableFlags.SpanAllColumns", "kind": "enum-value", "name": "SpanAllColumns", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SelectableFlags", "signature": "ImGui_SelectableFlags.SpanAllColumns = 2", "description": "Frame will span all columns of its container table (text will still fit in current column)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SelectableFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.AlwaysClamp", "family_id": "script.enum-value.ImGui_SliderFlags.AlwaysClamp", "kind": "enum-value", "name": "AlwaysClamp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.AlwaysClamp = 1536", "description": "Clamps manual input and also clamps a zero-width range where minimum and maximum are both zero", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 400 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "1536", "evaluated_value": 1536, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.ClampOnInput", "family_id": "script.enum-value.ImGui_SliderFlags.ClampOnInput", "kind": "enum-value", "name": "ClampOnInput", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.ClampOnInput = 512", "description": "Clamp value to min/max bounds when input manually with Ctrl+Click. By default Ctrl+Click allows going out of bounds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 397 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.ClampZeroRange", "family_id": "script.enum-value.ImGui_SliderFlags.ClampZeroRange", "kind": "enum-value", "name": "ClampZeroRange", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.ClampZeroRange = 1024", "description": "Clamp even if min==max==0.0f. Otherwise due to legacy reason DragXXX functions don't clamp with those values. When your clamping limits are dynamic you almost always want to use it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 398 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.Logarithmic", "family_id": "script.enum-value.ImGui_SliderFlags.Logarithmic", "kind": "enum-value", "name": "Logarithmic", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.Logarithmic = 32", "description": "Make the widget logarithmic (linear otherwise). Consider using ImGuiSliderFlags_NoRoundToFormat with this if using a format-string with small amount of digits", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 393 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.NoInput", "family_id": "script.enum-value.ImGui_SliderFlags.NoInput", "kind": "enum-value", "name": "NoInput", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.NoInput = 128", "description": "Disable Ctrl+Click or Enter key allowing to input text directly into the widget", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 395 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.NoRoundToFormat", "family_id": "script.enum-value.ImGui_SliderFlags.NoRoundToFormat", "kind": "enum-value", "name": "NoRoundToFormat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.NoRoundToFormat = 64", "description": "Disable rounding underlying value to match precision of the display format string (e.g. %.3f values are rounded to those 3 digits)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 394 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.NoSpeedTweaks", "family_id": "script.enum-value.ImGui_SliderFlags.NoSpeedTweaks", "kind": "enum-value", "name": "NoSpeedTweaks", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.NoSpeedTweaks = 2048", "description": "Disable keyboard modifiers altering tweak speed. Useful if you want to alter tweak speed yourself based on your own logic", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 399 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.None", "family_id": "script.enum-value.ImGui_SliderFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.None = 0", "description": "Applies no optional slider or drag-control behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 392 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_SliderFlags.WrapAround", "family_id": "script.enum-value.ImGui_SliderFlags.WrapAround", "kind": "enum-value", "name": "WrapAround", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_SliderFlags", "signature": "ImGui_SliderFlags.WrapAround = 256", "description": "Enable wrapping around from max to min and from min to max. Only supported by DragXXX() functions for now", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 396 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_SliderFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.Alpha", "family_id": "script.enum-value.ImGui_StyleVar.Alpha", "kind": "enum-value", "name": "Alpha", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.Alpha = 0", "description": "Global alpha applies to everything in Dear ImGui", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 493 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.ButtonTextAlign", "family_id": "script.enum-value.ImGui_StyleVar.ButtonTextAlign", "kind": "enum-value", "name": "ButtonTextAlign", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.ButtonTextAlign = 38", "description": "Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 510 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "38", "evaluated_value": 38, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.CellPadding", "family_id": "script.enum-value.ImGui_StyleVar.CellPadding", "kind": "enum-value", "name": "CellPadding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.CellPadding = 17", "description": "Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 504 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "17", "evaluated_value": 17, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.DisabledAlpha", "family_id": "script.enum-value.ImGui_StyleVar.DisabledAlpha", "kind": "enum-value", "name": "DisabledAlpha", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.DisabledAlpha = 1", "description": "Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 494 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.FrameBorderSize", "family_id": "script.enum-value.ImGui_StyleVar.FrameBorderSize", "kind": "enum-value", "name": "FrameBorderSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.FrameBorderSize = 13", "description": "Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 500 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "13", "evaluated_value": 13, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.FramePadding", "family_id": "script.enum-value.ImGui_StyleVar.FramePadding", "kind": "enum-value", "name": "FramePadding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.FramePadding = 11", "description": "Padding within a framed rectangle (used by most widgets)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 498 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "11", "evaluated_value": 11, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.FrameRounding", "family_id": "script.enum-value.ImGui_StyleVar.FrameRounding", "kind": "enum-value", "name": "FrameRounding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.FrameRounding = 12", "description": "Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 499 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "12", "evaluated_value": 12, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.GrabMinSize", "family_id": "script.enum-value.ImGui_StyleVar.GrabMinSize", "kind": "enum-value", "name": "GrabMinSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.GrabMinSize = 21", "description": "Minimum width/height of a grab box for slider/scrollbar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 507 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "21", "evaluated_value": 21, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.GrabRounding", "family_id": "script.enum-value.ImGui_StyleVar.GrabRounding", "kind": "enum-value", "name": "GrabRounding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.GrabRounding = 22", "description": "Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 508 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "22", "evaluated_value": 22, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.IndentSpacing", "family_id": "script.enum-value.ImGui_StyleVar.IndentSpacing", "kind": "enum-value", "name": "IndentSpacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.IndentSpacing = 16", "description": "Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 503 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.ItemInnerSpacing", "family_id": "script.enum-value.ImGui_StyleVar.ItemInnerSpacing", "kind": "enum-value", "name": "ItemInnerSpacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.ItemInnerSpacing = 15", "description": "Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 502 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "15", "evaluated_value": 15, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.ItemSpacing", "family_id": "script.enum-value.ImGui_StyleVar.ItemSpacing", "kind": "enum-value", "name": "ItemSpacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.ItemSpacing = 14", "description": "Horizontal and vertical spacing between widgets/lines", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 501 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "14", "evaluated_value": 14, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.ScrollbarRounding", "family_id": "script.enum-value.ImGui_StyleVar.ScrollbarRounding", "kind": "enum-value", "name": "ScrollbarRounding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.ScrollbarRounding = 19", "description": "Radius of grab corners for scrollbar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 506 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "19", "evaluated_value": 19, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.ScrollbarSize", "family_id": "script.enum-value.ImGui_StyleVar.ScrollbarSize", "kind": "enum-value", "name": "ScrollbarSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.ScrollbarSize = 18", "description": "Width of the vertical scrollbar, Height of the horizontal scrollbar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 505 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "18", "evaluated_value": 18, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.SelectableTextAlign", "family_id": "script.enum-value.ImGui_StyleVar.SelectableTextAlign", "kind": "enum-value", "name": "SelectableTextAlign", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.SelectableTextAlign = 39", "description": "Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 511 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "39", "evaluated_value": 39, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.TabRounding", "family_id": "script.enum-value.ImGui_StyleVar.TabRounding", "kind": "enum-value", "name": "TabRounding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.TabRounding = 25", "description": "Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 509 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "25", "evaluated_value": 25, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.WindowBorderSize", "family_id": "script.enum-value.ImGui_StyleVar.WindowBorderSize", "kind": "enum-value", "name": "WindowBorderSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.WindowBorderSize = 4", "description": "Thickness of border around windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 497 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.WindowPadding", "family_id": "script.enum-value.ImGui_StyleVar.WindowPadding", "kind": "enum-value", "name": "WindowPadding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.WindowPadding = 2", "description": "Padding within a window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 495 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_StyleVar.WindowRounding", "family_id": "script.enum-value.ImGui_StyleVar.WindowRounding", "kind": "enum-value", "name": "WindowRounding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_StyleVar", "signature": "ImGui_StyleVar.WindowRounding = 3", "description": "Radius of window corners rounding. Set to 0.0f to have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 496 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_StyleVar", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.AutoSelectNewTabs", "family_id": "script.enum-value.ImGui_TabBarFlags.AutoSelectNewTabs", "kind": "enum-value", "name": "AutoSelectNewTabs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.AutoSelectNewTabs = 2", "description": "Automatically select new tabs when they appear", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 292 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.DrawSelectedOverline", "family_id": "script.enum-value.ImGui_TabBarFlags.DrawSelectedOverline", "kind": "enum-value", "name": "DrawSelectedOverline", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.DrawSelectedOverline = 64", "description": "Draw selected overline markers over selected tab", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 297 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.FittingPolicyMixed", "family_id": "script.enum-value.ImGui_TabBarFlags.FittingPolicyMixed", "kind": "enum-value", "name": "FittingPolicyMixed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.FittingPolicyMixed = 128", "description": "Shrink down tabs when they don't fit, until width is style.TabMinWidthShrink, then enable scrolling. Setting TabMinWidthShrink to FLT_MAX makes this behave like ImGuiTabBarFlags_FittingPolicyScroll", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.FittingPolicyScroll", "family_id": "script.enum-value.ImGui_TabBarFlags.FittingPolicyScroll", "kind": "enum-value", "name": "FittingPolicyScroll", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.FittingPolicyScroll = 512", "description": "Enable scrolling buttons when tabs don't fit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 300 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.FittingPolicyShrink", "family_id": "script.enum-value.ImGui_TabBarFlags.FittingPolicyShrink", "kind": "enum-value", "name": "FittingPolicyShrink", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.FittingPolicyShrink = 256", "description": "Shrink down tabs when they don't fit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 299 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.NoCloseWithMiddleMouseButton", "family_id": "script.enum-value.ImGui_TabBarFlags.NoCloseWithMiddleMouseButton", "kind": "enum-value", "name": "NoCloseWithMiddleMouseButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.NoCloseWithMiddleMouseButton = 8", "description": "Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 294 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.NoTabListScrollingButtons", "family_id": "script.enum-value.ImGui_TabBarFlags.NoTabListScrollingButtons", "kind": "enum-value", "name": "NoTabListScrollingButtons", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.NoTabListScrollingButtons = 16", "description": "Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 295 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.NoTooltip", "family_id": "script.enum-value.ImGui_TabBarFlags.NoTooltip", "kind": "enum-value", "name": "NoTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.NoTooltip = 32", "description": "Disable tooltips when hovering a tab", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 296 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.None", "family_id": "script.enum-value.ImGui_TabBarFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.None = 0", "description": "Applies no optional tab-bar behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 290 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.Reorderable", "family_id": "script.enum-value.ImGui_TabBarFlags.Reorderable", "kind": "enum-value", "name": "Reorderable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.Reorderable = 1", "description": "Allow manually dragging tabs to re-order them + New tabs are appended at the end of list", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 291 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TabBarFlags.TabListPopupButton", "family_id": "script.enum-value.ImGui_TabBarFlags.TabListPopupButton", "kind": "enum-value", "name": "TabListPopupButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabBarFlags", "signature": "ImGui_TabBarFlags.TabListPopupButton = 4", "description": "Shows a button that opens the tab-list popup and lets the user select a tab", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 293 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabBarFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.Leading", "family_id": "script.enum-value.ImGui_TabItemFlags.Leading", "kind": "enum-value", "name": "Leading", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.Leading = 64", "description": "Enforce the tab position to the left of the tab bar (after the tab list popup button)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 314 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.NoAssumedClosure", "family_id": "script.enum-value.ImGui_TabItemFlags.NoAssumedClosure", "kind": "enum-value", "name": "NoAssumedClosure", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.NoAssumedClosure = 256", "description": "Tab is selected when trying to close + closure is not immediately assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 316 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.NoCloseWithMiddleMouseButton", "family_id": "script.enum-value.ImGui_TabItemFlags.NoCloseWithMiddleMouseButton", "kind": "enum-value", "name": "NoCloseWithMiddleMouseButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.NoCloseWithMiddleMouseButton = 4", "description": "Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 310 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.NoPushId", "family_id": "script.enum-value.ImGui_TabItemFlags.NoPushId", "kind": "enum-value", "name": "NoPushId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.NoPushId = 8", "description": "Don't call PushID()/PopID() on BeginTabItem()/EndTabItem()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 311 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.NoReorder", "family_id": "script.enum-value.ImGui_TabItemFlags.NoReorder", "kind": "enum-value", "name": "NoReorder", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.NoReorder = 32", "description": "Disable reordering this tab or having another tab cross over this tab", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 313 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.NoTooltip", "family_id": "script.enum-value.ImGui_TabItemFlags.NoTooltip", "kind": "enum-value", "name": "NoTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.NoTooltip = 16", "description": "Disable tooltip for the given tab", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 312 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.None", "family_id": "script.enum-value.ImGui_TabItemFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.None = 0", "description": "Applies no optional tab-item behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 307 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.SetSelected", "family_id": "script.enum-value.ImGui_TabItemFlags.SetSelected", "kind": "enum-value", "name": "SetSelected", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.SetSelected = 2", "description": "Trigger flag to programmatically make the tab selected when calling BeginTabItem()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 309 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.Trailing", "family_id": "script.enum-value.ImGui_TabItemFlags.Trailing", "kind": "enum-value", "name": "Trailing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.Trailing = 128", "description": "Enforce the tab position to the right of the tab bar (before the scrolling buttons)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 315 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_TabItemFlags.UnsavedDocument", "family_id": "script.enum-value.ImGui_TabItemFlags.UnsavedDocument", "kind": "enum-value", "name": "UnsavedDocument", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TabItemFlags", "signature": "ImGui_TabItemFlags.UnsavedDocument = 1", "description": "Display a dot next to the title + set ImGuiTabItemFlags_NoAssumedClosure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 308 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TabItemFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TableBgTarget.CellBg", "family_id": "script.enum-value.ImGui_TableBgTarget.CellBg", "kind": "enum-value", "name": "CellBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableBgTarget", "signature": "ImGui_TableBgTarget.CellBg = 3", "description": "Set cell background color (top-most color)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 283 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableBgTarget", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.ImGui_TableBgTarget.None", "family_id": "script.enum-value.ImGui_TableBgTarget.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableBgTarget", "signature": "ImGui_TableBgTarget.None = 0", "description": "Selects no table background color target", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 280 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableBgTarget", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TableBgTarget.RowBg0", "family_id": "script.enum-value.ImGui_TableBgTarget.RowBg0", "kind": "enum-value", "name": "RowBg0", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableBgTarget", "signature": "ImGui_TableBgTarget.RowBg0 = 1", "description": "Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 281 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableBgTarget", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TableBgTarget.RowBg1", "family_id": "script.enum-value.ImGui_TableBgTarget.RowBg1", "kind": "enum-value", "name": "RowBg1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableBgTarget", "signature": "ImGui_TableBgTarget.RowBg1 = 2", "description": "Set row background color 1 (generally used for selection marking)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableBgTarget", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.AngledHeader", "family_id": "script.enum-value.ImGui_TableColumnFlags.AngledHeader", "kind": "enum-value", "name": "AngledHeader", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.AngledHeader = 262144", "description": "TableHeadersRow() will submit an angled header row for this column. Note this will add an extra row", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "262144", "evaluated_value": 262144, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.DefaultHide", "family_id": "script.enum-value.ImGui_TableColumnFlags.DefaultHide", "kind": "enum-value", "name": "DefaultHide", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.DefaultHide = 2", "description": "Default as a hidden/disabled column", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 244 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.DefaultSort", "family_id": "script.enum-value.ImGui_TableColumnFlags.DefaultSort", "kind": "enum-value", "name": "DefaultSort", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.DefaultSort = 4", "description": "Default as a sorting column", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 245 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.Disabled", "family_id": "script.enum-value.ImGui_TableColumnFlags.Disabled", "kind": "enum-value", "name": "Disabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.Disabled = 1", "description": "Overriding/master disable flag: hide column, won't show in context menu (unlike calling TableSetColumnEnabled() which manipulates the user accessible state)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 243 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.IndentDisable", "family_id": "script.enum-value.ImGui_TableColumnFlags.IndentDisable", "kind": "enum-value", "name": "IndentDisable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.IndentDisable = 131072", "description": "Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 260 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "131072", "evaluated_value": 131072, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.IndentEnable", "family_id": "script.enum-value.ImGui_TableColumnFlags.IndentEnable", "kind": "enum-value", "name": "IndentEnable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.IndentEnable = 65536", "description": "Use current Indent value when entering cell (default for column 0)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 259 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "65536", "evaluated_value": 65536, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.IsEnabled", "family_id": "script.enum-value.ImGui_TableColumnFlags.IsEnabled", "kind": "enum-value", "name": "IsEnabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.IsEnabled = 16777216", "description": "Status: is enabled == not hidden by user/api (referred to as \"Hide\" in _DefaultHide and _NoHide) flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 262 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "16777216", "evaluated_value": 16777216, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.IsHovered", "family_id": "script.enum-value.ImGui_TableColumnFlags.IsHovered", "kind": "enum-value", "name": "IsHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.IsHovered = 134217728", "description": "Status: is hovered by mouse", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 265 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "134217728", "evaluated_value": 134217728, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.IsSorted", "family_id": "script.enum-value.ImGui_TableColumnFlags.IsSorted", "kind": "enum-value", "name": "IsSorted", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.IsSorted = 67108864", "description": "Status: is currently part of the sort specs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 264 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "67108864", "evaluated_value": 67108864, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.IsVisible", "family_id": "script.enum-value.ImGui_TableColumnFlags.IsVisible", "kind": "enum-value", "name": "IsVisible", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.IsVisible = 33554432", "description": "Status: is visible == is enabled AND not clipped by scrolling", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 263 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "33554432", "evaluated_value": 33554432, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoClip", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoClip", "kind": "enum-value", "name": "NoClip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoClip = 256", "description": "Disable clipping for this column (all NoClip columns will render in a same draw command)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 251 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoHeaderLabel", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoHeaderLabel", "kind": "enum-value", "name": "NoHeaderLabel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoHeaderLabel = 4096", "description": "TableHeadersRow() will submit an empty label for this column. Convenient for some small columns. Name will still appear in context menu or in angled headers. You may append into this cell by calling TableSetColumnIndex() right after the TableHeadersRow() call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 255 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoHeaderWidth", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoHeaderWidth", "kind": "enum-value", "name": "NoHeaderWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoHeaderWidth = 8192", "description": "Disable header text width contribution to automatic column width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "8192", "evaluated_value": 8192, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoHide", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoHide", "kind": "enum-value", "name": "NoHide", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoHide = 128", "description": "Disable ability to hide/disable this column", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 250 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoReorder", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoReorder", "kind": "enum-value", "name": "NoReorder", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoReorder = 64", "description": "Disable manual reordering this column, this will also prevent other columns from crossing over this column", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 249 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoResize", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoResize", "kind": "enum-value", "name": "NoResize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoResize = 32", "description": "Disable manual resizing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 248 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoSort", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoSort", "kind": "enum-value", "name": "NoSort", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoSort = 512", "description": "Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 252 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoSortAscending", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoSortAscending", "kind": "enum-value", "name": "NoSortAscending", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoSortAscending = 1024", "description": "Disable ability to sort in the ascending direction", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 253 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.NoSortDescending", "family_id": "script.enum-value.ImGui_TableColumnFlags.NoSortDescending", "kind": "enum-value", "name": "NoSortDescending", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.NoSortDescending = 2048", "description": "Disable ability to sort in the descending direction", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.None", "family_id": "script.enum-value.ImGui_TableColumnFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.None = 0", "description": "Applies no optional table-column behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 242 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.PreferSortAscending", "family_id": "script.enum-value.ImGui_TableColumnFlags.PreferSortAscending", "kind": "enum-value", "name": "PreferSortAscending", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.PreferSortAscending = 16384", "description": "Make the initial sort direction Ascending when first sorting on this column (default)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 257 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "16384", "evaluated_value": 16384, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.PreferSortDescending", "family_id": "script.enum-value.ImGui_TableColumnFlags.PreferSortDescending", "kind": "enum-value", "name": "PreferSortDescending", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.PreferSortDescending = 32768", "description": "Make the initial sort direction Descending when first sorting on this column", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 258 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "32768", "evaluated_value": 32768, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.WidthFixed", "family_id": "script.enum-value.ImGui_TableColumnFlags.WidthFixed", "kind": "enum-value", "name": "WidthFixed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.WidthFixed = 16", "description": "Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 247 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_TableColumnFlags.WidthStretch", "family_id": "script.enum-value.ImGui_TableColumnFlags.WidthStretch", "kind": "enum-value", "name": "WidthStretch", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableColumnFlags", "signature": "ImGui_TableColumnFlags.WidthStretch = 8", "description": "Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 246 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableColumnFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.Borders", "family_id": "script.enum-value.ImGui_TableFlags.Borders", "kind": "enum-value", "name": "Borders", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.Borders = 1920", "description": "Draw all borders", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 216 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "1920", "evaluated_value": 1920, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersH", "family_id": "script.enum-value.ImGui_TableFlags.BordersH", "kind": "enum-value", "name": "BordersH", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersH = 384", "description": "Draw horizontal borders", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "384", "evaluated_value": 384, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersInner", "family_id": "script.enum-value.ImGui_TableFlags.BordersInner", "kind": "enum-value", "name": "BordersInner", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersInner = 640", "description": "Draw inner borders", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 214 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "640", "evaluated_value": 640, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersInnerH", "family_id": "script.enum-value.ImGui_TableFlags.BordersInnerH", "kind": "enum-value", "name": "BordersInnerH", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersInnerH = 128", "description": "Draw horizontal borders between rows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 208 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersInnerV", "family_id": "script.enum-value.ImGui_TableFlags.BordersInnerV", "kind": "enum-value", "name": "BordersInnerV", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersInnerV = 512", "description": "Draw vertical borders between columns", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersOuter", "family_id": "script.enum-value.ImGui_TableFlags.BordersOuter", "kind": "enum-value", "name": "BordersOuter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersOuter = 1280", "description": "Draw outer borders", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 215 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "1280", "evaluated_value": 1280, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersOuterH", "family_id": "script.enum-value.ImGui_TableFlags.BordersOuterH", "kind": "enum-value", "name": "BordersOuterH", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersOuterH = 256", "description": "Draw horizontal borders at the top and bottom", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 209 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersOuterV", "family_id": "script.enum-value.ImGui_TableFlags.BordersOuterV", "kind": "enum-value", "name": "BordersOuterV", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersOuterV = 1024", "description": "Draw vertical borders on the left and right sides", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 211 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.BordersV", "family_id": "script.enum-value.ImGui_TableFlags.BordersV", "kind": "enum-value", "name": "BordersV", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.BordersV = 1536", "description": "Draw vertical borders", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 213 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "1536", "evaluated_value": 1536, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.ContextMenuInBody", "family_id": "script.enum-value.ImGui_TableFlags.ContextMenuInBody", "kind": "enum-value", "name": "ContextMenuInBody", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.ContextMenuInBody = 32", "description": "Right-click on columns body/contents will also display table context menu. By default it is available in TableHeadersRow()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 206 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.Hideable", "family_id": "script.enum-value.ImGui_TableFlags.Hideable", "kind": "enum-value", "name": "Hideable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.Hideable = 4", "description": "Enable hiding/disabling columns in context menu", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.HighlightHoveredColumn", "family_id": "script.enum-value.ImGui_TableFlags.HighlightHoveredColumn", "kind": "enum-value", "name": "HighlightHoveredColumn", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.HighlightHoveredColumn = 268435456", "description": "Highlight column headers when hovered (may evolve into a fuller highlight)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 235 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "268435456", "evaluated_value": 268435456, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoBordersInBody", "family_id": "script.enum-value.ImGui_TableFlags.NoBordersInBody", "kind": "enum-value", "name": "NoBordersInBody", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoBordersInBody = 2048", "description": "[ALPHA] Disable vertical borders in columns Body (borders will always appear in Headers). -> May move to style", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 217 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoBordersInBodyUntilResize", "family_id": "script.enum-value.ImGui_TableFlags.NoBordersInBodyUntilResize", "kind": "enum-value", "name": "NoBordersInBodyUntilResize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoBordersInBodyUntilResize = 4096", "description": "[ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appear in Headers). -> May move to style", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 218 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoClip", "family_id": "script.enum-value.ImGui_TableFlags.NoClip", "kind": "enum-value", "name": "NoClip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoClip = 1048576", "description": "Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 227 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "1048576", "evaluated_value": 1048576, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoHostExtendX", "family_id": "script.enum-value.ImGui_TableFlags.NoHostExtendX", "kind": "enum-value", "name": "NoHostExtendX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoHostExtendX = 65536", "description": "Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 223 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "65536", "evaluated_value": 65536, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoHostExtendY", "family_id": "script.enum-value.ImGui_TableFlags.NoHostExtendY", "kind": "enum-value", "name": "NoHostExtendY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoHostExtendY = 131072", "description": "Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 224 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "131072", "evaluated_value": 131072, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoKeepColumnsVisible", "family_id": "script.enum-value.ImGui_TableFlags.NoKeepColumnsVisible", "kind": "enum-value", "name": "NoKeepColumnsVisible", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoKeepColumnsVisible = 262144", "description": "Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 225 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "262144", "evaluated_value": 262144, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoPadInnerX", "family_id": "script.enum-value.ImGui_TableFlags.NoPadInnerX", "kind": "enum-value", "name": "NoPadInnerX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoPadInnerX = 8388608", "description": "Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "8388608", "evaluated_value": 8388608, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoPadOuterX", "family_id": "script.enum-value.ImGui_TableFlags.NoPadOuterX", "kind": "enum-value", "name": "NoPadOuterX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoPadOuterX = 4194304", "description": "Default if BordersOuterV is off. Disable outermost padding", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 229 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "4194304", "evaluated_value": 4194304, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.NoSavedSettings", "family_id": "script.enum-value.ImGui_TableFlags.NoSavedSettings", "kind": "enum-value", "name": "NoSavedSettings", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.NoSavedSettings = 16", "description": "Disable persisting columns order, width, visibility and sort settings in the .ini file", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 205 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.None", "family_id": "script.enum-value.ImGui_TableFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.None = 0", "description": "Applies no optional table behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 200 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.PadOuterX", "family_id": "script.enum-value.ImGui_TableFlags.PadOuterX", "kind": "enum-value", "name": "PadOuterX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.PadOuterX = 2097152", "description": "Default if BordersOuterV is on. Enable outermost padding. Generally desirable if you have headers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 228 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "2097152", "evaluated_value": 2097152, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.PreciseWidths", "family_id": "script.enum-value.ImGui_TableFlags.PreciseWidths", "kind": "enum-value", "name": "PreciseWidths", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.PreciseWidths = 524288", "description": "Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 226 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "524288", "evaluated_value": 524288, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.Reorderable", "family_id": "script.enum-value.ImGui_TableFlags.Reorderable", "kind": "enum-value", "name": "Reorderable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.Reorderable = 2", "description": "Enable reordering columns in header row. (Need calling TableSetupColumn() + TableHeadersRow() to display headers, or using ImGuiTableFlags_ContextMenuInBody to access context-menu without headers)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 202 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.Resizable", "family_id": "script.enum-value.ImGui_TableFlags.Resizable", "kind": "enum-value", "name": "Resizable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.Resizable = 1", "description": "Enable resizing columns", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 201 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.RowBg", "family_id": "script.enum-value.ImGui_TableFlags.RowBg", "kind": "enum-value", "name": "RowBg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.RowBg = 64", "description": "Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 207 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.ScrollX", "family_id": "script.enum-value.ImGui_TableFlags.ScrollX", "kind": "enum-value", "name": "ScrollX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.ScrollX = 16777216", "description": "Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this creates a child window, ScrollY is currently generally recommended when using ScrollX", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 231 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "16777216", "evaluated_value": 16777216, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.ScrollY", "family_id": "script.enum-value.ImGui_TableFlags.ScrollY", "kind": "enum-value", "name": "ScrollY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.ScrollY = 33554432", "description": "Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 232 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "33554432", "evaluated_value": 33554432, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.SizingFixedFit", "family_id": "script.enum-value.ImGui_TableFlags.SizingFixedFit", "kind": "enum-value", "name": "SizingFixedFit", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.SizingFixedFit = 8192", "description": "Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 219 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "8192", "evaluated_value": 8192, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.SizingFixedSame", "family_id": "script.enum-value.ImGui_TableFlags.SizingFixedSame", "kind": "enum-value", "name": "SizingFixedSame", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.SizingFixedSame = 16384", "description": "Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 220 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "16384", "evaluated_value": 16384, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.SizingStretchProp", "family_id": "script.enum-value.ImGui_TableFlags.SizingStretchProp", "kind": "enum-value", "name": "SizingStretchProp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.SizingStretchProp = 24576", "description": "Columns default to _WidthStretch with default weights proportional to each columns contents widths", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 221 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "24576", "evaluated_value": 24576, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.SizingStretchSame", "family_id": "script.enum-value.ImGui_TableFlags.SizingStretchSame", "kind": "enum-value", "name": "SizingStretchSame", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.SizingStretchSame = 32768", "description": "Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 222 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "32768", "evaluated_value": 32768, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.SortMulti", "family_id": "script.enum-value.ImGui_TableFlags.SortMulti", "kind": "enum-value", "name": "SortMulti", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.SortMulti = 67108864", "description": "Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 233 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "67108864", "evaluated_value": 67108864, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.SortTristate", "family_id": "script.enum-value.ImGui_TableFlags.SortTristate", "kind": "enum-value", "name": "SortTristate", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.SortTristate = 134217728", "description": "Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 234 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "134217728", "evaluated_value": 134217728, "generated": false }, { "id": "script.enum-value.ImGui_TableFlags.Sortable", "family_id": "script.enum-value.ImGui_TableFlags.Sortable", "kind": "enum-value", "name": "Sortable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableFlags", "signature": "ImGui_TableFlags.Sortable = 8", "description": "Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 204 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_TableRowFlags.Headers", "family_id": "script.enum-value.ImGui_TableRowFlags.Headers", "kind": "enum-value", "name": "Headers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableRowFlags", "signature": "ImGui_TableRowFlags.Headers = 1", "description": "Identify header row (set default background color + width of its contents accounted differently for auto column width)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 273 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableRowFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TableRowFlags.None", "family_id": "script.enum-value.ImGui_TableRowFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TableRowFlags", "signature": "ImGui_TableRowFlags.None = 0", "description": "Applies no optional table-row behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 272 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TableRowFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.AllowOverlap", "family_id": "script.enum-value.ImGui_TreeNodeFlags.AllowOverlap", "kind": "enum-value", "name": "AllowOverlap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.AllowOverlap = 4", "description": "Hit testing will allow subsequent widgets to overlap this one. Require previous frame HoveredId to match before being usable. Shortcut to calling SetNextItemAllowOverlap()", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 148 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.Bullet", "family_id": "script.enum-value.ImGui_TreeNodeFlags.Bullet", "kind": "enum-value", "name": "Bullet", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.Bullet = 512", "description": "Display a bullet instead of arrow. IMPORTANT: node can still be marked open/close if you don't set the _Leaf flag!", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 155 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.CollapsingHeader", "family_id": "script.enum-value.ImGui_TreeNodeFlags.CollapsingHeader", "kind": "enum-value", "name": "CollapsingHeader", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.CollapsingHeader = 26", "description": "Combines framing with no tree-stack push and no automatic opening during logging", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 161 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "26", "evaluated_value": 26, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.DefaultOpen", "family_id": "script.enum-value.ImGui_TreeNodeFlags.DefaultOpen", "kind": "enum-value", "name": "DefaultOpen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.DefaultOpen = 32", "description": "Default node to be open", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.FramePadding", "family_id": "script.enum-value.ImGui_TreeNodeFlags.FramePadding", "kind": "enum-value", "name": "FramePadding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.FramePadding = 1024", "description": "Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding() before the node", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.Framed", "family_id": "script.enum-value.ImGui_TreeNodeFlags.Framed", "kind": "enum-value", "name": "Framed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.Framed = 2", "description": "Draw frame with background (e.g. for CollapsingHeader)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 147 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.Leaf", "family_id": "script.enum-value.ImGui_TreeNodeFlags.Leaf", "kind": "enum-value", "name": "Leaf", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.Leaf = 256", "description": "No collapsing, no arrow (use as a convenience for leaf nodes). Note: will always open a tree/id scope and return true. If you never use that scope, add ImGuiTreeNodeFlags_NoTreePushOnOpen", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 154 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.NoAutoOpenOnLog", "family_id": "script.enum-value.ImGui_TreeNodeFlags.NoAutoOpenOnLog", "kind": "enum-value", "name": "NoAutoOpenOnLog", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.NoAutoOpenOnLog = 16", "description": "Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 150 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.NoTreePushOnOpen", "family_id": "script.enum-value.ImGui_TreeNodeFlags.NoTreePushOnOpen", "kind": "enum-value", "name": "NoTreePushOnOpen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.NoTreePushOnOpen = 8", "description": "Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 149 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.None", "family_id": "script.enum-value.ImGui_TreeNodeFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.None = 0", "description": "Applies no optional tree-node behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 145 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.OpenOnArrow", "family_id": "script.enum-value.ImGui_TreeNodeFlags.OpenOnArrow", "kind": "enum-value", "name": "OpenOnArrow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.OpenOnArrow = 128", "description": "Open when clicking on the arrow part (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 153 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.OpenOnDoubleClick", "family_id": "script.enum-value.ImGui_TreeNodeFlags.OpenOnDoubleClick", "kind": "enum-value", "name": "OpenOnDoubleClick", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.OpenOnDoubleClick = 64", "description": "Open on double-click instead of simple click (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 152 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.Selected", "family_id": "script.enum-value.ImGui_TreeNodeFlags.Selected", "kind": "enum-value", "name": "Selected", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.Selected = 1", "description": "Draw as selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 146 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.SpanAllColumns", "family_id": "script.enum-value.ImGui_TreeNodeFlags.SpanAllColumns", "kind": "enum-value", "name": "SpanAllColumns", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.SpanAllColumns = 16384", "description": "Frame will span all columns of its container table (label will still fit in current column)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "16384", "evaluated_value": 16384, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.SpanAvailWidth", "family_id": "script.enum-value.ImGui_TreeNodeFlags.SpanAvailWidth", "kind": "enum-value", "name": "SpanAvailWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.SpanAvailWidth = 2048", "description": "Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line without using AllowOverlap mode", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 157 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.SpanFullWidth", "family_id": "script.enum-value.ImGui_TreeNodeFlags.SpanFullWidth", "kind": "enum-value", "name": "SpanFullWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.SpanFullWidth = 4096", "description": "Extend hit box to the left-most and right-most edges (cover the indent area)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 158 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_TreeNodeFlags.SpanLabelWidth", "family_id": "script.enum-value.ImGui_TreeNodeFlags.SpanLabelWidth", "kind": "enum-value", "name": "SpanLabelWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_TreeNodeFlags", "signature": "ImGui_TreeNodeFlags.SpanLabelWidth = 8192", "description": "Narrow hit box + narrow hovering highlight, will only cover the label text", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 159 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_TreeNodeFlags", "value": "8192", "evaluated_value": 8192, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.AlwaysAutoResize", "family_id": "script.enum-value.ImGui_WindowFlags.AlwaysAutoResize", "kind": "enum-value", "name": "AlwaysAutoResize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.AlwaysAutoResize = 64", "description": "Resize every window to its content every frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 84 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "64", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.AlwaysHorizontalScrollbar", "family_id": "script.enum-value.ImGui_WindowFlags.AlwaysHorizontalScrollbar", "kind": "enum-value", "name": "AlwaysHorizontalScrollbar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.AlwaysHorizontalScrollbar = 32768", "description": "Always show horizontal scrollbar (even if ContentSize.x < Size.x)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "32768", "evaluated_value": 32768, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.AlwaysVerticalScrollbar", "family_id": "script.enum-value.ImGui_WindowFlags.AlwaysVerticalScrollbar", "kind": "enum-value", "name": "AlwaysVerticalScrollbar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.AlwaysVerticalScrollbar = 16384", "description": "Always show vertical scrollbar (even if ContentSize.y < Size.y)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "16384", "evaluated_value": 16384, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.HorizontalScrollbar", "family_id": "script.enum-value.ImGui_WindowFlags.HorizontalScrollbar", "kind": "enum-value", "name": "HorizontalScrollbar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.HorizontalScrollbar = 2048", "description": "Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the \"Horizontal Scrolling\" section", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "2048", "evaluated_value": 2048, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.MenuBar", "family_id": "script.enum-value.ImGui_WindowFlags.MenuBar", "kind": "enum-value", "name": "MenuBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.MenuBar = 1024", "description": "Has a menu-bar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "1024", "evaluated_value": 1024, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoBackground", "family_id": "script.enum-value.ImGui_WindowFlags.NoBackground", "kind": "enum-value", "name": "NoBackground", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoBackground = 128", "description": "Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "128", "evaluated_value": 128, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoBringToFrontOnFocus", "family_id": "script.enum-value.ImGui_WindowFlags.NoBringToFrontOnFocus", "kind": "enum-value", "name": "NoBringToFrontOnFocus", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoBringToFrontOnFocus = 8192", "description": "Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 91 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "8192", "evaluated_value": 8192, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoCollapse", "family_id": "script.enum-value.ImGui_WindowFlags.NoCollapse", "kind": "enum-value", "name": "NoCollapse", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoCollapse = 32", "description": "Disable user collapsing window by double-clicking on it. Also referred to as Window Menu Button (e.g. within a docking node)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 83 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "32", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoDecoration", "family_id": "script.enum-value.ImGui_WindowFlags.NoDecoration", "kind": "enum-value", "name": "NoDecoration", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoDecoration = 43", "description": "Disables the title bar, resizing, scrollbars, and collapsing controls", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 98 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "43", "evaluated_value": 43, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoFocusOnAppearing", "family_id": "script.enum-value.ImGui_WindowFlags.NoFocusOnAppearing", "kind": "enum-value", "name": "NoFocusOnAppearing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoFocusOnAppearing = 4096", "description": "Disable taking focus when transitioning from hidden to visible state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 90 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "4096", "evaluated_value": 4096, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoInputs", "family_id": "script.enum-value.ImGui_WindowFlags.NoInputs", "kind": "enum-value", "name": "NoInputs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoInputs = 197120", "description": "Disables mouse input, navigation input, and navigation focus for the window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "197120", "evaluated_value": 197120, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoMouseInputs", "family_id": "script.enum-value.ImGui_WindowFlags.NoMouseInputs", "kind": "enum-value", "name": "NoMouseInputs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoMouseInputs = 512", "description": "Disable catching mouse, hovering test with pass through", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 87 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "512", "evaluated_value": 512, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoMove", "family_id": "script.enum-value.ImGui_WindowFlags.NoMove", "kind": "enum-value", "name": "NoMove", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoMove = 4", "description": "Disable user moving the window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 80 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoNav", "family_id": "script.enum-value.ImGui_WindowFlags.NoNav", "kind": "enum-value", "name": "NoNav", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoNav = 196608", "description": "Disables both navigation input within the window and navigation focus toward it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 97 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "196608", "evaluated_value": 196608, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoNavFocus", "family_id": "script.enum-value.ImGui_WindowFlags.NoNavFocus", "kind": "enum-value", "name": "NoNavFocus", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoNavFocus = 131072", "description": "No focusing toward this window with keyboard/gamepad navigation (e.g. skipped by Ctrl+Tab)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 95 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "131072", "evaluated_value": 131072, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoNavInputs", "family_id": "script.enum-value.ImGui_WindowFlags.NoNavInputs", "kind": "enum-value", "name": "NoNavInputs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoNavInputs = 65536", "description": "No keyboard/gamepad navigation within the window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 94 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "65536", "evaluated_value": 65536, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoResize", "family_id": "script.enum-value.ImGui_WindowFlags.NoResize", "kind": "enum-value", "name": "NoResize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoResize = 2", "description": "Disable user resizing with the lower-right grip", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 79 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoSavedSettings", "family_id": "script.enum-value.ImGui_WindowFlags.NoSavedSettings", "kind": "enum-value", "name": "NoSavedSettings", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoSavedSettings = 256", "description": "Never load/save settings in .ini file", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "256", "evaluated_value": 256, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoScrollWithMouse", "family_id": "script.enum-value.ImGui_WindowFlags.NoScrollWithMouse", "kind": "enum-value", "name": "NoScrollWithMouse", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoScrollWithMouse = 16", "description": "Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 82 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "16", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoScrollbar", "family_id": "script.enum-value.ImGui_WindowFlags.NoScrollbar", "kind": "enum-value", "name": "NoScrollbar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoScrollbar = 8", "description": "Disable scrollbars (window can still scroll with mouse or programmatically)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 81 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.NoTitleBar", "family_id": "script.enum-value.ImGui_WindowFlags.NoTitleBar", "kind": "enum-value", "name": "NoTitleBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.NoTitleBar = 1", "description": "Disable title-bar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 78 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.None", "family_id": "script.enum-value.ImGui_WindowFlags.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.None = 0", "description": "Applies no optional window behavior flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ImGui_WindowFlags.UnsavedDocument", "family_id": "script.enum-value.ImGui_WindowFlags.UnsavedDocument", "kind": "enum-value", "name": "UnsavedDocument", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui_WindowFlags", "signature": "ImGui_WindowFlags.UnsavedDocument = 262144", "description": "Display a dot next to the title. When used in a tab/docking context, tab is selected when clicking the X + closure is not assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 96 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ImGui_WindowFlags", "value": "262144", "evaluated_value": 262144, "generated": false }, { "id": "script.enum-value.ItemOwnership.CritterInventory", "family_id": "script.enum-value.ItemOwnership.CritterInventory", "kind": "enum-value", "name": "CritterInventory", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemOwnership", "signature": "ItemOwnership.CritterInventory = 1", "description": "Item is owned by a critter inventory or equipped slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1062 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemOwnership", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ItemOwnership.ItemContainer", "family_id": "script.enum-value.ItemOwnership.ItemContainer", "kind": "enum-value", "name": "ItemContainer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemOwnership", "signature": "ItemOwnership.ItemContainer = 2", "description": "Item is nested inside another item used as a container", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1063 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemOwnership", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ItemOwnership.MapHex", "family_id": "script.enum-value.ItemOwnership.MapHex", "kind": "enum-value", "name": "MapHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemOwnership", "signature": "ItemOwnership.MapHex = 0", "description": "Item is placed directly on a map hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1061 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemOwnership", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ItemOwnership.Nowhere", "family_id": "script.enum-value.ItemOwnership.Nowhere", "kind": "enum-value", "name": "Nowhere", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemOwnership", "signature": "ItemOwnership.Nowhere = 3", "description": "Item has no map, critter, or item-container owner", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1064 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemOwnership", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.ItemProperty.AlwaysHideSprite", "family_id": "script.enum-value.ItemProperty.AlwaysHideSprite", "kind": "enum-value", "name": "AlwaysHideSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.AlwaysHideSprite = 26", "description": "Prevents the item sprite from being drawn at runtime and hides it by default in Mapper", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "26", "evaluated_value": 26, "generated": true }, { "id": "script.enum-value.ItemProperty.Colorize", "family_id": "script.enum-value.ItemProperty.Colorize", "kind": "enum-value", "name": "Colorize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Colorize = 50", "description": "Enables ColorizeColor tinting for the item's map sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 287 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "50", "evaluated_value": 50, "generated": true }, { "id": "script.enum-value.ItemProperty.ColorizeColor", "family_id": "script.enum-value.ItemProperty.ColorizeColor", "kind": "enum-value", "name": "ColorizeColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.ColorizeColor = 35", "description": "RGBA tint applied when Colorize is enabled; alpha also supplies the default sprite opacity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 232 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "35", "evaluated_value": 35, "generated": true }, { "id": "script.enum-value.ItemProperty.ContainerId", "family_id": "script.enum-value.ItemProperty.ContainerId", "kind": "enum-value", "name": "ContainerId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.ContainerId = 12", "description": "Identifier of the parent item while Ownership is ItemContainer; zero otherwise", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 147 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "12", "evaluated_value": 12, "generated": true }, { "id": "script.enum-value.ItemProperty.ContainerStack", "family_id": "script.enum-value.ItemProperty.ContainerStack", "kind": "enum-value", "name": "ContainerStack", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.ContainerStack = 13", "description": "Project-defined grouping key used to select and merge items inside a container", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 150 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "13", "evaluated_value": 13, "generated": true }, { "id": "script.enum-value.ItemProperty.Corner", "family_id": "script.enum-value.ItemProperty.Corner", "kind": "enum-value", "name": "Corner", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Corner = 17", "description": "Wall-corner orientation used by map lighting and transparent-foreground behavior", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 164 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "17", "evaluated_value": 17, "generated": true }, { "id": "script.enum-value.ItemProperty.CritterId", "family_id": "script.enum-value.ItemProperty.CritterId", "kind": "enum-value", "name": "CritterId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.CritterId = 10", "description": "Identifier of the owning critter while Ownership is CritterInventory; zero otherwise", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 137 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "10", "evaluated_value": 10, "generated": true }, { "id": "script.enum-value.ItemProperty.CritterSlot", "family_id": "script.enum-value.ItemProperty.CritterSlot", "kind": "enum-value", "name": "CritterSlot", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.CritterSlot = 11", "description": "Inventory or equipment slot occupied while the item belongs to a critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 144 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "11", "evaluated_value": 11, "generated": true }, { "id": "script.enum-value.ItemProperty.CustomHolderEntry", "family_id": "script.enum-value.ItemProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.ItemProperty.CustomHolderId", "family_id": "script.enum-value.ItemProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.ItemProperty.DisableEgg", "family_id": "script.enum-value.ItemProperty.DisableEgg", "kind": "enum-value", "name": "DisableEgg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.DisableEgg = 18", "description": "Disables transparent-foreground egg processing for the item's map sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 167 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "18", "evaluated_value": 18, "generated": true }, { "id": "script.enum-value.ItemProperty.DrawFlatten", "family_id": "script.enum-value.ItemProperty.DrawFlatten", "kind": "enum-value", "name": "DrawFlatten", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.DrawFlatten = 45", "description": "Renders the item in a flat map pass instead of the normal depth-sorted item pass", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 266 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "45", "evaluated_value": 45, "generated": true }, { "id": "script.enum-value.ItemProperty.DrawMultihexLines", "family_id": "script.enum-value.ItemProperty.DrawMultihexLines", "kind": "enum-value", "name": "DrawMultihexLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.DrawMultihexLines = 22", "description": "Draws repeated item sprites on footprint hexes generated by MultihexLines", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 181 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "22", "evaluated_value": 22, "generated": true }, { "id": "script.enum-value.ItemProperty.DrawMultihexMesh", "family_id": "script.enum-value.ItemProperty.DrawMultihexMesh", "kind": "enum-value", "name": "DrawMultihexMesh", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.DrawMultihexMesh = 23", "description": "Draws repeated item sprites on the explicit MultihexMesh hexes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 184 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "23", "evaluated_value": 23, "generated": true }, { "id": "script.enum-value.ItemProperty.DrawOrderSubLayer", "family_id": "script.enum-value.ItemProperty.DrawOrderSubLayer", "kind": "enum-value", "name": "DrawOrderSubLayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.DrawOrderSubLayer = 46", "description": "Fine ordering inside the item's primary draw-order layer; synchronized when changed at runtime", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 269 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "46", "evaluated_value": 46, "generated": true }, { "id": "script.enum-value.ItemProperty.Elevation", "family_id": "script.enum-value.ItemProperty.Elevation", "kind": "enum-value", "name": "Elevation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Elevation = 9", "description": "Vertical rendering elevation of the map item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 132 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "9", "evaluated_value": 9, "generated": true }, { "id": "script.enum-value.ItemProperty.ExplicitlyPersistent", "family_id": "script.enum-value.ItemProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.ItemProperty.Hex", "family_id": "script.enum-value.ItemProperty.Hex", "kind": "enum-value", "name": "Hex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Hex = 8", "description": "Origin map hex used while the item is placed on a map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 129 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "8", "evaluated_value": 8, "generated": true }, { "id": "script.enum-value.ItemProperty.Hidden", "family_id": "script.enum-value.ItemProperty.Hidden", "kind": "enum-value", "name": "Hidden", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Hidden = 24", "description": "Server visibility flag that suppresses a dynamic item from client views while set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 189 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "24", "evaluated_value": 24, "generated": true }, { "id": "script.enum-value.ItemProperty.HideSprite", "family_id": "script.enum-value.ItemProperty.HideSprite", "kind": "enum-value", "name": "HideSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.HideSprite = 25", "description": "Hides the current client map sprite without removing the item's map presence", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 192 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "25", "evaluated_value": 25, "generated": true }, { "id": "script.enum-value.ItemProperty.InitScript", "family_id": "script.enum-value.ItemProperty.InitScript", "kind": "enum-value", "name": "InitScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.InitScript = 4", "description": "Server initialization function called after the item-init event for a newly created or restored item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "4", "evaluated_value": 4, "generated": true }, { "id": "script.enum-value.ItemProperty.InnerItemIds", "family_id": "script.enum-value.ItemProperty.InnerItemIds", "kind": "enum-value", "name": "InnerItemIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.InnerItemIds = 14", "description": "Persistent identifiers of the items directly contained by this item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 155 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "14", "evaluated_value": 14, "generated": true }, { "id": "script.enum-value.ItemProperty.IsGag", "family_id": "script.enum-value.ItemProperty.IsGag", "kind": "enum-value", "name": "IsGag", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.IsGag = 49", "description": "Marks a blocking item as conditionally passable through the map gag callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "49", "evaluated_value": 49, "generated": true }, { "id": "script.enum-value.ItemProperty.IsRoofTile", "family_id": "script.enum-value.ItemProperty.IsRoofTile", "kind": "enum-value", "name": "IsRoofTile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.IsRoofTile = 43", "description": "Selects roof rendering instead of ground-tile rendering when IsTile is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 258 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "43", "evaluated_value": 43, "generated": true }, { "id": "script.enum-value.ItemProperty.IsScenery", "family_id": "script.enum-value.ItemProperty.IsScenery", "kind": "enum-value", "name": "IsScenery", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.IsScenery = 40", "description": "Classifies the item as scenery for Mapper filtering and flat-render lighting rules", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 249 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "40", "evaluated_value": 40, "generated": true }, { "id": "script.enum-value.ItemProperty.IsTile", "family_id": "script.enum-value.ItemProperty.IsTile", "kind": "enum-value", "name": "IsTile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.IsTile = 42", "description": "Classifies the item as a ground or roof tile rendered in a tile layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 255 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "42", "evaluated_value": 42, "generated": true }, { "id": "script.enum-value.ItemProperty.IsTrigger", "family_id": "script.enum-value.ItemProperty.IsTrigger", "kind": "enum-value", "name": "IsTrigger", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.IsTrigger = 38", "description": "Includes the item in map trigger lookup and movement-trigger processing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 243 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "38", "evaluated_value": 38, "generated": true }, { "id": "script.enum-value.ItemProperty.IsWall", "family_id": "script.enum-value.ItemProperty.IsWall", "kind": "enum-value", "name": "IsWall", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.IsWall = 41", "description": "Classifies the item as a wall for Mapper filtering and map presentation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 252 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "41", "evaluated_value": 41, "generated": true }, { "id": "script.enum-value.ItemProperty.LightColor", "family_id": "script.enum-value.ItemProperty.LightColor", "kind": "enum-value", "name": "LightColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.LightColor = 34", "description": "RGBA color emitted by the item's light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 229 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "34", "evaluated_value": 34, "generated": true }, { "id": "script.enum-value.ItemProperty.LightDistance", "family_id": "script.enum-value.ItemProperty.LightDistance", "kind": "enum-value", "name": "LightDistance", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.LightDistance = 32", "description": "Radius in hexes reached by the item's light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 223 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "32", "evaluated_value": 32, "generated": true }, { "id": "script.enum-value.ItemProperty.LightFlags", "family_id": "script.enum-value.ItemProperty.LightFlags", "kind": "enum-value", "name": "LightFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.LightFlags = 33", "description": "Bit mask controlling global, inverse, and direction-blocking behavior of the light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 226 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "33", "evaluated_value": 33, "generated": true }, { "id": "script.enum-value.ItemProperty.LightIntensity", "family_id": "script.enum-value.ItemProperty.LightIntensity", "kind": "enum-value", "name": "LightIntensity", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.LightIntensity = 31", "description": "Signed percentage intensity of the item's light source", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 220 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "31", "evaluated_value": 31, "generated": true }, { "id": "script.enum-value.ItemProperty.LightSource", "family_id": "script.enum-value.ItemProperty.LightSource", "kind": "enum-value", "name": "LightSource", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.LightSource = 30", "description": "Enables a map light source centered on this item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 217 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "30", "evaluated_value": 30, "generated": true }, { "id": "script.enum-value.ItemProperty.LightThru", "family_id": "script.enum-value.ItemProperty.LightThru", "kind": "enum-value", "name": "LightThru", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.LightThru = 29", "description": "Allows map light propagation through every hex occupied by the item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "29", "evaluated_value": 29, "generated": true }, { "id": "script.enum-value.ItemProperty.MapId", "family_id": "script.enum-value.ItemProperty.MapId", "kind": "enum-value", "name": "MapId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.MapId = 7", "description": "Identifier of the owning map while Ownership is MapHex; zero otherwise", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 126 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "7", "evaluated_value": 7, "generated": true }, { "id": "script.enum-value.ItemProperty.MultihexGeneration", "family_id": "script.enum-value.ItemProperty.MultihexGeneration", "kind": "enum-value", "name": "MultihexGeneration", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.MultihexGeneration = 21", "description": "Mapper coalescing strategy used to build MultihexMesh from compatible item placements", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "21", "evaluated_value": 21, "generated": true }, { "id": "script.enum-value.ItemProperty.MultihexLines", "family_id": "script.enum-value.ItemProperty.MultihexLines", "kind": "enum-value", "name": "MultihexLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.MultihexLines = 19", "description": "Direction and step-count pairs that trace additional footprint hexes from each mesh origin", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 172 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "19", "evaluated_value": 19, "generated": true }, { "id": "script.enum-value.ItemProperty.MultihexMesh", "family_id": "script.enum-value.ItemProperty.MultihexMesh", "kind": "enum-value", "name": "MultihexMesh", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.MultihexMesh = 20", "description": "Explicit map hexes that share this item's footprint and optional repeated sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 175 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "20", "evaluated_value": 20, "generated": true }, { "id": "script.enum-value.ItemProperty.NoBlock", "family_id": "script.enum-value.ItemProperty.NoBlock", "kind": "enum-value", "name": "NoBlock", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.NoBlock = 27", "description": "Allows movement through every hex occupied by the item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 202 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "27", "evaluated_value": 27, "generated": true }, { "id": "script.enum-value.ItemProperty.NoHighlight", "family_id": "script.enum-value.ItemProperty.NoHighlight", "kind": "enum-value", "name": "NoHighlight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.NoHighlight = 47", "description": "Prevents the client from applying normal item highlight presentation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 274 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "47", "evaluated_value": 47, "generated": true }, { "id": "script.enum-value.ItemProperty.NoLightInfluence", "family_id": "script.enum-value.ItemProperty.NoLightInfluence", "kind": "enum-value", "name": "NoLightInfluence", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.NoLightInfluence = 48", "description": "Prevents ambient map lighting from tinting the item's sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 279 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "48", "evaluated_value": 48, "generated": true }, { "id": "script.enum-value.ItemProperty.None", "family_id": "script.enum-value.ItemProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.None = 0", "description": "Sentinel indicating that no Item property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.ItemProperty.Offset", "family_id": "script.enum-value.ItemProperty.Offset", "kind": "enum-value", "name": "Offset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Offset = 16", "description": "Pixel offset applied to the item's map sprite from its origin hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 161 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "16", "evaluated_value": 16, "generated": true }, { "id": "script.enum-value.ItemProperty.Ownership", "family_id": "script.enum-value.ItemProperty.Ownership", "kind": "enum-value", "name": "Ownership", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Ownership = 6", "description": "Current placement category: map hex, critter inventory, item container, or nowhere", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 123 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "6", "evaluated_value": 6, "generated": true }, { "id": "script.enum-value.ItemProperty.PicInv", "family_id": "script.enum-value.ItemProperty.PicInv", "kind": "enum-value", "name": "PicInv", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.PicInv = 39", "description": "Sprite resource used to present the item in inventory interfaces", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 246 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "39", "evaluated_value": 39, "generated": true }, { "id": "script.enum-value.ItemProperty.PicMap", "family_id": "script.enum-value.ItemProperty.PicMap", "kind": "enum-value", "name": "PicMap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.PicMap = 15", "description": "Sprite resource used to render the item on a map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 158 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "15", "evaluated_value": 15, "generated": true }, { "id": "script.enum-value.ItemProperty.ShootThru", "family_id": "script.enum-value.ItemProperty.ShootThru", "kind": "enum-value", "name": "ShootThru", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.ShootThru = 28", "description": "Allows projectile traces through every hex occupied by the item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 207 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "28", "evaluated_value": 28, "generated": true }, { "id": "script.enum-value.ItemProperty.Static", "family_id": "script.enum-value.ItemProperty.Static", "kind": "enum-value", "name": "Static", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.Static = 5", "description": "Marks map-authored item data as static scenery rather than a dynamic item entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 118 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "5", "evaluated_value": 5, "generated": true }, { "id": "script.enum-value.ItemProperty.StaticScript", "family_id": "script.enum-value.ItemProperty.StaticScript", "kind": "enum-value", "name": "StaticScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.StaticScript = 36", "description": "Server callback invoked when a critter interacts with this static item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 237 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "36", "evaluated_value": 36, "generated": true }, { "id": "script.enum-value.ItemProperty.TileLayer", "family_id": "script.enum-value.ItemProperty.TileLayer", "kind": "enum-value", "name": "TileLayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.TileLayer = 44", "description": "Zero-based ground- or roof-tile draw layer selected for a tile item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "44", "evaluated_value": 44, "generated": true }, { "id": "script.enum-value.ItemProperty.TriggerScript", "family_id": "script.enum-value.ItemProperty.TriggerScript", "kind": "enum-value", "name": "TriggerScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ItemProperty", "signature": "ItemProperty.TriggerScript = 37", "description": "Server callback invoked when a critter enters or leaves this trigger item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 240 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ItemProperty", "value": "37", "evaluated_value": 37, "generated": true }, { "id": "script.enum-value.KeyCode.A", "family_id": "script.enum-value.KeyCode.A", "kind": "enum-value", "name": "A", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.A = 0x1E", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_A` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 83 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x1E", "evaluated_value": 30, "generated": false }, { "id": "script.enum-value.KeyCode.Add", "family_id": "script.enum-value.KeyCode.Add", "kind": "enum-value", "name": "Add", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Add = 0x4E", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_PLUS` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 131 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x4E", "evaluated_value": 78, "generated": false }, { "id": "script.enum-value.KeyCode.Apostrophe", "family_id": "script.enum-value.KeyCode.Apostrophe", "kind": "enum-value", "name": "Apostrophe", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Apostrophe = 0x28", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_APOSTROPHE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x28", "evaluated_value": 40, "generated": false }, { "id": "script.enum-value.KeyCode.B", "family_id": "script.enum-value.KeyCode.B", "kind": "enum-value", "name": "B", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.B = 0x30", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_B` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 101 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x30", "evaluated_value": 48, "generated": false }, { "id": "script.enum-value.KeyCode.Back", "family_id": "script.enum-value.KeyCode.Back", "kind": "enum-value", "name": "Back", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Back = 0x0E", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_BACKSPACE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 67 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x0E", "evaluated_value": 14, "generated": false }, { "id": "script.enum-value.KeyCode.Backslash", "family_id": "script.enum-value.KeyCode.Backslash", "kind": "enum-value", "name": "Backslash", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Backslash = 0x2B", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_BACKSLASH` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 96 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x2B", "evaluated_value": 43, "generated": false }, { "id": "script.enum-value.KeyCode.C", "family_id": "script.enum-value.KeyCode.C", "kind": "enum-value", "name": "C", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C = 0x2E", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_C` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x2E", "evaluated_value": 46, "generated": false }, { "id": "script.enum-value.KeyCode.C0", "family_id": "script.enum-value.KeyCode.C0", "kind": "enum-value", "name": "C0", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C0 = 0x0B", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_0` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 64 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x0B", "evaluated_value": 11, "generated": false }, { "id": "script.enum-value.KeyCode.C1", "family_id": "script.enum-value.KeyCode.C1", "kind": "enum-value", "name": "C1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C1 = 0x02", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_1` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x02", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.KeyCode.C2", "family_id": "script.enum-value.KeyCode.C2", "kind": "enum-value", "name": "C2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C2 = 0x03", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_2` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x03", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.KeyCode.C3", "family_id": "script.enum-value.KeyCode.C3", "kind": "enum-value", "name": "C3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C3 = 0x04", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_3` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x04", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.KeyCode.C4", "family_id": "script.enum-value.KeyCode.C4", "kind": "enum-value", "name": "C4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C4 = 0x05", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_4` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x05", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.KeyCode.C5", "family_id": "script.enum-value.KeyCode.C5", "kind": "enum-value", "name": "C5", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C5 = 0x06", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_5` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x06", "evaluated_value": 6, "generated": false }, { "id": "script.enum-value.KeyCode.C6", "family_id": "script.enum-value.KeyCode.C6", "kind": "enum-value", "name": "C6", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C6 = 0x07", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_6` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x07", "evaluated_value": 7, "generated": false }, { "id": "script.enum-value.KeyCode.C7", "family_id": "script.enum-value.KeyCode.C7", "kind": "enum-value", "name": "C7", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C7 = 0x08", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_7` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x08", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.KeyCode.C8", "family_id": "script.enum-value.KeyCode.C8", "kind": "enum-value", "name": "C8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C8 = 0x09", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_8` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x09", "evaluated_value": 9, "generated": false }, { "id": "script.enum-value.KeyCode.C9", "family_id": "script.enum-value.KeyCode.C9", "kind": "enum-value", "name": "C9", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.C9 = 0x0A", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_9` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 63 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x0A", "evaluated_value": 10, "generated": false }, { "id": "script.enum-value.KeyCode.Capital", "family_id": "script.enum-value.KeyCode.Capital", "kind": "enum-value", "name": "Capital", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Capital = 0x3A", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_CAPSLOCK` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x3A", "evaluated_value": 58, "generated": false }, { "id": "script.enum-value.KeyCode.Comma", "family_id": "script.enum-value.KeyCode.Comma", "kind": "enum-value", "name": "Comma", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Comma = 0x33", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_COMMA` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 104 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x33", "evaluated_value": 51, "generated": false }, { "id": "script.enum-value.KeyCode.D", "family_id": "script.enum-value.KeyCode.D", "kind": "enum-value", "name": "D", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.D = 0x20", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_D` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x20", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.KeyCode.Decimal", "family_id": "script.enum-value.KeyCode.Decimal", "kind": "enum-value", "name": "Decimal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Decimal = 0x53", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_PERIOD` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 136 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x53", "evaluated_value": 83, "generated": false }, { "id": "script.enum-value.KeyCode.Delete", "family_id": "script.enum-value.KeyCode.Delete", "kind": "enum-value", "name": "Delete", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Delete = 0xD3", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_DELETE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 154 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xD3", "evaluated_value": 211, "generated": false }, { "id": "script.enum-value.KeyCode.Divide", "family_id": "script.enum-value.KeyCode.Divide", "kind": "enum-value", "name": "Divide", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Divide = 0xB5", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_DIVIDE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 141 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xB5", "evaluated_value": 181, "generated": false }, { "id": "script.enum-value.KeyCode.Down", "family_id": "script.enum-value.KeyCode.Down", "kind": "enum-value", "name": "Down", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Down = 0xD0", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_DOWN` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xD0", "evaluated_value": 208, "generated": false }, { "id": "script.enum-value.KeyCode.E", "family_id": "script.enum-value.KeyCode.E", "kind": "enum-value", "name": "E", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.E = 0x12", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_E` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 71 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x12", "evaluated_value": 18, "generated": false }, { "id": "script.enum-value.KeyCode.End", "family_id": "script.enum-value.KeyCode.End", "kind": "enum-value", "name": "End", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.End = 0xCF", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_END` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 150 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xCF", "evaluated_value": 207, "generated": false }, { "id": "script.enum-value.KeyCode.Equals", "family_id": "script.enum-value.KeyCode.Equals", "kind": "enum-value", "name": "Equals", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Equals = 0x0D", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_EQUALS` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x0D", "evaluated_value": 13, "generated": false }, { "id": "script.enum-value.KeyCode.Escape", "family_id": "script.enum-value.KeyCode.Escape", "kind": "enum-value", "name": "Escape", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Escape = 0x01", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_ESCAPE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x01", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.KeyCode.F", "family_id": "script.enum-value.KeyCode.F", "kind": "enum-value", "name": "F", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F = 0x21", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x21", "evaluated_value": 33, "generated": false }, { "id": "script.enum-value.KeyCode.F1", "family_id": "script.enum-value.KeyCode.F1", "kind": "enum-value", "name": "F1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F1 = 0x3B", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F1` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 112 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x3B", "evaluated_value": 59, "generated": false }, { "id": "script.enum-value.KeyCode.F10", "family_id": "script.enum-value.KeyCode.F10", "kind": "enum-value", "name": "F10", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F10 = 0x44", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F10` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 121 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x44", "evaluated_value": 68, "generated": false }, { "id": "script.enum-value.KeyCode.F11", "family_id": "script.enum-value.KeyCode.F11", "kind": "enum-value", "name": "F11", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F11 = 0x57", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F11` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 137 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x57", "evaluated_value": 87, "generated": false }, { "id": "script.enum-value.KeyCode.F12", "family_id": "script.enum-value.KeyCode.F12", "kind": "enum-value", "name": "F12", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F12 = 0x58", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F12` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x58", "evaluated_value": 88, "generated": false }, { "id": "script.enum-value.KeyCode.F2", "family_id": "script.enum-value.KeyCode.F2", "kind": "enum-value", "name": "F2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F2 = 0x3C", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F2` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x3C", "evaluated_value": 60, "generated": false }, { "id": "script.enum-value.KeyCode.F3", "family_id": "script.enum-value.KeyCode.F3", "kind": "enum-value", "name": "F3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F3 = 0x3D", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F3` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 114 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x3D", "evaluated_value": 61, "generated": false }, { "id": "script.enum-value.KeyCode.F4", "family_id": "script.enum-value.KeyCode.F4", "kind": "enum-value", "name": "F4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F4 = 0x3E", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F4` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 115 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x3E", "evaluated_value": 62, "generated": false }, { "id": "script.enum-value.KeyCode.F5", "family_id": "script.enum-value.KeyCode.F5", "kind": "enum-value", "name": "F5", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F5 = 0x3F", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F5` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 116 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x3F", "evaluated_value": 63, "generated": false }, { "id": "script.enum-value.KeyCode.F6", "family_id": "script.enum-value.KeyCode.F6", "kind": "enum-value", "name": "F6", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F6 = 0x40", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F6` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 117 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x40", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.KeyCode.F7", "family_id": "script.enum-value.KeyCode.F7", "kind": "enum-value", "name": "F7", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F7 = 0x41", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F7` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 118 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x41", "evaluated_value": 65, "generated": false }, { "id": "script.enum-value.KeyCode.F8", "family_id": "script.enum-value.KeyCode.F8", "kind": "enum-value", "name": "F8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F8 = 0x42", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F8` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 119 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x42", "evaluated_value": 66, "generated": false }, { "id": "script.enum-value.KeyCode.F9", "family_id": "script.enum-value.KeyCode.F9", "kind": "enum-value", "name": "F9", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.F9 = 0x43", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_F9` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 120 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x43", "evaluated_value": 67, "generated": false }, { "id": "script.enum-value.KeyCode.G", "family_id": "script.enum-value.KeyCode.G", "kind": "enum-value", "name": "G", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.G = 0x22", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_G` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 87 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x22", "evaluated_value": 34, "generated": false }, { "id": "script.enum-value.KeyCode.Grave", "family_id": "script.enum-value.KeyCode.Grave", "kind": "enum-value", "name": "Grave", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Grave = 0x29", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_GRAVE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 94 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x29", "evaluated_value": 41, "generated": false }, { "id": "script.enum-value.KeyCode.H", "family_id": "script.enum-value.KeyCode.H", "kind": "enum-value", "name": "H", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.H = 0x23", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_H` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x23", "evaluated_value": 35, "generated": false }, { "id": "script.enum-value.KeyCode.Home", "family_id": "script.enum-value.KeyCode.Home", "kind": "enum-value", "name": "Home", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Home = 0xC7", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_HOME` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 145 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xC7", "evaluated_value": 199, "generated": false }, { "id": "script.enum-value.KeyCode.I", "family_id": "script.enum-value.KeyCode.I", "kind": "enum-value", "name": "I", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.I = 0x17", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_I` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x17", "evaluated_value": 23, "generated": false }, { "id": "script.enum-value.KeyCode.Insert", "family_id": "script.enum-value.KeyCode.Insert", "kind": "enum-value", "name": "Insert", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Insert = 0xD2", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_INSERT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 153 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xD2", "evaluated_value": 210, "generated": false }, { "id": "script.enum-value.KeyCode.J", "family_id": "script.enum-value.KeyCode.J", "kind": "enum-value", "name": "J", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.J = 0x24", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_J` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x24", "evaluated_value": 36, "generated": false }, { "id": "script.enum-value.KeyCode.K", "family_id": "script.enum-value.KeyCode.K", "kind": "enum-value", "name": "K", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.K = 0x25", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_K` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 90 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x25", "evaluated_value": 37, "generated": false }, { "id": "script.enum-value.KeyCode.L", "family_id": "script.enum-value.KeyCode.L", "kind": "enum-value", "name": "L", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.L = 0x26", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_L` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 91 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x26", "evaluated_value": 38, "generated": false }, { "id": "script.enum-value.KeyCode.Lbracket", "family_id": "script.enum-value.KeyCode.Lbracket", "kind": "enum-value", "name": "Lbracket", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Lbracket = 0x1A", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_LEFTBRACKET` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 79 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x1A", "evaluated_value": 26, "generated": false }, { "id": "script.enum-value.KeyCode.Lcontrol", "family_id": "script.enum-value.KeyCode.Lcontrol", "kind": "enum-value", "name": "Lcontrol", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Lcontrol = 0x1D", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_LCTRL` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 82 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x1D", "evaluated_value": 29, "generated": false }, { "id": "script.enum-value.KeyCode.Left", "family_id": "script.enum-value.KeyCode.Left", "kind": "enum-value", "name": "Left", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Left = 0xCB", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_LEFT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 148 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xCB", "evaluated_value": 203, "generated": false }, { "id": "script.enum-value.KeyCode.Lmenu", "family_id": "script.enum-value.KeyCode.Lmenu", "kind": "enum-value", "name": "Lmenu", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Lmenu = 0x38", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_LALT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 109 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x38", "evaluated_value": 56, "generated": false }, { "id": "script.enum-value.KeyCode.Lshift", "family_id": "script.enum-value.KeyCode.Lshift", "kind": "enum-value", "name": "Lshift", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Lshift = 0x2A", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_LSHIFT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 95 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x2A", "evaluated_value": 42, "generated": false }, { "id": "script.enum-value.KeyCode.Lwin", "family_id": "script.enum-value.KeyCode.Lwin", "kind": "enum-value", "name": "Lwin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Lwin = 0xDB", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_LGUI` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 155 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xDB", "evaluated_value": 219, "generated": false }, { "id": "script.enum-value.KeyCode.M", "family_id": "script.enum-value.KeyCode.M", "kind": "enum-value", "name": "M", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.M = 0x32", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_M` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 103 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x32", "evaluated_value": 50, "generated": false }, { "id": "script.enum-value.KeyCode.Minus", "family_id": "script.enum-value.KeyCode.Minus", "kind": "enum-value", "name": "Minus", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Minus = 0x0C", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_MINUS` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 65 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x0C", "evaluated_value": 12, "generated": false }, { "id": "script.enum-value.KeyCode.Multiply", "family_id": "script.enum-value.KeyCode.Multiply", "kind": "enum-value", "name": "Multiply", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Multiply = 0x37", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_MULTIPLY` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 108 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x37", "evaluated_value": 55, "generated": false }, { "id": "script.enum-value.KeyCode.N", "family_id": "script.enum-value.KeyCode.N", "kind": "enum-value", "name": "N", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.N = 0x31", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_N` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 102 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x31", "evaluated_value": 49, "generated": false }, { "id": "script.enum-value.KeyCode.Next", "family_id": "script.enum-value.KeyCode.Next", "kind": "enum-value", "name": "Next", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Next = 0xD1", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_PAGEDOWN` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 152 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xD1", "evaluated_value": 209, "generated": false }, { "id": "script.enum-value.KeyCode.None", "family_id": "script.enum-value.KeyCode.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.None = 0x00", "description": "Indicates that no physical or synthetic keyboard input code is selected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 53 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x00", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.KeyCode.Numlock", "family_id": "script.enum-value.KeyCode.Numlock", "kind": "enum-value", "name": "Numlock", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numlock = 0x45", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_NUMLOCKCLEAR` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 122 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x45", "evaluated_value": 69, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad0", "family_id": "script.enum-value.KeyCode.Numpad0", "kind": "enum-value", "name": "Numpad0", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad0 = 0x52", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_0` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x52", "evaluated_value": 82, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad1", "family_id": "script.enum-value.KeyCode.Numpad1", "kind": "enum-value", "name": "Numpad1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad1 = 0x4F", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_1` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 132 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x4F", "evaluated_value": 79, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad2", "family_id": "script.enum-value.KeyCode.Numpad2", "kind": "enum-value", "name": "Numpad2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad2 = 0x50", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_2` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 133 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x50", "evaluated_value": 80, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad3", "family_id": "script.enum-value.KeyCode.Numpad3", "kind": "enum-value", "name": "Numpad3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad3 = 0x51", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_3` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 134 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x51", "evaluated_value": 81, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad4", "family_id": "script.enum-value.KeyCode.Numpad4", "kind": "enum-value", "name": "Numpad4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad4 = 0x4B", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_4` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 128 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x4B", "evaluated_value": 75, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad5", "family_id": "script.enum-value.KeyCode.Numpad5", "kind": "enum-value", "name": "Numpad5", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad5 = 0x4C", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_5` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 129 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x4C", "evaluated_value": 76, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad6", "family_id": "script.enum-value.KeyCode.Numpad6", "kind": "enum-value", "name": "Numpad6", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad6 = 0x4D", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_6` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 130 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x4D", "evaluated_value": 77, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad7", "family_id": "script.enum-value.KeyCode.Numpad7", "kind": "enum-value", "name": "Numpad7", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad7 = 0x47", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_7` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 124 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x47", "evaluated_value": 71, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad8", "family_id": "script.enum-value.KeyCode.Numpad8", "kind": "enum-value", "name": "Numpad8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad8 = 0x48", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_8` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 125 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x48", "evaluated_value": 72, "generated": false }, { "id": "script.enum-value.KeyCode.Numpad9", "family_id": "script.enum-value.KeyCode.Numpad9", "kind": "enum-value", "name": "Numpad9", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpad9 = 0x49", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_9` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 126 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x49", "evaluated_value": 73, "generated": false }, { "id": "script.enum-value.KeyCode.Numpadenter", "family_id": "script.enum-value.KeyCode.Numpadenter", "kind": "enum-value", "name": "Numpadenter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Numpadenter = 0x9C", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_ENTER` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 139 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x9C", "evaluated_value": 156, "generated": false }, { "id": "script.enum-value.KeyCode.O", "family_id": "script.enum-value.KeyCode.O", "kind": "enum-value", "name": "O", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.O = 0x18", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_O` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x18", "evaluated_value": 24, "generated": false }, { "id": "script.enum-value.KeyCode.P", "family_id": "script.enum-value.KeyCode.P", "kind": "enum-value", "name": "P", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.P = 0x19", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_P` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 78 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x19", "evaluated_value": 25, "generated": false }, { "id": "script.enum-value.KeyCode.Pause", "family_id": "script.enum-value.KeyCode.Pause", "kind": "enum-value", "name": "Pause", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Pause = 0xC5", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_PAUSE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 144 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xC5", "evaluated_value": 197, "generated": false }, { "id": "script.enum-value.KeyCode.Period", "family_id": "script.enum-value.KeyCode.Period", "kind": "enum-value", "name": "Period", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Period = 0x34", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_PERIOD` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 105 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x34", "evaluated_value": 52, "generated": false }, { "id": "script.enum-value.KeyCode.Prior", "family_id": "script.enum-value.KeyCode.Prior", "kind": "enum-value", "name": "Prior", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Prior = 0xC9", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_PAGEUP` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 147 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xC9", "evaluated_value": 201, "generated": false }, { "id": "script.enum-value.KeyCode.Q", "family_id": "script.enum-value.KeyCode.Q", "kind": "enum-value", "name": "Q", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Q = 0x10", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_Q` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x10", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.KeyCode.R", "family_id": "script.enum-value.KeyCode.R", "kind": "enum-value", "name": "R", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.R = 0x13", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_R` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 72 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x13", "evaluated_value": 19, "generated": false }, { "id": "script.enum-value.KeyCode.Rbracket", "family_id": "script.enum-value.KeyCode.Rbracket", "kind": "enum-value", "name": "Rbracket", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Rbracket = 0x1B", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RIGHTBRACKET` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 80 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x1B", "evaluated_value": 27, "generated": false }, { "id": "script.enum-value.KeyCode.Rcontrol", "family_id": "script.enum-value.KeyCode.Rcontrol", "kind": "enum-value", "name": "Rcontrol", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Rcontrol = 0x9D", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RCTRL` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 140 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x9D", "evaluated_value": 157, "generated": false }, { "id": "script.enum-value.KeyCode.Return", "family_id": "script.enum-value.KeyCode.Return", "kind": "enum-value", "name": "Return", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Return = 0x1C", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RETURN` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 81 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x1C", "evaluated_value": 28, "generated": false }, { "id": "script.enum-value.KeyCode.Right", "family_id": "script.enum-value.KeyCode.Right", "kind": "enum-value", "name": "Right", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Right = 0xCD", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RIGHT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 149 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xCD", "evaluated_value": 205, "generated": false }, { "id": "script.enum-value.KeyCode.Rmenu", "family_id": "script.enum-value.KeyCode.Rmenu", "kind": "enum-value", "name": "Rmenu", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Rmenu = 0xB8", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RALT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 143 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xB8", "evaluated_value": 184, "generated": false }, { "id": "script.enum-value.KeyCode.Rshift", "family_id": "script.enum-value.KeyCode.Rshift", "kind": "enum-value", "name": "Rshift", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Rshift = 0x36", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RSHIFT` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 107 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x36", "evaluated_value": 54, "generated": false }, { "id": "script.enum-value.KeyCode.Rwin", "family_id": "script.enum-value.KeyCode.Rwin", "kind": "enum-value", "name": "Rwin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Rwin = 0xDC", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_RGUI` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xDC", "evaluated_value": 220, "generated": false }, { "id": "script.enum-value.KeyCode.S", "family_id": "script.enum-value.KeyCode.S", "kind": "enum-value", "name": "S", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.S = 0x1F", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_S` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 84 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x1F", "evaluated_value": 31, "generated": false }, { "id": "script.enum-value.KeyCode.Scroll", "family_id": "script.enum-value.KeyCode.Scroll", "kind": "enum-value", "name": "Scroll", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Scroll = 0x46", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_SCROLLLOCK` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 123 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x46", "evaluated_value": 70, "generated": false }, { "id": "script.enum-value.KeyCode.Semicolon", "family_id": "script.enum-value.KeyCode.Semicolon", "kind": "enum-value", "name": "Semicolon", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Semicolon = 0x27", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_SEMICOLON` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x27", "evaluated_value": 39, "generated": false }, { "id": "script.enum-value.KeyCode.Slash", "family_id": "script.enum-value.KeyCode.Slash", "kind": "enum-value", "name": "Slash", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Slash = 0x35", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_SLASH` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 106 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x35", "evaluated_value": 53, "generated": false }, { "id": "script.enum-value.KeyCode.Space", "family_id": "script.enum-value.KeyCode.Space", "kind": "enum-value", "name": "Space", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Space = 0x39", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_SPACE` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 110 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x39", "evaluated_value": 57, "generated": false }, { "id": "script.enum-value.KeyCode.Subtract", "family_id": "script.enum-value.KeyCode.Subtract", "kind": "enum-value", "name": "Subtract", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Subtract = 0x4A", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_KP_MINUS` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 127 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x4A", "evaluated_value": 74, "generated": false }, { "id": "script.enum-value.KeyCode.Sysrq", "family_id": "script.enum-value.KeyCode.Sysrq", "kind": "enum-value", "name": "Sysrq", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Sysrq = 0xB7", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_SYSREQ` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 142 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xB7", "evaluated_value": 183, "generated": false }, { "id": "script.enum-value.KeyCode.T", "family_id": "script.enum-value.KeyCode.T", "kind": "enum-value", "name": "T", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.T = 0x14", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_T` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 73 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x14", "evaluated_value": 20, "generated": false }, { "id": "script.enum-value.KeyCode.Tab", "family_id": "script.enum-value.KeyCode.Tab", "kind": "enum-value", "name": "Tab", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Tab = 0x0F", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_TAB` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x0F", "evaluated_value": 15, "generated": false }, { "id": "script.enum-value.KeyCode.Text", "family_id": "script.enum-value.KeyCode.Text", "kind": "enum-value", "name": "Text", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Text = 0xFF", "description": "Identifies a synthetic text event whose UTF-8 input, clipboard, or dropped-data payload is carried separately by the input event", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 157 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xFF", "evaluated_value": 255, "generated": false }, { "id": "script.enum-value.KeyCode.U", "family_id": "script.enum-value.KeyCode.U", "kind": "enum-value", "name": "U", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.U = 0x16", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_U` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 75 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x16", "evaluated_value": 22, "generated": false }, { "id": "script.enum-value.KeyCode.Up", "family_id": "script.enum-value.KeyCode.Up", "kind": "enum-value", "name": "Up", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Up = 0xC8", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_UP` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 146 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0xC8", "evaluated_value": 200, "generated": false }, { "id": "script.enum-value.KeyCode.V", "family_id": "script.enum-value.KeyCode.V", "kind": "enum-value", "name": "V", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.V = 0x2F", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_V` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 100 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x2F", "evaluated_value": 47, "generated": false }, { "id": "script.enum-value.KeyCode.W", "family_id": "script.enum-value.KeyCode.W", "kind": "enum-value", "name": "W", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.W = 0x11", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_W` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 70 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x11", "evaluated_value": 17, "generated": false }, { "id": "script.enum-value.KeyCode.X", "family_id": "script.enum-value.KeyCode.X", "kind": "enum-value", "name": "X", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.X = 0x2D", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_X` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 98 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x2D", "evaluated_value": 45, "generated": false }, { "id": "script.enum-value.KeyCode.Y", "family_id": "script.enum-value.KeyCode.Y", "kind": "enum-value", "name": "Y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Y = 0x15", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_Y` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 74 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x15", "evaluated_value": 21, "generated": false }, { "id": "script.enum-value.KeyCode.Z", "family_id": "script.enum-value.KeyCode.Z", "kind": "enum-value", "name": "Z", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "KeyCode", "signature": "KeyCode.Z = 0x2C", "description": "Identifies the physical keyboard key mapped from `SDL_SCANCODE_Z` by the application input layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 97 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.KeyCode", "value": "0x2C", "evaluated_value": 44, "generated": false }, { "id": "script.enum-value.LocationProperty.CustomHolderEntry", "family_id": "script.enum-value.LocationProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LocationProperty", "signature": "LocationProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.LocationProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.LocationProperty.CustomHolderId", "family_id": "script.enum-value.LocationProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LocationProperty", "signature": "LocationProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.LocationProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.LocationProperty.ExplicitlyPersistent", "family_id": "script.enum-value.LocationProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LocationProperty", "signature": "LocationProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.LocationProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.LocationProperty.InitScript", "family_id": "script.enum-value.LocationProperty.InitScript", "kind": "enum-value", "name": "InitScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LocationProperty", "signature": "LocationProperty.InitScript = 4", "description": "Server initialization function called after the location-init event for a newly created or restored location", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 495 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.LocationProperty", "value": "4", "evaluated_value": 4, "generated": true }, { "id": "script.enum-value.LocationProperty.MapIds", "family_id": "script.enum-value.LocationProperty.MapIds", "kind": "enum-value", "name": "MapIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LocationProperty", "signature": "LocationProperty.MapIds = 5", "description": "Persistent identifiers of the maps owned by this location, in location-map order", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 498 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.LocationProperty", "value": "5", "evaluated_value": 5, "generated": true }, { "id": "script.enum-value.LocationProperty.None", "family_id": "script.enum-value.LocationProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LocationProperty", "signature": "LocationProperty.None = 0", "description": "Sentinel indicating that no Location property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.LocationProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.MapLayers.All", "family_id": "script.enum-value.MapLayers.All", "kind": "enum-value", "name": "All", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.All = 0x7F", "description": "Draw every map layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x7F", "evaluated_value": 127, "generated": false }, { "id": "script.enum-value.MapLayers.Critters", "family_id": "script.enum-value.MapLayers.Critters", "kind": "enum-value", "name": "Critters", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Critters = 0x08", "description": "Draw critters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1109 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x08", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.MapLayers.Fast", "family_id": "script.enum-value.MapLayers.Fast", "kind": "enum-value", "name": "Fast", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Fast = 0x40", "description": "Draw the fast-rendered layer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1112 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x40", "evaluated_value": 64, "generated": false }, { "id": "script.enum-value.MapLayers.Items", "family_id": "script.enum-value.MapLayers.Items", "kind": "enum-value", "name": "Items", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Items = 0x01", "description": "Draw map items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1106 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x01", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.MapLayers.None", "family_id": "script.enum-value.MapLayers.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.None = 0", "description": "Draw none of the optional map layers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1105 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.MapLayers.Roof", "family_id": "script.enum-value.MapLayers.Roof", "kind": "enum-value", "name": "Roof", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Roof = 0x20", "description": "Draw roof tiles", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x20", "evaluated_value": 32, "generated": false }, { "id": "script.enum-value.MapLayers.Scenery", "family_id": "script.enum-value.MapLayers.Scenery", "kind": "enum-value", "name": "Scenery", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Scenery = 0x02", "description": "Draw scenery objects", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1107 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x02", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.MapLayers.Tiles", "family_id": "script.enum-value.MapLayers.Tiles", "kind": "enum-value", "name": "Tiles", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Tiles = 0x10", "description": "Draw ground tiles", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1110 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x10", "evaluated_value": 16, "generated": false }, { "id": "script.enum-value.MapLayers.Walls", "family_id": "script.enum-value.MapLayers.Walls", "kind": "enum-value", "name": "Walls", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapLayers", "signature": "MapLayers.Walls = 0x04", "description": "Draw wall objects", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1108 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapLayers", "value": "0x04", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.MapProperty.CritterIds", "family_id": "script.enum-value.MapProperty.CritterIds", "kind": "enum-value", "name": "CritterIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.CritterIds = 7", "description": "Persistent identifiers of the non-player critters owned by this map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 429 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "7", "evaluated_value": 7, "generated": true }, { "id": "script.enum-value.MapProperty.CustomHolderEntry", "family_id": "script.enum-value.MapProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.MapProperty.CustomHolderId", "family_id": "script.enum-value.MapProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.MapProperty.DayColor", "family_id": "script.enum-value.MapProperty.DayColor", "kind": "enum-value", "name": "DayColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.DayColor = 18", "description": "Channel-major RGB values for the map's corresponding daylight color keyframes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 466 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "18", "evaluated_value": 18, "generated": true }, { "id": "script.enum-value.MapProperty.DayColorTime", "family_id": "script.enum-value.MapProperty.DayColorTime", "kind": "enum-value", "name": "DayColorTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.DayColorTime = 17", "description": "Map-specific daylight color keyframe times expressed in minutes of the day cycle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 463 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "17", "evaluated_value": 17, "generated": true }, { "id": "script.enum-value.MapProperty.ExplicitlyPersistent", "family_id": "script.enum-value.MapProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.MapProperty.FixedDayTime", "family_id": "script.enum-value.MapProperty.FixedDayTime", "kind": "enum-value", "name": "FixedDayTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.FixedDayTime = 16", "description": "Map-local day-time override value, conventionally expressed in minutes and interpreted by game scripts", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 458 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "16", "evaluated_value": 16, "generated": true }, { "id": "script.enum-value.MapProperty.GlobalDayColor", "family_id": "script.enum-value.MapProperty.GlobalDayColor", "kind": "enum-value", "name": "GlobalDayColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.GlobalDayColor = 20", "description": "Current client-side global daylight color supplied through SetDayColors for scripts and effects", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 472 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "20", "evaluated_value": 20, "generated": true }, { "id": "script.enum-value.MapProperty.GlobalDayLightCapacity", "family_id": "script.enum-value.MapProperty.GlobalDayLightCapacity", "kind": "enum-value", "name": "GlobalDayLightCapacity", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.GlobalDayLightCapacity = 22", "description": "Current daylight capacity percentage for light sources flagged as global, clamped to 0 through 100", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 478 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "22", "evaluated_value": 22, "generated": true }, { "id": "script.enum-value.MapProperty.InitScript", "family_id": "script.enum-value.MapProperty.InitScript", "kind": "enum-value", "name": "InitScript", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.InitScript = 4", "description": "Server initialization function called after the map-init event for a newly created or restored map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 420 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "4", "evaluated_value": 4, "generated": true }, { "id": "script.enum-value.MapProperty.ItemIds", "family_id": "script.enum-value.MapProperty.ItemIds", "kind": "enum-value", "name": "ItemIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.ItemIds = 8", "description": "Persistent identifiers of the dynamic items placed directly on this map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 432 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "8", "evaluated_value": 8, "generated": true }, { "id": "script.enum-value.MapProperty.LocId", "family_id": "script.enum-value.MapProperty.LocId", "kind": "enum-value", "name": "LocId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.LocId = 5", "description": "Identifier of the location that owns this map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "5", "evaluated_value": 5, "generated": true }, { "id": "script.enum-value.MapProperty.LocMapIndex", "family_id": "script.enum-value.MapProperty.LocMapIndex", "kind": "enum-value", "name": "LocMapIndex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.LocMapIndex = 6", "description": "Zero-based position of this map in its owning location's map list", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 426 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "6", "evaluated_value": 6, "generated": true }, { "id": "script.enum-value.MapProperty.MapDayColor", "family_id": "script.enum-value.MapProperty.MapDayColor", "kind": "enum-value", "name": "MapDayColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.MapDayColor = 19", "description": "Current client-side map tint supplied through SetDayColors and consumed by map rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 469 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "19", "evaluated_value": 19, "generated": true }, { "id": "script.enum-value.MapProperty.MapDayLightCapacity", "family_id": "script.enum-value.MapProperty.MapDayLightCapacity", "kind": "enum-value", "name": "MapDayLightCapacity", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.MapDayLightCapacity = 21", "description": "Current daylight capacity percentage for ordinary map light sources, clamped to 0 through 100", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 475 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "21", "evaluated_value": 21, "generated": true }, { "id": "script.enum-value.MapProperty.None", "family_id": "script.enum-value.MapProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.None = 0", "description": "Sentinel indicating that no Map property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.MapProperty.RemovedStaticItemIds", "family_id": "script.enum-value.MapProperty.RemovedStaticItemIds", "kind": "enum-value", "name": "RemovedStaticItemIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.RemovedStaticItemIds = 9", "description": "Identifiers of the baked static items this map instance has dropped; removal is one-way for the life of the instance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 435 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "9", "evaluated_value": 9, "generated": true }, { "id": "script.enum-value.MapProperty.ScrollAxialArea", "family_id": "script.enum-value.MapProperty.ScrollAxialArea", "kind": "enum-value", "name": "ScrollAxialArea", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.ScrollAxialArea = 13", "description": "Axial-coordinate rectangle that bounds map scrolling; a zero rectangle leaves the full map available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 447 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "13", "evaluated_value": 13, "generated": true }, { "id": "script.enum-value.MapProperty.ScrollOffset", "family_id": "script.enum-value.MapProperty.ScrollOffset", "kind": "enum-value", "name": "ScrollOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.ScrollOffset = 12", "description": "Rounded client viewport offset in map-space pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 444 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "12", "evaluated_value": 12, "generated": true }, { "id": "script.enum-value.MapProperty.Size", "family_id": "script.enum-value.MapProperty.Size", "kind": "enum-value", "name": "Size", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.Size = 10", "description": "Width and height of the map grid in hexes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 438 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "10", "evaluated_value": 10, "generated": true }, { "id": "script.enum-value.MapProperty.SpritesZoom", "family_id": "script.enum-value.MapProperty.SpritesZoom", "kind": "enum-value", "name": "SpritesZoom", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.SpritesZoom = 14", "description": "Current client map-sprite zoom factor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 450 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "14", "evaluated_value": 14, "generated": true }, { "id": "script.enum-value.MapProperty.SpritesZoomTarget", "family_id": "script.enum-value.MapProperty.SpritesZoomTarget", "kind": "enum-value", "name": "SpritesZoomTarget", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.SpritesZoomTarget = 15", "description": "Target zoom factor toward which the client map view is interpolating", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 453 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "15", "evaluated_value": 15, "generated": true }, { "id": "script.enum-value.MapProperty.WorkHex", "family_id": "script.enum-value.MapProperty.WorkHex", "kind": "enum-value", "name": "WorkHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MapProperty", "signature": "MapProperty.WorkHex = 11", "description": "Authoring work hex used as the initial Mapper view center", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 441 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MapProperty", "value": "11", "evaluated_value": 11, "generated": true }, { "id": "script.enum-value.MouseButton.Ext0", "family_id": "script.enum-value.MouseButton.Ext0", "kind": "enum-value", "name": "Ext0", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Ext0 = 5", "description": "First extended mouse button, mapped from the platform X1 button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 169 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.MouseButton.Ext1", "family_id": "script.enum-value.MouseButton.Ext1", "kind": "enum-value", "name": "Ext1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Ext1 = 6", "description": "Second extended mouse button, mapped from the platform X2 button", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 170 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "6", "evaluated_value": 6, "generated": false }, { "id": "script.enum-value.MouseButton.Ext2", "family_id": "script.enum-value.MouseButton.Ext2", "kind": "enum-value", "name": "Ext2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Ext2 = 7", "description": "Third extended mouse button, mapped from platform button 6", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 171 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "7", "evaluated_value": 7, "generated": false }, { "id": "script.enum-value.MouseButton.Ext3", "family_id": "script.enum-value.MouseButton.Ext3", "kind": "enum-value", "name": "Ext3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Ext3 = 8", "description": "Fourth extended mouse button, mapped from platform button 7", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 172 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.MouseButton.Ext4", "family_id": "script.enum-value.MouseButton.Ext4", "kind": "enum-value", "name": "Ext4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Ext4 = 9", "description": "Fifth extended mouse button, mapped from platform button 8", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 173 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "9", "evaluated_value": 9, "generated": false }, { "id": "script.enum-value.MouseButton.Left", "family_id": "script.enum-value.MouseButton.Left", "kind": "enum-value", "name": "Left", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Left = 0", "description": "Primary mouse button mapped from the platform left-button input", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 164 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.MouseButton.Middle", "family_id": "script.enum-value.MouseButton.Middle", "kind": "enum-value", "name": "Middle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Middle = 2", "description": "Middle mouse button mapped from the platform middle-button input", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 166 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.MouseButton.Right", "family_id": "script.enum-value.MouseButton.Right", "kind": "enum-value", "name": "Right", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.Right = 1", "description": "Secondary mouse button mapped from the platform right-button input", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 165 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.MouseButton.WheelDown", "family_id": "script.enum-value.MouseButton.WheelDown", "kind": "enum-value", "name": "WheelDown", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.WheelDown = 4", "description": "Synthetic button event emitted for downward mouse-wheel motion", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 168 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.MouseButton.WheelUp", "family_id": "script.enum-value.MouseButton.WheelUp", "kind": "enum-value", "name": "WheelUp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MouseButton", "signature": "MouseButton.WheelUp = 3", "description": "Synthetic button event emitted for upward mouse-wheel motion", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 167 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MouseButton", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.MovingState.Attached", "family_id": "script.enum-value.MovingState.Attached", "kind": "enum-value", "name": "Attached", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.Attached = 13", "description": "Independent movement was rejected because the critter is attached to another critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "13", "evaluated_value": 13, "generated": false }, { "id": "script.enum-value.MovingState.CantMove", "family_id": "script.enum-value.MovingState.CantMove", "kind": "enum-value", "name": "CantMove", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.CantMove = 3", "description": "Movement could not start because the critter cannot move", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 49 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.MovingState.Deadlock", "family_id": "script.enum-value.MovingState.Deadlock", "kind": "enum-value", "name": "Deadlock", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.Deadlock = 10", "description": "Path construction encountered a movement deadlock", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "10", "evaluated_value": 10, "generated": false }, { "id": "script.enum-value.MovingState.GagCritter", "family_id": "script.enum-value.MovingState.GagCritter", "kind": "enum-value", "name": "GagCritter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.GagCritter = 4", "description": "Movement was blocked by a critter occupancy callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.MovingState.GagItem", "family_id": "script.enum-value.MovingState.GagItem", "kind": "enum-value", "name": "GagItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.GagItem = 5", "description": "Movement was blocked by an item occupancy callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "5", "evaluated_value": 5, "generated": false }, { "id": "script.enum-value.MovingState.GenericError", "family_id": "script.enum-value.MovingState.GenericError", "kind": "enum-value", "name": "GenericError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.GenericError = 6", "description": "Movement failed without a more specific result", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 52 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "6", "evaluated_value": 6, "generated": false }, { "id": "script.enum-value.MovingState.HexBusy", "family_id": "script.enum-value.MovingState.HexBusy", "kind": "enum-value", "name": "HexBusy", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.HexBusy = 8", "description": "The requested destination hex is occupied or otherwise unavailable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "8", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.MovingState.HexTooFar", "family_id": "script.enum-value.MovingState.HexTooFar", "kind": "enum-value", "name": "HexTooFar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.HexTooFar = 7", "description": "The requested destination is beyond the accepted movement range", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 53 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "7", "evaluated_value": 7, "generated": false }, { "id": "script.enum-value.MovingState.InProgress", "family_id": "script.enum-value.MovingState.InProgress", "kind": "enum-value", "name": "InProgress", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.InProgress = 0", "description": "Movement is active and has not produced a terminal result", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 46 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.MovingState.NotAlive", "family_id": "script.enum-value.MovingState.NotAlive", "kind": "enum-value", "name": "NotAlive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.NotAlive = 12", "description": "Movement was rejected because the critter is not alive", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "12", "evaluated_value": 12, "generated": false }, { "id": "script.enum-value.MovingState.Stopped", "family_id": "script.enum-value.MovingState.Stopped", "kind": "enum-value", "name": "Stopped", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.Stopped = 14", "description": "Movement was cancelled or stopped before reaching the destination", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "14", "evaluated_value": 14, "generated": false }, { "id": "script.enum-value.MovingState.Success", "family_id": "script.enum-value.MovingState.Success", "kind": "enum-value", "name": "Success", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.Success = 1", "description": "Movement reached its requested destination successfully", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.MovingState.TargetNotFound", "family_id": "script.enum-value.MovingState.TargetNotFound", "kind": "enum-value", "name": "TargetNotFound", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.TargetNotFound = 2", "description": "Movement could not resolve the requested target", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 48 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.MovingState.TraceFailed", "family_id": "script.enum-value.MovingState.TraceFailed", "kind": "enum-value", "name": "TraceFailed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingState", "signature": "MovingState.TraceFailed = 11", "description": "Path tracing could not produce a valid route", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MovingState", "value": "11", "evaluated_value": 11, "generated": false }, { "id": "script.enum-value.MultihexGenerationType.AnyUnique", "family_id": "script.enum-value.MultihexGenerationType.AnyUnique", "kind": "enum-value", "name": "AnyUnique", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MultihexGenerationType", "signature": "MultihexGenerationType.AnyUnique = 2", "description": "Coalesces compatible same-prototype items into distinct full-map groups without requiring adjacency", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1085 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MultihexGenerationType", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.MultihexGenerationType.None", "family_id": "script.enum-value.MultihexGenerationType.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MultihexGenerationType", "signature": "MultihexGenerationType.None = 0", "description": "Disables Mapper coalescing of item placements into a multihex mesh", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1083 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MultihexGenerationType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.MultihexGenerationType.SameSibling", "family_id": "script.enum-value.MultihexGenerationType.SameSibling", "kind": "enum-value", "name": "SameSibling", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MultihexGenerationType", "signature": "MultihexGenerationType.SameSibling = 1", "description": "Coalesces spatially adjacent compatible sibling items into one incrementally grown multihex mesh", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1084 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.MultihexGenerationType", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.PlayerProperty.ControlledCritterId", "family_id": "script.enum-value.PlayerProperty.ControlledCritterId", "kind": "enum-value", "name": "ControlledCritterId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.ControlledCritterId = 5", "description": "Identifier of the critter currently controlled by this player; zero when none is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "5", "evaluated_value": 5, "generated": true }, { "id": "script.enum-value.PlayerProperty.CustomHolderEntry", "family_id": "script.enum-value.PlayerProperty.CustomHolderEntry", "kind": "enum-value", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.CustomHolderEntry = 2", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "2", "evaluated_value": 2, "generated": true }, { "id": "script.enum-value.PlayerProperty.CustomHolderId", "family_id": "script.enum-value.PlayerProperty.CustomHolderId", "kind": "enum-value", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.CustomHolderId = 1", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "1", "evaluated_value": 1, "generated": true }, { "id": "script.enum-value.PlayerProperty.ExplicitlyPersistent", "family_id": "script.enum-value.PlayerProperty.ExplicitlyPersistent", "kind": "enum-value", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.ExplicitlyPersistent = 3", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "3", "evaluated_value": 3, "generated": true }, { "id": "script.enum-value.PlayerProperty.LastControlledCritterId", "family_id": "script.enum-value.PlayerProperty.LastControlledCritterId", "kind": "enum-value", "name": "LastControlledCritterId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.LastControlledCritterId = 6", "description": "Persistent identifier of the most recently controlled critter, retained after detachment for restoration", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 96 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "6", "evaluated_value": 6, "generated": true }, { "id": "script.enum-value.PlayerProperty.LoggedIn", "family_id": "script.enum-value.PlayerProperty.LoggedIn", "kind": "enum-value", "name": "LoggedIn", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.LoggedIn = 4", "description": "Reports whether this player connection has completed server login", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 90 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "4", "evaluated_value": 4, "generated": true }, { "id": "script.enum-value.PlayerProperty.None", "family_id": "script.enum-value.PlayerProperty.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "PlayerProperty", "signature": "PlayerProperty.None = 0", "description": "Sentinel indicating that no Player property identifier is selected.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.PlayerProperty", "value": "0", "evaluated_value": 0, "generated": true }, { "id": "script.enum-value.RenderPrimitiveType.LineList", "family_id": "script.enum-value.RenderPrimitiveType.LineList", "kind": "enum-value", "name": "LineList", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "RenderPrimitiveType", "signature": "RenderPrimitiveType.LineList = 1", "description": "Draws each pair of submitted vertices as an independent line segment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Rendering.h", "line": 102 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.RenderPrimitiveType", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.RenderPrimitiveType.LineStrip", "family_id": "script.enum-value.RenderPrimitiveType.LineStrip", "kind": "enum-value", "name": "LineStrip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "RenderPrimitiveType", "signature": "RenderPrimitiveType.LineStrip = 2", "description": "Draws connected line segments and enables primitive restart where supported", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Rendering.h", "line": 103 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.RenderPrimitiveType", "value": "2", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.RenderPrimitiveType.PointList", "family_id": "script.enum-value.RenderPrimitiveType.PointList", "kind": "enum-value", "name": "PointList", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "RenderPrimitiveType", "signature": "RenderPrimitiveType.PointList = 0", "description": "Draws each submitted vertex as an independent point primitive", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Rendering.h", "line": 101 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.RenderPrimitiveType", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.RenderPrimitiveType.TriangleList", "family_id": "script.enum-value.RenderPrimitiveType.TriangleList", "kind": "enum-value", "name": "TriangleList", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "RenderPrimitiveType", "signature": "RenderPrimitiveType.TriangleList = 3", "description": "Draws each group of three submitted vertices as an independent triangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Rendering.h", "line": 104 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.RenderPrimitiveType", "value": "3", "evaluated_value": 3, "generated": false }, { "id": "script.enum-value.RenderPrimitiveType.TriangleStrip", "family_id": "script.enum-value.RenderPrimitiveType.TriangleStrip", "kind": "enum-value", "name": "TriangleStrip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "RenderPrimitiveType", "signature": "RenderPrimitiveType.TriangleStrip = 4", "description": "Draws a connected triangle strip and enables primitive restart where supported", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Rendering.h", "line": 105 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.RenderPrimitiveType", "value": "4", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.ScrollDirection.Down", "family_id": "script.enum-value.ScrollDirection.Down", "kind": "enum-value", "name": "Down", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ScrollDirection", "signature": "ScrollDirection.Down = 0x08", "description": "Scroll toward the lower edge", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1097 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ScrollDirection", "value": "0x08", "evaluated_value": 8, "generated": false }, { "id": "script.enum-value.ScrollDirection.Left", "family_id": "script.enum-value.ScrollDirection.Left", "kind": "enum-value", "name": "Left", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ScrollDirection", "signature": "ScrollDirection.Left = 0x01", "description": "Scroll toward the left edge", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1094 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ScrollDirection", "value": "0x01", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.ScrollDirection.None", "family_id": "script.enum-value.ScrollDirection.None", "kind": "enum-value", "name": "None", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ScrollDirection", "signature": "ScrollDirection.None = 0", "description": "No manual-scroll direction is active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1093 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ScrollDirection", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.ScrollDirection.Right", "family_id": "script.enum-value.ScrollDirection.Right", "kind": "enum-value", "name": "Right", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ScrollDirection", "signature": "ScrollDirection.Right = 0x02", "description": "Scroll toward the right edge", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1095 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ScrollDirection", "value": "0x02", "evaluated_value": 2, "generated": false }, { "id": "script.enum-value.ScrollDirection.Up", "family_id": "script.enum-value.ScrollDirection.Up", "kind": "enum-value", "name": "Up", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ScrollDirection", "signature": "ScrollDirection.Up = 0x04", "description": "Scroll toward the upper edge", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1096 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.ScrollDirection", "value": "0x04", "evaluated_value": 4, "generated": false }, { "id": "script.enum-value.TransparentEggSlot.Primary", "family_id": "script.enum-value.TransparentEggSlot.Primary", "kind": "enum-value", "name": "Primary", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TransparentEggSlot", "signature": "TransparentEggSlot.Primary = 0", "description": "First transparency-egg mask evaluated for map sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/SpriteManager.h", "line": 65 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.TransparentEggSlot", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.TransparentEggSlot.Secondary", "family_id": "script.enum-value.TransparentEggSlot.Secondary", "kind": "enum-value", "name": "Secondary", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TransparentEggSlot", "signature": "TransparentEggSlot.Secondary = 1", "description": "Second independent transparency-egg mask evaluated for map sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/SpriteManager.h", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.TransparentEggSlot", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum-value.TransparentEggTarget.AnyOccluder", "family_id": "script.enum-value.TransparentEggTarget.AnyOccluder", "kind": "enum-value", "name": "AnyOccluder", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TransparentEggTarget", "signature": "TransparentEggTarget.AnyOccluder = 0", "description": "Cut every sprite whose egg appearance places it before the egg", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/SpriteManager.h", "line": 73 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.TransparentEggTarget", "value": "0", "evaluated_value": 0, "generated": false }, { "id": "script.enum-value.TransparentEggTarget.Structure", "family_id": "script.enum-value.TransparentEggTarget.Structure", "kind": "enum-value", "name": "Structure", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TransparentEggTarget", "signature": "TransparentEggTarget.Structure = 1", "description": "Cut walls and roofs only, leaving foreground props drawn", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/SpriteManager.h", "line": 74 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.enum.TransparentEggTarget", "value": "1", "evaluated_value": 1, "generated": false }, { "id": "script.enum.CornerType", "family_id": "script.enum.CornerType", "kind": "enum", "name": "CornerType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CornerType : uint8", "description": "Wall-corner orientation used by map geometry and corner-aware rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1068 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.CritterAction", "family_id": "script.enum.CritterAction", "kind": "enum", "name": "CritterAction", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterAction : uint16", "description": "Engine-originated critter action notifications such as item movement, knockout, death, connection, and respawn.\nSome actions have hardcoded local or server dispatch rules; project code should consume the symbolic action", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 981 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": false }, { "id": "script.enum.CritterActionAnim", "family_id": "script.enum.CritterActionAnim", "kind": "enum", "name": "CritterActionAnim", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterActionAnim : uint16", "description": "Requested critter movement or pose animation passed to model animation resolution", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1006 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": false }, { "id": "script.enum.CritterCondition", "family_id": "script.enum.CritterCondition", "kind": "enum", "name": "CritterCondition", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterCondition : uint8", "description": "High-level life condition of a critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 971 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.CritterFindType", "family_id": "script.enum.CritterFindType", "kind": "enum", "name": "CritterFindType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterFindType : uint8", "description": "Composable filters for selecting critters by life state and player-or-NPC ownership", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1043 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.CritterItemSlot", "family_id": "script.enum.CritterItemSlot", "kind": "enum", "name": "CritterItemSlot", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterItemSlot : uint8", "description": "Logical critter item destinations used for inventory, equipped-main-slot, and outside-item transfers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 962 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.CritterProperty", "family_id": "script.enum.CritterProperty", "kind": "enum", "name": "CritterProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterProperty : uint16", "description": "Generated identifiers for properties exported by the Critter script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.CritterSeeType", "family_id": "script.enum.CritterSeeType", "kind": "enum", "name": "CritterSeeType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterSeeType : uint8", "description": "Perspective used by critter visibility queries: either direction or their union", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1026 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.CritterStateAnim", "family_id": "script.enum.CritterStateAnim", "kind": "enum", "name": "CritterStateAnim", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterStateAnim : uint16", "description": "Persistent critter animation posture passed to model animation resolution", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 998 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": false }, { "id": "script.enum.CritterVisibilityMode", "family_id": "script.enum.CritterVisibilityMode", "kind": "enum", "name": "CritterVisibilityMode", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum CritterVisibilityMode : uint8", "description": "Visibility override applied to a critter independently of normal perception checks", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1035 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.DisconnectReason", "family_id": "script.enum.DisconnectReason", "kind": "enum", "name": "DisconnectReason", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum DisconnectReason : uint8", "description": "Why a connection was closed. Recorded on the connection itself so the reason outlives the code path\nthat ended it and is still readable while scripts run their logout handlers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/ServerConnection.h", "line": 46 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.DrawOrderType", "family_id": "script.enum.DrawOrderType", "kind": "enum", "name": "DrawOrderType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum DrawOrderType : uint8", "description": "Ordered map-render layers spanning flat sprites, lighting, normal objects, particles, and roofs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.EffectType", "family_id": "script.enum.EffectType", "kind": "enum", "name": "EffectType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum EffectType : uint32", "description": "Bit mask selecting the render pipeline or flush stage served by an effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/EffectManager.h", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.EggAppearenceType", "family_id": "script.enum.EggAppearenceType", "kind": "enum", "name": "EggAppearenceType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum EggAppearenceType : uint8", "description": "Conditions under which a map sprite participates in the transparency-egg cutout around the player", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 87 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.EngineInfoMessage", "family_id": "script.enum.EngineInfoMessage", "kind": "enum", "name": "EngineInfoMessage", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum EngineInfoMessage : uint16", "description": "Stable text-message identifiers for connection, authentication, loading, and runtime status feedback. The generic info-message transport treats them as opaque values; embedding projects own their text and dispatch policy", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 410 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": false }, { "id": "script.enum.EventPriority", "family_id": "script.enum.EventPriority", "kind": "enum", "name": "EventPriority", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum EventPriority : int32", "description": "Relative ordering assigned to callbacks subscribed to the same entity event", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 155 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.EventResult", "family_id": "script.enum.EventResult", "kind": "enum", "name": "EventResult", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum EventResult : int32", "description": "Controls whether an entity event callback allows lower-priority callbacks to run", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 145 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.FontFlag", "family_id": "script.enum.FontFlag", "kind": "enum", "name": "FontFlag", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum FontFlag : uint32", "description": "Font flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 64 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.FontType", "family_id": "script.enum.FontType", "kind": "enum", "name": "FontType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum FontType : int32", "description": "Font slot index. Engine ships a single named slot (Default = 0); scripts may add more entries via the codegen Enum annotation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.GameProperty", "family_id": "script.enum.GameProperty", "kind": "enum", "name": "GameProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum GameProperty : uint16", "description": "Generated identifiers for properties exported by the Game script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.ImGuiProperty", "family_id": "script.enum.ImGuiProperty", "kind": "enum", "name": "ImGuiProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGuiProperty : uint16", "description": "Generated identifiers for properties exported by the ImGui script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.ImGui_ButtonFlags", "family_id": "script.enum.ImGui_ButtonFlags", "kind": "enum", "name": "ImGui_ButtonFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_ButtonFlags : uint32", "description": "Mouse-button, overlap, and activation behavior for low-level Dear ImGui buttons", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 404 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_ChildFlags", "family_id": "script.enum.ImGui_ChildFlags", "kind": "enum", "name": "ImGui_ChildFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_ChildFlags : uint32", "description": "Child-window sizing, framing, padding, and navigation flags forwarded to Dear ImGui", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 103 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_Col", "family_id": "script.enum.ImGui_Col", "kind": "enum", "name": "ImGui_Col", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_Col : int32", "description": "Indexed Dear ImGui style-color slots used by scripted theme customization", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 447 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.ImGui_ColorEditFlags", "family_id": "script.enum.ImGui_ColorEditFlags", "kind": "enum", "name": "ImGui_ColorEditFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_ColorEditFlags : uint32", "description": "Picker mode, channel visibility, data format, preview, and input behavior for Dear ImGui color editors", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 415 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_ComboFlags", "family_id": "script.enum.ImGui_ComboFlags", "kind": "enum", "name": "ImGui_ComboFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_ComboFlags : uint32", "description": "Popup height, alignment, and preview behavior for Dear ImGui combo boxes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 320 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_Cond", "family_id": "script.enum.ImGui_Cond", "kind": "enum", "name": "ImGui_Cond", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_Cond : uint32", "description": "Conditions controlling when a queued Dear ImGui state assignment takes effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 119 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_Dir", "family_id": "script.enum.ImGui_Dir", "kind": "enum", "name": "ImGui_Dir", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_Dir : int32", "description": "Cardinal directions and the no-direction sentinel used by Dear ImGui navigation and layout APIs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 378 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.ImGui_FocusedFlags", "family_id": "script.enum.ImGui_FocusedFlags", "kind": "enum", "name": "ImGui_FocusedFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_FocusedFlags : uint32", "description": "Scope and hierarchy filters used by Dear ImGui focus queries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 165 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_HoveredFlags", "family_id": "script.enum.ImGui_HoveredFlags", "kind": "enum", "name": "ImGui_HoveredFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_HoveredFlags : uint32", "description": "Blocking, overlap, timing, and hierarchy filters used by Dear ImGui hover queries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 177 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_InputTextFlags", "family_id": "script.enum.ImGui_InputTextFlags", "kind": "enum", "name": "ImGui_InputTextFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_InputTextFlags : uint32", "description": "Editing, filtering, submission, callback, and read-only behavior for Dear ImGui text input", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 335 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_MouseButton", "family_id": "script.enum.ImGui_MouseButton", "kind": "enum", "name": "ImGui_MouseButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_MouseButton : int32", "description": "Mouse-button identifiers accepted by the Dear ImGui script bindings", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 369 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.ImGui_PopupFlags", "family_id": "script.enum.ImGui_PopupFlags", "kind": "enum", "name": "ImGui_PopupFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_PopupFlags : uint32", "description": "Mouse-button selection and popup-stack policies for opening or closing Dear ImGui popups", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 353 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_SelectableFlags", "family_id": "script.enum.ImGui_SelectableFlags", "kind": "enum", "name": "ImGui_SelectableFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_SelectableFlags : uint32", "description": "Selection, spanning, overlap, and activation behavior for Dear ImGui selectable items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 130 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_SliderFlags", "family_id": "script.enum.ImGui_SliderFlags", "kind": "enum", "name": "ImGui_SliderFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_SliderFlags : uint32", "description": "Clamping and input behavior for Dear ImGui sliders and drag controls", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 389 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_StyleVar", "family_id": "script.enum.ImGui_StyleVar", "kind": "enum", "name": "ImGui_StyleVar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_StyleVar : int32", "description": "Indexed scalar and vector Dear ImGui style variables accepted by style-stack operations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 490 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "int32", "generated": false }, { "id": "script.enum.ImGui_TabBarFlags", "family_id": "script.enum.ImGui_TabBarFlags", "kind": "enum", "name": "ImGui_TabBarFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TabBarFlags : uint32", "description": "Reordering, fitting, selection, and tooltip behavior for Dear ImGui tab bars", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 287 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_TabItemFlags", "family_id": "script.enum.ImGui_TabItemFlags", "kind": "enum", "name": "ImGui_TabItemFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TabItemFlags : uint32", "description": "Visibility, closure, ordering, and tooltip behavior for individual Dear ImGui tabs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 304 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_TableBgTarget", "family_id": "script.enum.ImGui_TableBgTarget", "kind": "enum", "name": "ImGui_TableBgTarget", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TableBgTarget : uint32", "description": "Table background channel targeted by a Dear ImGui cell or row color assignment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 277 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_TableColumnFlags", "family_id": "script.enum.ImGui_TableColumnFlags", "kind": "enum", "name": "ImGui_TableColumnFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TableColumnFlags : uint32", "description": "Per-column visibility, sizing, ordering, sorting, and status flags for Dear ImGui tables", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 239 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_TableFlags", "family_id": "script.enum.ImGui_TableFlags", "kind": "enum", "name": "ImGui_TableFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TableFlags : uint32", "description": "Layout, borders, sizing, scrolling, sorting, and clipping behavior for Dear ImGui tables", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_TableRowFlags", "family_id": "script.enum.ImGui_TableRowFlags", "kind": "enum", "name": "ImGui_TableRowFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TableRowFlags : uint32", "description": "Per-row header and background behavior for Dear ImGui tables", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 269 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_TreeNodeFlags", "family_id": "script.enum.ImGui_TreeNodeFlags", "kind": "enum", "name": "ImGui_TreeNodeFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_TreeNodeFlags : uint32", "description": "Expansion, framing, selection, spanning, and navigation flags for Dear ImGui tree nodes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 142 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ImGui_WindowFlags", "family_id": "script.enum.ImGui_WindowFlags", "kind": "enum", "name": "ImGui_WindowFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ImGui_WindowFlags : uint32", "description": "Window creation and interaction flags forwarded to the embedded Dear ImGui runtime", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/ImGuiExt/ImGuiStuff.h", "line": 74 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint32", "generated": false }, { "id": "script.enum.ItemOwnership", "family_id": "script.enum.ItemOwnership", "kind": "enum", "name": "ItemOwnership", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ItemOwnership : uint8", "description": "Current ownership location of an item: map hex, critter inventory, item container, or no owner", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1058 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.ItemProperty", "family_id": "script.enum.ItemProperty", "kind": "enum", "name": "ItemProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ItemProperty : uint16", "description": "Generated identifiers for properties exported by the Item script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.KeyCode", "family_id": "script.enum.KeyCode", "kind": "enum", "name": "KeyCode", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum KeyCode : uint8", "description": "Physical SDL-scancode key identifiers used by input events and key-state queries, plus a synthetic Text event for UTF-8 text, paste, and drop payloads", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.LocationProperty", "family_id": "script.enum.LocationProperty", "kind": "enum", "name": "LocationProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum LocationProperty : uint16", "description": "Generated identifiers for properties exported by the Location script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.MapLayers", "family_id": "script.enum.MapLayers", "kind": "enum", "name": "MapLayers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum MapLayers : uint8", "description": "The layers a map view draws. The mapper hides one to work on another, so the visible set is editor state\nthe view is told about - a value that changes while the tool runs is not something anyone configures", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1102 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.MapProperty", "family_id": "script.enum.MapProperty", "kind": "enum", "name": "MapProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum MapProperty : uint16", "description": "Generated identifiers for properties exported by the Map script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.MouseButton", "family_id": "script.enum.MouseButton", "kind": "enum", "name": "MouseButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum MouseButton : uint8", "description": "Mouse buttons and wheel directions exposed through application input events", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 161 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.MovingState", "family_id": "script.enum.MovingState", "kind": "enum", "name": "MovingState", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum MovingState : uint8", "description": "Terminal or in-progress result reported by pathfinding and critter movement operations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 43 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.MultihexGenerationType", "family_id": "script.enum.MultihexGenerationType", "kind": "enum", "name": "MultihexGenerationType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum MultihexGenerationType : uint8", "description": "Policy for generating occupied hexes around a multihex prototype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1080 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.PlayerProperty", "family_id": "script.enum.PlayerProperty", "kind": "enum", "name": "PlayerProperty", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum PlayerProperty : uint16", "description": "Generated identifiers for properties exported by the Player script entity. Values are assigned in export order and are intended for property metadata and change notifications.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": null, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint16", "generated": true }, { "id": "script.enum.RenderPrimitiveType", "family_id": "script.enum.RenderPrimitiveType", "kind": "enum", "name": "RenderPrimitiveType", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum RenderPrimitiveType : uint8", "description": "Vertex assembly topology used when submitting primitive draw buffers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Rendering.h", "line": 98 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.ScrollDirection", "family_id": "script.enum.ScrollDirection", "kind": "enum", "name": "ScrollDirection", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum ScrollDirection : uint8", "description": "The manual-scroll intent a view is currently under. Input decides it, the view consumes it, and the two\nnever share a field: a direction is a per-frame intent, not a value anyone configures", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 1090 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.TransparentEggSlot", "family_id": "script.enum.TransparentEggSlot", "kind": "enum", "name": "TransparentEggSlot", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum TransparentEggSlot : uint8", "description": "Selects one of the two simultaneous transparency-egg masks supported by sprite rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/SpriteManager.h", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.enum.TransparentEggTarget", "family_id": "script.enum.TransparentEggTarget", "kind": "enum", "name": "TransparentEggTarget", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "enum TransparentEggTarget : uint8", "description": "Which of the sprites standing in front of an egg's hex the egg cuts", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/SpriteManager.h", "line": 70 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "underlying_type": "uint8", "generated": false }, { "id": "script.event.client.Game.OnConnected", "family_id": "script.event.client.Game.OnConnected", "kind": "event", "name": "OnConnected", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnConnected()", "description": "Runs when the client transport connection is established", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 173 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnConnecting", "family_id": "script.event.client.Game.OnConnecting", "kind": "event", "name": "OnConnecting", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnConnecting()", "description": "Runs immediately before a requested network connection attempt starts", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 167 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnConnectingFailed", "family_id": "script.event.client.Game.OnConnectingFailed", "kind": "event", "name": "OnConnectingFailed", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnConnectingFailed()", "description": "Runs when a network connection attempt fails", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 170 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnCritterAction", "family_id": "script.event.client.Game.OnCritterAction", "kind": "event", "name": "OnCritterAction", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterAction(bool localCall, Critter cr, CritterAction action, int32 actionData, AbstractItem? contextItem)", "description": "Runs before the client applies a critter action; `localCall` distinguishes local initiation from server delivery", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 320 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "localCall", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "action", "type": "CritterAction", "nullable": false, "by_reference": false, "default": null }, { "name": "actionData", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "contextItem", "type": "AbstractItem?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCritterAnimationFallout", "family_id": "script.event.client.Game.OnCritterAnimationFallout", "kind": "event", "name": "OnCritterAnimationFallout", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterAnimationFallout(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, int32& fStateAnim, int32& fActionAnim, int32& fStateAnimEx, int32& fActionAnimEx, uint32& flags)", "description": "Resolves legacy Fallout animation numbers and flags; handlers may replace all output values, while `StopChain` reports resolution failure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 335 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "modelName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "fStateAnim", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "fActionAnim", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "fStateAnimEx", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "fActionAnimEx", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "uint32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.client.Game.OnCritterAnimationFrames", "family_id": "script.event.client.Game.OnCritterAnimationFrames", "kind": "event", "name": "OnCritterAnimationFrames", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterAnimationFrames(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, int32& pass, uint32& flags, int32& ox, int32& oy, string& animName)", "description": "Resolves a 2D animation frame tuple; handlers may replace `pass`, `flags`, offsets, and `animName`, while `StopChain` reports resolution failure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 329 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "modelName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "pass", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "uint32&", "nullable": false, "by_reference": true, "default": null }, { "name": "ox", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "oy", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "animName", "type": "string&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.client.Game.OnCritterAnimationInit", "family_id": "script.event.client.Game.OnCritterAnimationInit", "kind": "event", "name": "OnCritterAnimationInit", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterAnimationInit(Critter cr, CritterStateAnim& stateAnim, CritterActionAnim& actionAnim, AbstractItem? contextItem)", "description": "Runs before critter animation lookup; handlers may replace `stateAnim` and `actionAnim`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 323 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim&", "nullable": false, "by_reference": true, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim&", "nullable": false, "by_reference": true, "default": null }, { "name": "contextItem", "type": "AbstractItem?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCritterAnimationProcess", "family_id": "script.event.client.Game.OnCritterAnimationProcess", "kind": "event", "name": "OnCritterAnimationProcess", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterAnimationProcess(Critter cr, CritterStateAnim stateAnim, CritterActionAnim actionAnim, AbstractItem? contextItem, bool refreshAnim)", "description": "Runs after animation selection and before playback; `refreshAnim` distinguishes view refresh from a queued action", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 326 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "contextItem", "type": "AbstractItem?", "nullable": true, "by_reference": false, "default": null }, { "name": "refreshAnim", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCritterAnimationSubstitute", "family_id": "script.event.client.Game.OnCritterAnimationSubstitute", "kind": "event", "name": "OnCritterAnimationSubstitute", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterAnimationSubstitute(hstring baseModelName, CritterStateAnim baseStateAnim, CritterActionAnim baseActionAnim, hstring& modelName, CritterStateAnim& stateAnim, CritterActionAnim& actionAnim)", "description": "Resolves an animation substitution; handlers may replace the model and animation pair, while `StopChain` reports resolution failure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 332 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "baseModelName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "baseStateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "baseActionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "modelName", "type": "hstring&", "nullable": false, "by_reference": true, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim&", "nullable": false, "by_reference": true, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.client.Game.OnCritterIn", "family_id": "script.event.client.Game.OnCritterIn", "kind": "event", "name": "OnCritterIn", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterIn(Critter cr)", "description": "Runs when a critter enters the client's current visible entity set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 278 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCritterOut", "family_id": "script.event.client.Game.OnCritterOut", "kind": "event", "name": "OnCritterOut", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterOut(Critter cr)", "description": "Runs before a critter leaves the client's current visible entity set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 281 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCritterVisibilityModeChanged", "family_id": "script.event.client.Game.OnCritterVisibilityModeChanged", "kind": "event", "name": "OnCritterVisibilityModeChanged", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCritterVisibilityModeChanged(Critter cr, CritterVisibilityMode mode)", "description": "Runs when a still-visible critter changes visibility mode", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 284 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "mode", "type": "CritterVisibilityMode", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCustomEntityIn", "family_id": "script.event.client.Game.OnCustomEntityIn", "kind": "event", "name": "OnCustomEntityIn", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCustomEntityIn(Entity entity)", "description": "Runs when a custom entity enters the client's replicated entity set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 299 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnCustomEntityOut", "family_id": "script.event.client.Game.OnCustomEntityOut", "kind": "event", "name": "OnCustomEntityOut", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnCustomEntityOut(Entity entity)", "description": "Runs before a custom entity leaves the client's replicated entity set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 302 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnDisconnected", "family_id": "script.event.client.Game.OnDisconnected", "kind": "event", "name": "OnDisconnected", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnDisconnected()", "description": "Runs after the client transport connection closes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 176 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnFinish", "family_id": "script.event.client.Game.OnFinish", "kind": "event", "name": "OnFinish", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnFinish()", "description": "Runs during client shutdown before script modules are finalized", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 164 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnInfoMessage", "family_id": "script.event.client.Game.OnInfoMessage", "kind": "event", "name": "OnInfoMessage", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnInfoMessage(EngineInfoMessage infoMessage, string extraText)", "description": "Runs for an informational message received from the server", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 182 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "infoMessage", "type": "EngineInfoMessage", "nullable": false, "by_reference": false, "default": null }, { "name": "extraText", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnInputLost", "family_id": "script.event.client.Game.OnInputLost", "kind": "event", "name": "OnInputLost", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnInputLost()", "description": "Runs on frames where the application window is not focused and input polling is skipped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 275 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnItemInvIn", "family_id": "script.event.client.Game.OnItemInvIn", "kind": "event", "name": "OnItemInvIn", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnItemInvIn(Item item)", "description": "Runs when an item enters the chosen critter's inventory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 293 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnItemInvOut", "family_id": "script.event.client.Game.OnItemInvOut", "kind": "event", "name": "OnItemInvOut", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnItemInvOut(Item item)", "description": "Runs when an item leaves the chosen critter's inventory, using a detached snapshot of the removed item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 296 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnItemMapIn", "family_id": "script.event.client.Game.OnItemMapIn", "kind": "event", "name": "OnItemMapIn", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnItemMapIn(Item item)", "description": "Runs when an item enters the client's current map-item set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 287 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnItemMapOut", "family_id": "script.event.client.Game.OnItemMapOut", "kind": "event", "name": "OnItemMapOut", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnItemMapOut(Item item)", "description": "Runs before an item leaves the client's current map-item set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 290 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnKeyDown", "family_id": "script.event.client.Game.OnKeyDown", "kind": "event", "name": "OnKeyDown", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnKeyDown(KeyCode key, string text)", "description": "Runs for a key press and includes the associated text input when available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 269 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "key", "type": "KeyCode", "nullable": false, "by_reference": false, "default": null }, { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnKeyUp", "family_id": "script.event.client.Game.OnKeyUp", "kind": "event", "name": "OnKeyUp", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnKeyUp(KeyCode key)", "description": "Runs for a key release", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 272 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "key", "type": "KeyCode", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnLoginSuccess", "family_id": "script.event.client.Game.OnLoginSuccess", "kind": "event", "name": "OnLoginSuccess", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnLoginSuccess()", "description": "Runs when the server accepts login and the client receives the login-success message", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 179 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnLoop", "family_id": "script.event.client.Game.OnLoop", "kind": "event", "name": "OnLoop", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnLoop()", "description": "Runs once per client frame after networking, input, scheduled callbacks, and time events, before map processing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 188 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnMapLoad", "family_id": "script.event.client.Game.OnMapLoad", "kind": "event", "name": "OnMapLoad", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMapLoad()", "description": "Runs after a local or global map-load message has established the new client map context", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 308 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnMapLoaded", "family_id": "script.event.client.Game.OnMapLoaded", "kind": "event", "name": "OnMapLoaded", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMapLoaded()", "description": "Runs when the server confirms map placement and the client marks the map fully loaded", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 311 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnMapUnload", "family_id": "script.event.client.Game.OnMapUnload", "kind": "event", "name": "OnMapUnload", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMapUnload()", "description": "Runs while the current map context is being unloaded", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 314 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnMapView", "family_id": "script.event.client.Game.OnMapView", "kind": "event", "name": "OnMapView", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMapView(mpos hex)", "description": "Runs when the server requests that the client view map around `hex`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 341 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnMouseDown", "family_id": "script.event.client.Game.OnMouseDown", "kind": "event", "name": "OnMouseDown", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMouseDown(MouseButton button)", "description": "Runs for a mouse-button press; wheel steps are exposed as paired virtual button presses and releases", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 239 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "button", "type": "MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnMouseMove", "family_id": "script.event.client.Game.OnMouseMove", "kind": "event", "name": "OnMouseMove", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMouseMove(ipos offsetPos)", "description": "Runs for mouse movement and reports the frame-relative delta in `offsetPos`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 245 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "offsetPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnMouseUp", "family_id": "script.event.client.Game.OnMouseUp", "kind": "event", "name": "OnMouseUp", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnMouseUp(MouseButton button)", "description": "Runs for a mouse-button release; wheel steps are exposed as paired virtual button presses and releases", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 242 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "button", "type": "MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnPreLoadMap", "family_id": "script.event.client.Game.OnPreLoadMap", "kind": "event", "name": "OnPreLoadMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnPreLoadMap(hstring locPid, hstring mapPid, isize& screenSize)", "description": "Runs before a local map view is created; handlers may replace `screenSize` for that map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 305 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "locPid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "mapPid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "screenSize", "type": "isize&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.client.Game.OnReceiveItems", "family_id": "script.event.client.Game.OnReceiveItems", "kind": "event", "name": "OnReceiveItems", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnReceiveItems(Item[] items, any contextParam)", "description": "Runs for a server-delivered item batch reconstructed as detached client item views with project-defined context", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 317 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "items", "type": "Item[]", "nullable": false, "by_reference": false, "default": null }, { "name": "contextParam", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderIface", "family_id": "script.event.client.Game.OnRenderIface", "kind": "event", "name": "OnRenderIface", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderIface()", "description": "Runs during the script drawing scope of each client frame, before queued video is processed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 194 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnRenderMap_AfterFlatSprites", "family_id": "script.event.client.Game.OnRenderMap_AfterFlatSprites", "kind": "event", "name": "OnRenderMap_AfterFlatSprites", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterFlatSprites(Map map, irect drawArea)", "description": "Runs immediately after the flat-sprite pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 209 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_AfterFlushMap", "family_id": "script.event.client.Game.OnRenderMap_AfterFlushMap", "kind": "event", "name": "OnRenderMap_AfterFlushMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterFlushMap(Map map, irect drawArea)", "description": "Runs after the map render target is flushed to the main scene for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 236 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_AfterFog", "family_id": "script.event.client.Game.OnRenderMap_AfterFog", "kind": "event", "name": "OnRenderMap_AfterFog", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterFog(Map map, irect drawArea)", "description": "Runs immediately after the fog pass for `drawArea` when fog rendering is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 227 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_AfterLighting", "family_id": "script.event.client.Game.OnRenderMap_AfterLighting", "kind": "event", "name": "OnRenderMap_AfterLighting", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterLighting(Map map, irect drawArea)", "description": "Runs immediately after the map lighting pass for `drawArea` when lighting is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 215 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_AfterSprites", "family_id": "script.event.client.Game.OnRenderMap_AfterSprites", "kind": "event", "name": "OnRenderMap_AfterSprites", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterSprites(Map map, irect drawArea)", "description": "Runs immediately after the regular map-sprite pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 221 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_AfterSpritesAndFog", "family_id": "script.event.client.Game.OnRenderMap_AfterSpritesAndFog", "kind": "event", "name": "OnRenderMap_AfterSpritesAndFog", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterSpritesAndFog(Map map, irect drawArea)", "description": "Runs after regular sprites and the optional fog pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_AfterTiles", "family_id": "script.event.client.Game.OnRenderMap_AfterTiles", "kind": "event", "name": "OnRenderMap_AfterTiles", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_AfterTiles(Map map, irect drawArea)", "description": "Runs immediately after the map tile pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_BeforeFlatSprites", "family_id": "script.event.client.Game.OnRenderMap_BeforeFlatSprites", "kind": "event", "name": "OnRenderMap_BeforeFlatSprites", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_BeforeFlatSprites(Map map, irect drawArea)", "description": "Runs immediately before the flat-sprite pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 206 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_BeforeFlushMap", "family_id": "script.event.client.Game.OnRenderMap_BeforeFlushMap", "kind": "event", "name": "OnRenderMap_BeforeFlushMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_BeforeFlushMap(Map map, irect drawArea)", "description": "Runs before the map render target is flushed to the main scene for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 233 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_BeforeFog", "family_id": "script.event.client.Game.OnRenderMap_BeforeFog", "kind": "event", "name": "OnRenderMap_BeforeFog", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_BeforeFog(Map map, irect drawArea)", "description": "Runs immediately before the fog pass for `drawArea` when fog rendering is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 224 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_BeforeLighting", "family_id": "script.event.client.Game.OnRenderMap_BeforeLighting", "kind": "event", "name": "OnRenderMap_BeforeLighting", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_BeforeLighting(Map map, irect drawArea)", "description": "Runs immediately before the map lighting pass for `drawArea` when lighting is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_BeforeSprites", "family_id": "script.event.client.Game.OnRenderMap_BeforeSprites", "kind": "event", "name": "OnRenderMap_BeforeSprites", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_BeforeSprites(Map map, irect drawArea)", "description": "Runs immediately before the regular map-sprite pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 218 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_BeforeTiles", "family_id": "script.event.client.Game.OnRenderMap_BeforeTiles", "kind": "event", "name": "OnRenderMap_BeforeTiles", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_BeforeTiles(Map map, irect drawArea)", "description": "Runs immediately before the map tile pass for `drawArea`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 200 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "drawArea", "type": "irect", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnRenderMap_Rebuild", "family_id": "script.event.client.Game.OnRenderMap_Rebuild", "kind": "event", "name": "OnRenderMap_Rebuild", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnRenderMap_Rebuild(Map map)", "description": "Runs when the map render cache is rebuilt", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnScreenScroll", "family_id": "script.event.client.Game.OnScreenScroll", "kind": "event", "name": "OnScreenScroll", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnScreenScroll()", "description": "Runs when the map view's screen offset changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 191 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnScreenSizeChanged", "family_id": "script.event.client.Game.OnScreenSizeChanged", "kind": "event", "name": "OnScreenSizeChanged", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnScreenSizeChanged()", "description": "Runs after the application reports a screen-size change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 338 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnScriptOverrun", "family_id": "script.event.client.Game.OnScriptOverrun", "kind": "event", "name": "OnScriptOverrun", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnScriptOverrun(string entry, timespan execution, timespan lockWait, int32 count)", "description": "Reports a bounded, drained script overrun summary before the next OnLoop callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 185 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "entry", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "execution", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "lockWait", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "count", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnStart", "family_id": "script.event.client.Game.OnStart", "kind": "event", "name": "OnStart", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnStart()", "description": "Runs once after client initialization completes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 161 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [] }, { "id": "script.event.client.Game.OnTouchDoubleTap", "family_id": "script.event.client.Game.OnTouchDoubleTap", "kind": "event", "name": "OnTouchDoubleTap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchDoubleTap(ipos screenPos)", "description": "Runs for a recognized double tap at `screenPos`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 260 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnTouchDown", "family_id": "script.event.client.Game.OnTouchDown", "kind": "event", "name": "OnTouchDown", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchDown(int64 fingerId, ipos screenPos)", "description": "Runs when a touch contact begins at `screenPos`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 248 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "fingerId", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnTouchMove", "family_id": "script.event.client.Game.OnTouchMove", "kind": "event", "name": "OnTouchMove", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchMove(int64 fingerId, ipos screenPos, ipos offsetPos)", "description": "Runs when a touch contact moves, with current screen position and movement delta", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 251 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "fingerId", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "offsetPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnTouchScroll", "family_id": "script.event.client.Game.OnTouchScroll", "kind": "event", "name": "OnTouchScroll", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchScroll(ipos screenPos, ipos offsetPos)", "description": "Runs for a touch-scroll gesture with current screen position and scroll delta", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 263 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "offsetPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnTouchTap", "family_id": "script.event.client.Game.OnTouchTap", "kind": "event", "name": "OnTouchTap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchTap(ipos screenPos)", "description": "Runs for a recognized single tap at `screenPos`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 257 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnTouchUp", "family_id": "script.event.client.Game.OnTouchUp", "kind": "event", "name": "OnTouchUp", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchUp(int64 fingerId, ipos screenPos)", "description": "Runs when a touch contact ends at `screenPos`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "fingerId", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.client.Game.OnTouchZoom", "family_id": "script.event.client.Game.OnTouchZoom", "kind": "event", "name": "OnTouchZoom", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "event Game.OnTouchZoom(ipos screenPos, float32 factor)", "description": "Runs for a touch-zoom gesture with its center and multiplicative `factor`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 266 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "arguments": [ { "name": "screenPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "factor", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.mapper.Game.OnEditMapLoad", "family_id": "script.event.mapper.Game.OnEditMapLoad", "kind": "event", "name": "OnEditMapLoad", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "event Game.OnEditMapLoad(Map map)", "description": "Runs after a map is loaded and normalized, before it is added to the Mapper's loaded-map list", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Tools/Mapper.h", "line": 328 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.mapper.Game.OnEditMapSave", "family_id": "script.event.mapper.Game.OnEditMapSave", "kind": "event", "name": "OnEditMapSave", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "event Game.OnEditMapSave(Map map)", "description": "Runs after Mapper writes a map successfully and before it marks the undo state clean", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Tools/Mapper.h", "line": 331 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.mapper.Game.OnInspectorProperties", "family_id": "script.event.mapper.Game.OnInspectorProperties", "kind": "event", "name": "OnInspectorProperties", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "event Game.OnInspectorProperties(Entity entity, int32[]& properties)", "description": "Runs when the Inspector selects `entity`; handlers populate or reorder the mutable property-index list", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Tools/Mapper.h", "line": 334 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "properties", "type": "int32[]&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.mapper.Game.OnMapperMessage", "family_id": "script.event.mapper.Game.OnMapperMessage", "kind": "event", "name": "OnMapperMessage", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "event Game.OnMapperMessage(string& text)", "description": "Runs for submitted Mapper console text; handlers may replace `text`, and `StopChain` suppresses built-in command parsing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Tools/Mapper.h", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "arguments": [ { "name": "text", "type": "string&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.server.Critter.OnBarter", "family_id": "script.event.server.Critter.OnBarter", "kind": "event", "name": "OnBarter", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnBarter(Critter playerCr, bool begin, int32 barterCount)", "description": "Exposes a project-defined barter lifecycle event; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "playerCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "begin", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "barterCount", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterAppeared", "family_id": "script.event.server.Critter.OnCritterAppeared", "kind": "event", "name": "OnCritterAppeared", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterAppeared(Critter appearedCr)", "description": "Runs when another critter enters this critter's current visibility set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 173 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "appearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterAppearedDist1", "family_id": "script.event.server.Critter.OnCritterAppearedDist1", "kind": "event", "name": "OnCritterAppearedDist1", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterAppearedDist1(Critter appearedCr)", "description": "Runs when another visible critter enters the ShowCritterDist1 distance tier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 176 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "appearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterAppearedDist2", "family_id": "script.event.server.Critter.OnCritterAppearedDist2", "kind": "event", "name": "OnCritterAppearedDist2", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterAppearedDist2(Critter appearedCr)", "description": "Runs when another visible critter enters the ShowCritterDist2 distance tier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 179 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "appearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterAppearedDist3", "family_id": "script.event.server.Critter.OnCritterAppearedDist3", "kind": "event", "name": "OnCritterAppearedDist3", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterAppearedDist3(Critter appearedCr)", "description": "Runs when another visible critter enters the ShowCritterDist3 distance tier", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 182 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "appearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterDisappeared", "family_id": "script.event.server.Critter.OnCritterDisappeared", "kind": "event", "name": "OnCritterDisappeared", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterDisappeared(Critter disappearedCr)", "description": "Runs when another critter leaves this critter's current visibility set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 185 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "disappearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterDisappearedDist1", "family_id": "script.event.server.Critter.OnCritterDisappearedDist1", "kind": "event", "name": "OnCritterDisappearedDist1", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterDisappearedDist1(Critter disappearedCr)", "description": "Runs when another critter leaves the ShowCritterDist1 distance tier or is no longer visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 188 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "disappearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterDisappearedDist2", "family_id": "script.event.server.Critter.OnCritterDisappearedDist2", "kind": "event", "name": "OnCritterDisappearedDist2", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterDisappearedDist2(Critter disappearedCr)", "description": "Runs when another critter leaves the ShowCritterDist2 distance tier or is no longer visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 191 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "disappearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterDisappearedDist3", "family_id": "script.event.server.Critter.OnCritterDisappearedDist3", "kind": "event", "name": "OnCritterDisappearedDist3", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterDisappearedDist3(Critter disappearedCr)", "description": "Runs when another critter leaves the ShowCritterDist3 distance tier or is no longer visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 194 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "disappearedCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnCritterVisibilityModeChanged", "family_id": "script.event.server.Critter.OnCritterVisibilityModeChanged", "kind": "event", "name": "OnCritterVisibilityModeChanged", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnCritterVisibilityModeChanged(Critter targetCr, CritterVisibilityMode mode)", "description": "Runs when `targetCr` remains visible but changes visibility mode for this critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "targetCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "mode", "type": "CritterVisibilityMode", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnFinish", "family_id": "script.event.server.Critter.OnFinish", "kind": "event", "name": "OnFinish", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnFinish()", "description": "Runs while this critter is being finished", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 170 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Critter.OnItemOnMapAppeared", "family_id": "script.event.server.Critter.OnItemOnMapAppeared", "kind": "event", "name": "OnItemOnMapAppeared", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnItemOnMapAppeared(Item item, Critter? dropper)", "description": "Runs when a map item enters this critter's visibility set; `dropper` is present for a direct critter drop", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 200 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "dropper", "type": "Critter?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnItemOnMapChanged", "family_id": "script.event.server.Critter.OnItemOnMapChanged", "kind": "event", "name": "OnItemOnMapChanged", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnItemOnMapChanged(Item item)", "description": "Runs when a still-visible map item's view-relevant state changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 206 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnItemOnMapDisappeared", "family_id": "script.event.server.Critter.OnItemOnMapDisappeared", "kind": "event", "name": "OnItemOnMapDisappeared", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnItemOnMapDisappeared(Item item, Critter? picker)", "description": "Runs when a map item leaves this critter's visibility set; `picker` is present when a critter picks it up", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "picker", "type": "Critter?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Critter.OnTalk", "family_id": "script.event.server.Critter.OnTalk", "kind": "event", "name": "OnTalk", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "event Critter.OnTalk(Critter playerCr, bool begin, int32 talkers)", "description": "Exposes a project-defined talk lifecycle event; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Critter.h", "line": 209 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "playerCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "begin", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "talkers", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterFinish", "family_id": "script.event.server.Game.OnCritterFinish", "kind": "event", "name": "OnCritterFinish", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterFinish(Critter cr)", "description": "Runs while a critter is being finished and before it is unregistered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 270 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterInit", "family_id": "script.event.server.Game.OnCritterInit", "kind": "event", "name": "OnCritterInit", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterInit(Critter cr, bool firstTime)", "description": "Runs once before a critter's own initialization script; `firstTime` distinguishes creation from restore", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 267 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "firstTime", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterItemMoved", "family_id": "script.event.server.Game.OnCritterItemMoved", "kind": "event", "name": "OnCritterItemMoved", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterItemMoved(Critter cr, Item item, CritterItemSlot fromSlot)", "description": "Runs after an item enters, leaves, or changes slot in a critter inventory; `fromSlot` reports its previous slot", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "fromSlot", "type": "CritterItemSlot", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterLoad", "family_id": "script.event.server.Game.OnCritterLoad", "kind": "event", "name": "OnCritterLoad", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterLoad(Critter cr)", "description": "Runs after a persistent critter is loaded and enters server ownership", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 273 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterMoved", "family_id": "script.event.server.Game.OnCritterMoved", "kind": "event", "name": "OnCritterMoved", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterMoved(Critter cr, mpos oldHex)", "description": "Runs after a critter changes map hex and reports the previous hex in `oldHex`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 228 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "oldHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterPreLoad", "family_id": "script.event.server.Game.OnCritterPreLoad", "kind": "event", "name": "OnCritterPreLoad", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterPreLoad(Critter cr)", "description": "Runs after a persistent critter and its owned entities are restored but before world entry; `StopChain` rejects the load", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 264 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterSendInitialInfo", "family_id": "script.event.server.Game.OnCritterSendInitialInfo", "kind": "event", "name": "OnCritterSendInitialInfo", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterSendInitialInfo(Critter cr)", "description": "Runs while the server prepares initial controlled-critter state for its player", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 279 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterStartMoving", "family_id": "script.event.server.Game.OnCritterStartMoving", "kind": "event", "name": "OnCritterStartMoving", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterStartMoving(Critter cr, bool wasMoving)", "description": "Runs after a movement context is activated and broadcast; `wasMoving` reports whether it replaced active movement", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 231 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "wasMoving", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterStopMoving", "family_id": "script.event.server.Game.OnCritterStopMoving", "kind": "event", "name": "OnCritterStopMoving", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterStopMoving(Critter cr)", "description": "Runs after active critter movement is stopped and the resulting state is broadcast", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 234 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterTransfer", "family_id": "script.event.server.Game.OnCritterTransfer", "kind": "event", "name": "OnCritterTransfer", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterTransfer(Critter cr, Map? prevMap)", "description": "Runs after a critter transfer completes; `prevMap` is absent when the critter did not come from a local map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 237 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "prevMap", "type": "Map?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnCritterUnload", "family_id": "script.event.server.Game.OnCritterUnload", "kind": "event", "name": "OnCritterUnload", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnCritterUnload(Critter cr)", "description": "Runs before a persistent critter leaves server ownership without being destroyed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 276 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnFinish", "family_id": "script.event.server.Game.OnFinish", "kind": "event", "name": "OnFinish", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnFinish()", "description": "Runs during server shutdown before script modules are finalized", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Game.OnGenerateWorld", "family_id": "script.event.server.Game.OnGenerateWorld", "kind": "event", "name": "OnGenerateWorld", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnGenerateWorld()", "description": "Runs only for an empty database to create the initial world; `StopChain` aborts server initialization", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 204 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Game.OnGlobalMapCritterIn", "family_id": "script.event.server.Game.OnGlobalMapCritterIn", "kind": "event", "name": "OnGlobalMapCritterIn", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnGlobalMapCritterIn(Critter cr)", "description": "Runs when a critter enters the global-map container", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 240 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnGlobalMapCritterOut", "family_id": "script.event.server.Game.OnGlobalMapCritterOut", "kind": "event", "name": "OnGlobalMapCritterOut", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnGlobalMapCritterOut(Critter cr)", "description": "Runs when a critter leaves the global-map container", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 243 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnInit", "family_id": "script.event.server.Game.OnInit", "kind": "event", "name": "OnInit", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnInit()", "description": "Runs after script modules initialize and before the world is generated or restored; `StopChain` aborts server initialization", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 201 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Game.OnItemFinish", "family_id": "script.event.server.Game.OnItemFinish", "kind": "event", "name": "OnItemFinish", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnItemFinish(Item item)", "description": "Runs while an item is being finished and before it is unregistered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 288 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnItemInit", "family_id": "script.event.server.Game.OnItemInit", "kind": "event", "name": "OnItemInit", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnItemInit(Item item, bool firstTime)", "description": "Runs once before an item's own initialization script; `firstTime` distinguishes creation from restore", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 285 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "firstTime", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnLocationFinish", "family_id": "script.event.server.Game.OnLocationFinish", "kind": "event", "name": "OnLocationFinish", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnLocationFinish(Location location)", "description": "Runs while a location is being finished, before its maps are destroyed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 249 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "location", "type": "Location", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnLocationInit", "family_id": "script.event.server.Game.OnLocationInit", "kind": "event", "name": "OnLocationInit", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnLocationInit(Location location, bool firstTime)", "description": "Runs once before a location's own initialization script; `firstTime` distinguishes creation from restore", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 246 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "location", "type": "Location", "nullable": false, "by_reference": false, "default": null }, { "name": "firstTime", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnMapCritterIn", "family_id": "script.event.server.Game.OnMapCritterIn", "kind": "event", "name": "OnMapCritterIn", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnMapCritterIn(Map map, Critter cr)", "description": "Runs after a critter is attached to a local map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 258 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnMapCritterOut", "family_id": "script.event.server.Game.OnMapCritterOut", "kind": "event", "name": "OnMapCritterOut", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnMapCritterOut(Map map, Critter cr)", "description": "Runs before a critter is detached from a local map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnMapFinish", "family_id": "script.event.server.Game.OnMapFinish", "kind": "event", "name": "OnMapFinish", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnMapFinish(Map map)", "description": "Runs while a map is being finished and before it is unregistered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 255 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnMapInit", "family_id": "script.event.server.Game.OnMapInit", "kind": "event", "name": "OnMapInit", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnMapInit(Map map, bool firstTime)", "description": "Runs once before a map's own initialization script; `firstTime` distinguishes creation from restore", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 252 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "firstTime", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnPlayerCritterSwitched", "family_id": "script.event.server.Game.OnPlayerCritterSwitched", "kind": "event", "name": "OnPlayerCritterSwitched", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnPlayerCritterSwitched(Player player, Critter cr, Critter prevCr)", "description": "Runs after a player switches from `prevCr` to `cr` and initial critter information is sent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 219 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "player", "type": "Player", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "prevCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnPlayerDirCritter", "family_id": "script.event.server.Game.OnPlayerDirCritter", "kind": "event", "name": "OnPlayerDirCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnPlayerDirCritter(Player player, Critter cr, mdir& dir)", "description": "Validates a player direction request; handlers may replace `dir`, and `StopChain` rejects the request", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 225 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "player", "type": "Player", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.server.Game.OnPlayerLogin", "family_id": "script.event.server.Game.OnPlayerLogin", "kind": "event", "name": "OnPlayerLogin", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnPlayerLogin(Player player, Player? notLoggedInPlayer)", "description": "Runs after login success is sent and before post-login setup; `notLoggedInPlayer` is present only during reconnect, and `StopChain` rejects the login", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 213 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "player", "type": "Player", "nullable": false, "by_reference": false, "default": null }, { "name": "notLoggedInPlayer", "type": "Player?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnPlayerLogout", "family_id": "script.event.server.Game.OnPlayerLogout", "kind": "event", "name": "OnPlayerLogout", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnPlayerLogout(Player player)", "description": "Runs after a hard disconnect is observed and before the player is detached and unregistered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 216 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "player", "type": "Player", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Game.OnPlayerMoveCritter", "family_id": "script.event.server.Game.OnPlayerMoveCritter", "kind": "event", "name": "OnPlayerMoveCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnPlayerMoveCritter(Player player, Critter cr, int32& speed)", "description": "Validates a player movement request; handlers may replace `speed`, and `StopChain` rejects the request", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 222 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "player", "type": "Player", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.server.Game.OnStart", "family_id": "script.event.server.Game.OnStart", "kind": "event", "name": "OnStart", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnStart()", "description": "Runs after world generation or restoration and before normal server work; `StopChain` aborts startup", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 207 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Game.OnStaticItemWalk", "family_id": "script.event.server.Game.OnStaticItemWalk", "kind": "event", "name": "OnStaticItemWalk", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "event Game.OnStaticItemWalk(StaticItem item, Critter cr, bool isIn, mdir dir)", "description": "Runs when a critter crosses a static item's trigger footprint; `isIn` distinguishes entry from exit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Server.h", "line": 291 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "item", "type": "StaticItem", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "isIn", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Item.OnCritterWalk", "family_id": "script.event.server.Item.OnCritterWalk", "kind": "event", "name": "OnCritterWalk", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "event Item.OnCritterWalk(Critter critter, bool isIn, mdir dir)", "description": "Runs when a critter crosses this static item's trigger footprint; `isIn` distinguishes entry from exit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Item.h", "line": 87 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "critter", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "isIn", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Item.OnFinish", "family_id": "script.event.server.Item.OnFinish", "kind": "event", "name": "OnFinish", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "event Item.OnFinish()", "description": "Runs while this item is being finished", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Item.h", "line": 84 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Location.OnFinish", "family_id": "script.event.server.Location.OnFinish", "kind": "event", "name": "OnFinish", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "event Location.OnFinish()", "description": "Runs while this location is being finished", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Location.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Location.OnMapAdded", "family_id": "script.event.server.Location.OnMapAdded", "kind": "event", "name": "OnMapAdded", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "event Location.OnMapAdded(Map map)", "description": "Runs after a map is added to this location", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Location.h", "line": 79 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Location.OnMapRemoved", "family_id": "script.event.server.Location.OnMapRemoved", "kind": "event", "name": "OnMapRemoved", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "event Location.OnMapRemoved(Map map)", "description": "Runs when a map is removed from this location", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Location.h", "line": 82 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Map.OnCheckLook", "family_id": "script.event.server.Map.OnCheckLook", "kind": "event", "name": "OnCheckLook", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "event Map.OnCheckLook(Critter cr, Critter target)", "description": "Exposes a project-defined critter visibility check; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Map.h", "line": 146 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "target", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Map.OnCheckTrapLook", "family_id": "script.event.server.Map.OnCheckTrapLook", "kind": "event", "name": "OnCheckTrapLook", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "event Map.OnCheckTrapLook(Critter cr, Item item)", "description": "Exposes a project-defined trap visibility check; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Map.h", "line": 149 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Map.OnFinish", "family_id": "script.event.server.Map.OnFinish", "kind": "event", "name": "OnFinish", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "event Map.OnFinish()", "description": "Runs while this map is being finished", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Map.h", "line": 143 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.event.server.Player.OnAllowCommand", "family_id": "script.event.server.Player.OnAllowCommand", "kind": "event", "name": "OnAllowCommand", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "event Player.OnAllowCommand(string arg1, uint8 arg2)", "description": "Exposes a project-defined command authorization callback; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Player.h", "line": 125 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "arg1", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "arg2", "type": "uint8", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.event.server.Player.OnGetAccess", "family_id": "script.event.server.Player.OnGetAccess", "kind": "event", "name": "OnGetAccess", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "event Player.OnGetAccess(int32 arg1, string& arg2)", "description": "Exposes a project-defined player access callback with an integer input and mutable text argument; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Player.h", "line": 122 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [ { "name": "arg1", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "arg2", "type": "string&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.event.server.Player.OnLogout", "family_id": "script.event.server.Player.OnLogout", "kind": "event", "name": "OnLogout", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "event Player.OnLogout()", "description": "Exposes a project-defined player logout callback; Engine does not fire it directly", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Server/Player.h", "line": 128 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "arguments": [] }, { "id": "script.method.client.Critter.AddAnimCallback", "family_id": "script.method.client.Critter.AddAnimCallback", "kind": "method", "name": "AddAnimCallback", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.AddAnimCallback(CritterStateAnim stateAnim, CritterActionAnim actionAnim, float32 normalizedTime, callback(void,Critter) animCallback)", "description": "Registers a deferred callback at the clamped normalized time of the selected 3D animation tuple; does nothing without a model, skips destroyed critters, and throws off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 362 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "normalizedTime", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "animCallback", "type": "callback(void,Critter)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.Animate", "family_id": "script.method.client.Critter.Animate", "kind": "method", "name": "Animate", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.Animate(CritterStateAnim stateAnim, CritterActionAnim actionAnim, AbstractItem? contextItem = null, bool append = false)", "description": "Queues the requested visual animation with an optional item context, clearing the existing sequence first unless append is true; throws when the critter is off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 189 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "contextItem", "type": "AbstractItem?", "nullable": true, "by_reference": false, "default": "null" }, { "name": "append", "type": "bool", "nullable": false, "by_reference": false, "default": "false" } ] }, { "id": "script.method.client.Critter.ChangeDir", "family_id": "script.method.client.Critter.ChangeDir", "kind": "method", "name": "ChangeDir", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.ChangeDir(mdir dir)", "description": "Changes the local facing direction of this map critter through the normal client presentation path; throws when the critter is off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 497 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetAlpha", "family_id": "script.method.client.Critter.GetAlpha", "kind": "method", "name": "GetAlpha", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "uint8 Critter.GetAlpha()", "description": "Returns the map sprite's current rendered alpha, or 255 when the critter is outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 506 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "uint8", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.GetBodyAngle", "family_id": "script.method.client.Critter.GetBodyAngle", "kind": "method", "name": "GetBodyAngle", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "int16 Critter.GetBodyAngle()", "description": "Returns the rendered 3D body angle in degrees when a model is available, otherwise the critter's discrete direction angle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 471 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "int16", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.GetBonePos", "family_id": "script.method.client.Critter.GetBonePos", "kind": "method", "name": "GetBonePos", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.GetBonePos(hstring boneName, ipos& boneOffset)", "description": "Writes the screen-space position of a named bone and returns true; returns false for a 2D critter or missing bone and throws when 3D support is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 393 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "boneName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "boneOffset", "type": "ipos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Critter.GetItem#20907df3571a66a9", "family_id": "script.method.client.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(ItemProperty property, int32 propertyValue)", "description": "Returns the first visible inventory item whose integer-convertible property equals the requested value, or null when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 277 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetItem#3e4a8f273e418d3b", "family_id": "script.method.client.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(ident itemId)", "description": "Returns the visible inventory item with this entity id, or null when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 219 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetItem#5042179ea08a430e", "family_id": "script.method.client.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(hstring protoId)", "description": "Returns a visible inventory item with this prototype id, preferring the Inventory slot for non-stackable items; throws when the prototype id is invalid", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 227 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetItem#8eedde0030f87e84", "family_id": "script.method.client.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(ProtoItem proto)", "description": "Returns a visible inventory item matching the supplied prototype, preferring the Inventory slot for non-stackable items, or null when absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 255 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetItems#83c145745774df22", "family_id": "script.method.client.Critter.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "Item[] Critter.GetItems(ItemProperty property, int32 propertyValue)", "description": "Returns a snapshot of visible inventory items whose integer-convertible property equals the requested value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 311 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetItems#b851260ade7c353c", "family_id": "script.method.client.Critter.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "Item[] Critter.GetItems()", "description": "Returns a snapshot of handles to every item in this client-side inventory view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 295 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.GetModelAnimDuration", "family_id": "script.method.client.Critter.GetModelAnimDuration", "kind": "method", "name": "GetModelAnimDuration", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "timespan Critter.GetModelAnimDuration(CritterStateAnim stateAnim, CritterActionAnim actionAnim)", "description": "Returns the resolved runtime duration of an animation on the critter's loaded 3D model, or zero for a non-model or unresolved tuple; throws off-map or when 3D support is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "timespan", "nullable": false }, "arguments": [ { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.GetMovingContext", "family_id": "script.method.client.Critter.GetMovingContext", "kind": "method", "name": "GetMovingContext", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "MovingContext? Critter.GetMovingContext()", "description": "Returns the current client-side movement context for this map critter, or null when stationary; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 110 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "MovingContext?", "nullable": true }, "arguments": [] }, { "id": "script.method.client.Critter.GetSpriteOffset", "family_id": "script.method.client.Critter.GetSpriteOffset", "kind": "method", "name": "GetSpriteOffset", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "ipos Critter.GetSpriteOffset()", "description": "Returns the current rendered pixel offset of this map critter's sprite; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 140 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "ipos", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.GetTextPos", "family_id": "script.method.client.Critter.GetTextPos", "kind": "method", "name": "GetTextPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.GetTextPos(ipos& pos)", "description": "Writes the screen position for name text above a valid map sprite and returns true, or false when no valid sprite is available; throws when the critter is off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 332 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Critter.IsAlive", "family_id": "script.method.client.Critter.IsAlive", "kind": "method", "name": "IsAlive", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsAlive()", "description": "Reports whether the critter's replicated condition is alive", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 73 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsAnimAvailable", "family_id": "script.method.client.Critter.IsAnimAvailable", "kind": "method", "name": "IsAnimAvailable", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsAnimAvailable(CritterStateAnim stateAnim, CritterActionAnim actionAnim)", "description": "Reports whether the current map presentation can resolve the requested state and action animation tuple; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 148 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.IsAnimPlaying", "family_id": "script.method.client.Critter.IsAnimPlaying", "kind": "method", "name": "IsAnimPlaying", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsAnimPlaying()", "description": "Reports whether this map critter currently has an active visual animation; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 181 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsDead", "family_id": "script.method.client.Critter.IsDead", "kind": "method", "name": "IsDead", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsDead()", "description": "Reports whether the critter's replicated condition is dead", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 87 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsKnockout", "family_id": "script.method.client.Critter.IsKnockout", "kind": "method", "name": "IsKnockout", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsKnockout()", "description": "Reports whether the critter's replicated condition is knockout", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 80 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsModel", "family_id": "script.method.client.Critter.IsModel", "kind": "method", "name": "IsModel", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsModel()", "description": "Reports whether this map critter uses a loaded 3D model; returns false when 3D support is disabled and throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 119 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsMoving", "family_id": "script.method.client.Critter.IsMoving", "kind": "method", "name": "IsMoving", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsMoving()", "description": "Reports whether this map critter is undergoing client-side movement; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 102 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsOffline", "family_id": "script.method.client.Critter.IsOffline", "kind": "method", "name": "IsOffline", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsOffline()", "description": "Reports whether this critter is player-controlled and its replicated player-offline flag is set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsOnMap", "family_id": "script.method.client.Critter.IsOnMap", "kind": "method", "name": "IsOnMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsOnMap()", "description": "Reports whether this client-side critter view is currently represented on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 94 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.IsVisible", "family_id": "script.method.client.Critter.IsVisible", "kind": "method", "name": "IsVisible", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsVisible()", "description": "Returns whether this map critter's sprite currently participates in rendering; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 132 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.MoveItemLocally", "family_id": "script.method.client.Critter.MoveItemLocally", "kind": "method", "name": "MoveItemLocally", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.MoveItemLocally(ident itemId, ident swapItemId, CritterItemSlot toSlot)", "description": "Applies a local predicted drop, slot move, or optional slot swap and refreshes map action and lighting visuals; it does not send an authoritative server request", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 530 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "swapItemId", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "toSlot", "type": "CritterItemSlot", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.MoveToDir", "family_id": "script.method.client.Critter.MoveToDir", "kind": "method", "name": "MoveToDir", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.MoveToDir(mdir dir, int32 speed)", "description": "Starts client-side movement of this map critter in the requested direction and at the requested speed; throws when the critter is off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 453 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.MoveToHex#8abbda72eb8c68b8", "family_id": "script.method.client.Critter.MoveToHex", "kind": "method", "name": "MoveToHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "MovingContext? Critter.MoveToHex(mpos hex, ipos hexOffset, int32 speed)", "description": "Starts local movement exactly to the target hex and clamped sub-hex offset, returning the movement context or null when no movement remains; throws off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 424 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "MovingContext?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "hexOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.MoveToHex#c8ad324f4c60aadb", "family_id": "script.method.client.Critter.MoveToHex", "kind": "method", "name": "MoveToHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "MovingContext? Critter.MoveToHex(mpos hex, int32 cut, ipos hexOffset, int32 speed)", "description": "Starts local movement toward the target while retaining the requested cut distance and clamped sub-hex offset, returning the resulting context; throws off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 439 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "MovingContext?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "hexOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.RefreshView", "family_id": "script.method.client.Critter.RefreshView", "kind": "method", "name": "RefreshView", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.RefreshView()", "description": "Reapplies the map critter's scale and movement presentation and refreshes its base visual animation when no explicit animation is active; throws off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 211 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.RunParticle", "family_id": "script.method.client.Critter.RunParticle", "kind": "method", "name": "RunParticle", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.RunParticle(string particleName, hstring boneName, float32 moveX, float32 moveY, float32 moveZ)", "description": "Starts a named particle on a bone of the critter's loaded 3D model with the supplied offset; does nothing for 2D or non-3D builds and throws off-map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 340 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "particleName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "boneName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "moveX", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "moveY", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "moveZ", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.SetAlpha", "family_id": "script.method.client.Critter.SetAlpha", "kind": "method", "name": "SetAlpha", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.SetAlpha(uint8 alpha)", "description": "Fades a map critter's sprite toward the requested target alpha; does nothing when the critter is outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 519 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "alpha", "type": "uint8", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.SetName", "family_id": "script.method.client.Critter.SetName", "kind": "method", "name": "SetName", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.SetName(string name)", "description": "Replaces the display name stored in this client-side critter view without updating authoritative server state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Critter.StopAnim", "family_id": "script.method.client.Critter.StopAnim", "kind": "method", "name": "StopAnim", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.StopAnim()", "description": "Clears the active and queued visual animations of this map critter; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Critter.StopMove", "family_id": "script.method.client.Critter.StopMove", "kind": "method", "name": "StopMove", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "void Critter.StopMove()", "description": "Stops the current client-side movement of this map critter; throws when the critter is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientCritterScriptMethods.cpp", "line": 462 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Entity.CountTimeEvent#08f3341698dc846a", "family_id": "script.method.client.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity,any) func)", "description": "Counts all client time events bound to this entity that use the selected callback", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 134 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.CountTimeEvent#5609075e34e56857", "family_id": "script.method.client.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity) func)", "description": "Counts all client time events bound to this entity that use the selected callback", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 127 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.CountTimeEvent#9c7dd3ed70f86a7d", "family_id": "script.method.client.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity,TimeEventContext) func)", "description": "Counts all client time events bound to this entity that use the selected callback", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 148 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.CountTimeEvent#ad56856359be786a", "family_id": "script.method.client.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity,any[]) func)", "description": "Counts all client time events bound to this entity that use the selected callback", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 141 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.CountTimeEvent#e41a67022275199d", "family_id": "script.method.client.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(uint32 id)", "description": "Returns one when a client time event with this id is bound to the entity, or zero when it is absent", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 155 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.RepeatTimeEvent#28154675b58100aa", "family_id": "script.method.client.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(uint32 id, timespan repeat)", "description": "Sets the repeat interval for the event with this id and reschedules its next firing from now; does nothing when it is absent", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 225 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.RepeatTimeEvent#35eb685e9352ee97", "family_id": "script.method.client.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity,any) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 204 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.RepeatTimeEvent#4c1ec6146e414fed", "family_id": "script.method.client.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity,any[]) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 211 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.RepeatTimeEvent#d107502adf65e851", "family_id": "script.method.client.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity,TimeEventContext) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 218 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.RepeatTimeEvent#d3e5bb91010a5ee6", "family_id": "script.method.client.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.SetTimeEventData#09c025b7150b6bcd", "family_id": "script.method.client.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,any) func, any data)", "description": "Replaces the single payload value for every time event using the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 232 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.SetTimeEventData#46ce3a8e59df0b76", "family_id": "script.method.client.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,any[]) func, any[] data)", "description": "Replaces the payload array for every time event using the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 239 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.SetTimeEventData#995b7ca79df38c35", "family_id": "script.method.client.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(uint32 id, any data)", "description": "Replaces the single payload value for the time event with this id; does nothing when it is absent", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 260 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.SetTimeEventData#adb2b4962b8e3874", "family_id": "script.method.client.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(uint32 id, any[] data)", "description": "Replaces the payload array for the time event with this id; does nothing when it is absent", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 267 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.SetTimeEventData#c02fbdd5c31ecb21", "family_id": "script.method.client.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any[] data)", "description": "Replaces the context payload array for every time event using the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 253 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.SetTimeEventData#c41820f30638ac18", "family_id": "script.method.client.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any data)", "description": "Replaces the single context payload value for every time event using the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 246 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#170befe9003e3411", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any data)", "description": "Schedules a repeating client time event whose callback context exposes one payload value, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#1e937a7976df63ac", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func)", "description": "Schedules a one-shot client time event whose callback receives a context for inspecting or modifying that event, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 64 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#492d95e09fb651ed", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any[] data)", "description": "Schedules a one-shot client time event whose callback context exposes the payload array, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 78 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#494379a91f97d59e", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity) func)", "description": "Schedules a repeating client time event bound to this entity, with its first firing after delay and later firings at repeat, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#64daaaa7e6125cb3", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any[] data)", "description": "Schedules a repeating client time event whose callback context exposes the payload array, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 120 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#805b4b72ba72a604", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any[]) func, any[] data)", "description": "Schedules a repeating client time event with a callback payload array and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#9e1b092a1d7fb963", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any) func, any data)", "description": "Schedules a repeating client time event with one callback payload value and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#ae9a39c7d8c1d6fa", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any) func, any data)", "description": "Schedules a one-shot client time event bound to this entity, passes one payload value to the callback, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#af2f95f5513a4cfa", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func)", "description": "Schedules a repeating client time event whose callback receives a context for inspecting or modifying that event, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 106 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#b494dfd4a4fa81ea", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any[]) func, any[] data)", "description": "Schedules a one-shot client time event bound to this entity, passes the payload array to the callback, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#d9b6635334d5ae05", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any data)", "description": "Schedules a one-shot client time event whose callback context exposes one payload value, and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 71 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StartTimeEvent#e59548a665ddb838", "family_id": "script.method.client.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity) func)", "description": "Schedules a one-shot client time event bound to this entity after the requested delay and returns its event id", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 43 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StopTimeEvent#1ff4e8b7bdb6f35c", "family_id": "script.method.client.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity,any) func)", "description": "Stops all client time events bound to this entity that use the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 169 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StopTimeEvent#58fd464d379e5ea5", "family_id": "script.method.client.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity,TimeEventContext) func)", "description": "Stops all client time events bound to this entity that use the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 183 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StopTimeEvent#be90949683fff93d", "family_id": "script.method.client.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(uint32 id)", "description": "Stops the client time event with this id when it is bound to the entity; does nothing when it is absent", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 190 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StopTimeEvent#d792082ed73a8fc8", "family_id": "script.method.client.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity) func)", "description": "Stops all client time events bound to this entity that use the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 162 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Entity.StopTimeEvent#ddfbd34ed1764f92", "family_id": "script.method.client.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "client", "mapper" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity,any[]) func)", "description": "Stops all client time events bound to this entity that use the selected callback; does nothing when none match", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientEntityScriptMethods.cpp", "line": 176 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ActivateOffscreenSurface", "family_id": "script.method.client.Game.ActivateOffscreenSurface", "kind": "method", "name": "ActivateOffscreenSurface", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.ActivateOffscreenSurface(bool forceClear)", "description": "During RenderIface, pushes a pooled screen-sized offscreen render target, clearing it when forced, dirty, or resized; presentations must consume active surfaces in stack order", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1608 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "forceClear", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.BindFont", "family_id": "script.method.client.Game.BindFont", "kind": "method", "name": "BindFont", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.BindFont(FontType font, string fontFname, float32 defaultScale = 1.0f)", "description": "Binds a .fofnt or .fnt resource to a client font slot with the supplied default scale; throws for any other extension", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 875 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "font", "type": "FontType", "nullable": false, "by_reference": false, "default": null }, { "name": "fontFname", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "defaultScale", "type": "float32", "nullable": false, "by_reference": false, "default": "1.0f" } ] }, { "id": "script.method.client.Game.BytesReceive", "family_id": "script.method.client.Game.BytesReceive", "kind": "method", "name": "BytesReceive", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.BytesReceive()", "description": "Returns the connection's cumulative received-byte counter narrowed to uint32", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 416 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.BytesSend", "family_id": "script.method.client.Game.BytesSend", "kind": "method", "name": "BytesSend", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.BytesSend()", "description": "Returns the connection's cumulative sent-byte counter narrowed to uint32", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 409 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.CaptureScreenshot", "family_id": "script.method.client.Game.CaptureScreenshot", "kind": "method", "name": "CaptureScreenshot", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint8[] Game.CaptureScreenshot(int32 maxSide)", "description": "Returns the last complete frame as compact RGB PNG bytes, downscaled to maxSide when positive", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1817 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint8[]", "nullable": false }, "arguments": [ { "name": "maxSide", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ChangeLanguage", "family_id": "script.method.client.Game.ChangeLanguage", "kind": "method", "name": "ChangeLanguage", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.ChangeLanguage(string langName)", "description": "Loads the named language pack and makes it current without changing the configured startup language", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1973 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "langName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.Chosen", "family_id": "script.method.client.Game.Chosen", "kind": "method", "name": "Chosen", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Critter Game.Chosen()", "description": "Returns the chosen critter, or throws when none is currently assigned; check HasChosen first when absence is expected", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.ClearEffectScriptValues", "family_id": "script.method.client.Game.ClearEffectScriptValues", "kind": "method", "name": "ClearEffectScriptValues", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.ClearEffectScriptValues(EffectType effectType, int64 effectSubtype)", "description": "Clears all script values associated with the selected effect instance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 917 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectType", "type": "EffectType", "nullable": false, "by_reference": false, "default": null }, { "name": "effectSubtype", "type": "int64", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ClearForcedMousePos", "family_id": "script.method.client.Game.ClearForcedMousePos", "kind": "method", "name": "ClearForcedMousePos", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.ClearForcedMousePos()", "description": "Stops overriding the client's logical mouse position after input polling", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1966 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.Connect", "family_id": "script.method.client.Game.Connect", "kind": "method", "name": "Connect", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.Connect()", "description": "Queues a client connection request for processing by the main loop", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1989 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.CreateVideoPlayback", "family_id": "script.method.client.Game.CreateVideoPlayback", "kind": "method", "name": "CreateVideoPlayback", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "VideoPlayback Game.CreateVideoPlayback(string videoName, bool looped)", "description": "Creates an independently drawable video playback object from a required resource, configures looping, and transfers ownership to the script", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 746 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "VideoPlayback", "nullable": false }, "arguments": [ { "name": "videoName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "looped", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.CurLocation", "family_id": "script.method.client.Game.CurLocation", "kind": "method", "name": "CurLocation", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Location Game.CurLocation()", "description": "Returns the current Location view, or throws when none is available; check HasCurLocation first when absence is expected", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 96 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.CurMap", "family_id": "script.method.client.Game.CurMap", "kind": "method", "name": "CurMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Map Game.CurMap()", "description": "Returns the current local Map view, or throws when none is loaded; check HasCurMap first when absence is expected", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 116 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Map", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.CurPlayer", "family_id": "script.method.client.Game.CurPlayer", "kind": "method", "name": "CurPlayer", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Player Game.CurPlayer()", "description": "Returns the current Player view, or throws when none is available; check HasCurPlayer first when absence is expected", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Player", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.Disconnect", "family_id": "script.method.client.Game.Disconnect", "kind": "method", "name": "Disconnect", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.Disconnect()", "description": "Cancels any pending connection request and disconnects the active transport", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1996 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.DrawCritter2d", "family_id": "script.method.client.Game.DrawCritter2d", "kind": "method", "name": "DrawCritter2d", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawCritter2d(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, mdir dir, int32 l, int32 t, int32 r, int32 b, bool scratch, bool center, ucolor color)", "description": "Draws the resolved current 2D critter frame into the supplied bounds, forwarding scratch and center scaling modes; unresolved animation tuples are ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1418 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "modelName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "l", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "t", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "r", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "b", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "scratch", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "center", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawCritter3d", "family_id": "script.method.client.Game.DrawCritter3d", "kind": "method", "name": "DrawCritter3d", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawCritter3d(uint32 instance, hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, int32[] layers, float32[] position, ucolor color)", "description": "Draws a cached 3D critter instance using layers and optional position values x, y, rotations, scales, speed, normalized time, and scissor bounds; throws without 3D support", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1429 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "instance", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "modelName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "layers", "type": "int32[]", "nullable": false, "by_reference": false, "default": null }, { "name": "position", "type": "float32[]", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawMiniMap", "family_id": "script.method.client.Game.DrawMiniMap", "kind": "method", "name": "DrawMiniMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawMiniMap(int32 zoom, int32 x, int32 y, int32 w, int32 h)", "description": "Prepares or refreshes the current local-map minimap for the supplied zoom and rectangle, then draws its line primitives", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 360 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "zoom", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "x", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "y", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "w", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "h", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawPrimitive", "family_id": "script.method.client.Game.DrawPrimitive", "kind": "method", "name": "DrawPrimitive", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawPrimitive(RenderPrimitiveType primitiveType, int32[] data)", "description": "During RenderIface, draws primitive points decoded from complete x, y, packed-color triplets; empty data is ignored and trailing incomplete values are dropped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1396 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "primitiveType", "type": "RenderPrimitiveType", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "int32[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawSprite#09e9c2f9becdf091", "family_id": "script.method.client.Game.DrawSprite", "kind": "method", "name": "DrawSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawSprite(uint32 sprId, ipos pos, ucolor color = ucolor(), bool offs = false)", "description": "During RenderIface, draws a loaded sprite at an integer position; offs applies bottom-center anchoring plus the sprite offset, and an empty color uses neutral tint", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1257 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": "ucolor()" }, { "name": "offs", "type": "bool", "nullable": false, "by_reference": false, "default": "false" } ] }, { "id": "script.method.client.Game.DrawSprite#779a85d218769bd8", "family_id": "script.method.client.Game.DrawSprite", "kind": "method", "name": "DrawSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawSprite(uint32 sprId, fpos pos, fsize size, ucolor color)", "description": "During RenderIface, draws a loaded sprite at a floating-point position scaled to the supplied size; an empty color uses neutral tint", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1299 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "fsize", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawSprite#7bcbb90671d41361", "family_id": "script.method.client.Game.DrawSprite", "kind": "method", "name": "DrawSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawSprite(uint32 sprId, fpos pos, ucolor color)", "description": "During RenderIface, draws a loaded sprite at a floating-point position using its intrinsic size; an empty color uses neutral tint", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawSprite#f68df76d1db1b23c", "family_id": "script.method.client.Game.DrawSprite", "kind": "method", "name": "DrawSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawSprite(uint32 sprId, ipos pos, isize size, ucolor color = ucolor(), bool fit = true, bool offs = false)", "description": "During RenderIface, draws a loaded sprite into an integer rectangle with optional fitting and sprite-offset application; an empty color uses neutral tint", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1316 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": "ucolor()" }, { "name": "fit", "type": "bool", "nullable": false, "by_reference": false, "default": "true" }, { "name": "offs", "type": "bool", "nullable": false, "by_reference": false, "default": "false" } ] }, { "id": "script.method.client.Game.DrawSpritePattern", "family_id": "script.method.client.Game.DrawSpritePattern", "kind": "method", "name": "DrawSpritePattern", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawSpritePattern(uint32 sprId, ipos pos, isize size, isize sprSize, ucolor color)", "description": "During RenderIface, tiles a loaded sprite over the supplied rectangle using sprSize as the tile dimensions; an empty color uses neutral tint", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1334 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "sprSize", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawSpriteRegion", "family_id": "script.method.client.Game.DrawSpriteRegion", "kind": "method", "name": "DrawSpriteRegion", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.DrawSpriteRegion(uint32 sprId, fpos uv0, fpos uv1, ipos pos, isize size, ucolor color = ucolor())", "description": "During RenderIface, draws a UV region of a loaded sprite into the supplied rectangle and returns the renderer result, or false for an unknown handle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1351 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "uv0", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "uv1", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": "ucolor()" } ] }, { "id": "script.method.client.Game.DrawText", "family_id": "script.method.client.Game.DrawText", "kind": "method", "name": "DrawText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawText(string text, ipos pos, isize size, ucolor color, TextFormat format)", "description": "During RenderIface, draws nonempty formatted text in the supplied rectangle; negative dimensions extend left or up, and an empty color uses text white", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1368 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null }, { "name": "format", "type": "TextFormat", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DrawVideoPlayback", "family_id": "script.method.client.Game.DrawVideoPlayback", "kind": "method", "name": "DrawVideoPlayback", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DrawVideoPlayback(VideoPlayback? video, ipos pos, isize size)", "description": "During RenderIface, advances and draws a non-null video playback into a positive-size rectangle and marks the object stopped when its clip ends", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 769 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "video", "type": "VideoPlayback?", "nullable": true, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.DumpAtlases", "family_id": "script.method.client.Game.DumpAtlases", "kind": "method", "name": "DumpAtlases", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.DumpAtlases()", "description": "Writes every current texture atlas to a timestamped diagnostic PNG directory whose name includes total atlas memory use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 342 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.FlashUnfocusedWindow", "family_id": "script.method.client.Game.FlashUnfocusedWindow", "kind": "method", "name": "FlashUnfocusedWindow", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.FlashUnfocusedWindow()", "description": "Requests a taskbar or window-manager attention flash only when the client window is unfocused", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1980 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.FreeSprite", "family_id": "script.method.client.Game.FreeSprite", "kind": "method", "name": "FreeSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.FreeSprite(uint32 sprId)", "description": "Releases a client-local sprite handle, stopping its animation and retaining the resource in the reuse cache; unknown handles are ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1110 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetCacheData", "family_id": "script.method.client.Game.GetCacheData", "kind": "method", "name": "GetCacheData", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint8[] Game.GetCacheData(string name)", "description": "Returns the bytes stored under a client cache entry name, or an empty array when the entry cannot be read", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1890 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint8[]", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetCacheText", "family_id": "script.method.client.Game.GetCacheText", "kind": "method", "name": "GetCacheText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string Game.GetCacheText(string name)", "description": "Returns the string stored under a client cache entry name, or an empty string when the entry cannot be read", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1904 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetCritter", "family_id": "script.method.client.Game.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Critter? Game.GetCritter(ident crId)", "description": "Finds a critter by id on the current local map, or among global-map critters when no local map is loaded; returns null for zero, absent, or destroying local-map entries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 500 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "crId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetCritters#81d4328569cd9426", "family_id": "script.method.client.Game.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Critter[] Game.GetCritters(CritterFindType findType)", "description": "Returns current local-map or global-map critters that satisfy the requested CritterFindType filter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 527 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetCritters#addc705539406d44", "family_id": "script.method.client.Game.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Critter[] Game.GetCritters(hstring pid, CritterFindType findType)", "description": "Returns current local-map or global-map critters that match the optional prototype id and requested CritterFindType filter; an empty id matches every prototype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 561 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetCritters#e79de6b56cb9f3b3", "family_id": "script.method.client.Game.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Critter[] Game.GetCritters(ProtoCritter proto, CritterFindType findType)", "description": "Returns current local-map or global-map critters whose prototype id matches the supplied prototype and that satisfy the requested CritterFindType filter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 615 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#1be05ad1508d9bdf", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Item item1, Item item2)", "description": "Returns center-to-center hex distance between two items on the same map; throws for off-map or different-map inputs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 214 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "item1", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "item2", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#200d823fdf545d92", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Item item, Critter cr)", "description": "Returns center-to-edge hex distance from an item to a critter on the same map after subtracting the critter multihex radius; throws for off-map or different-map inputs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#33a4d51ef8eece2a", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(mpos hex, Critter cr)", "description": "Returns center-to-edge hex distance from a hex to an on-map critter after subtracting its multihex radius; throws when the critter is off map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 295 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#3dade8869ec8c0ac", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Critter cr, Item item)", "description": "Returns edge-to-center hex distance from a critter to an item on the same map after subtracting the critter multihex radius; throws for off-map or different-map inputs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 234 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#8298d537bb9c7c37", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Item item, mpos hex)", "description": "Returns center-to-center hex distance from an on-map item to a hex; throws when the item is off map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 327 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#8a80a760debf852d", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Critter cr, mpos hex)", "description": "Returns edge-to-center hex distance from an on-map critter to a hex after subtracting its multihex radius; throws when the critter is off map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 278 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#b273c01749f73e8c", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(mpos hex, Item item)", "description": "Returns center-to-center hex distance from a hex to an on-map item; throws when the item is off map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 312 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDistance#dacea0c00ba4c5f1", "family_id": "script.method.client.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Critter cr1, Critter cr2)", "description": "Returns edge-to-edge hex distance between two critters on the same map after subtracting both multihex radii; throws for off-map or different-map inputs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 192 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr1", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "cr2", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetDrawCritter3dBounds", "family_id": "script.method.client.Game.GetDrawCritter3dBounds", "kind": "method", "name": "GetDrawCritter3dBounds", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.GetDrawCritter3dBounds(uint32 instance, irect& drawRect, irect& viewRect)", "description": "Returns positive draw and view bounds for a previously loaded 3D critter instance, false when unavailable, and throws without 3D support", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1537 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "instance", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "drawRect", "type": "irect&", "nullable": false, "by_reference": true, "default": null }, { "name": "viewRect", "type": "irect&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Game.GetGamepadState", "family_id": "script.method.client.Game.GetGamepadState", "kind": "method", "name": "GetGamepadState", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "GamepadState Game.GetGamepadState()", "description": "Returns a snapshot of the active input backend's gamepad state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 143 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "GamepadState", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.GetItem", "family_id": "script.method.client.Game.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Item? Game.GetItem(ident itemId)", "description": "Finds a live item by nonzero id, searching the chosen inventory first and then visible map/global-map items and critter inventories; returns null when absent or destroyed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 430 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetMusicVolume", "family_id": "script.method.client.Game.GetMusicVolume", "kind": "method", "name": "GetMusicVolume", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetMusicVolume()", "description": "Returns the live music-volume percentage owned by the audio manager", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 381 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.GetPing", "family_id": "script.method.client.Game.GetPing", "kind": "method", "name": "GetPing", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetPing()", "description": "Returns the most recently measured client-server round-trip time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.GetSoundNames", "family_id": "script.method.client.Game.GetSoundNames", "kind": "method", "name": "GetSoundNames", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string[] Game.GetSoundNames()", "description": "Returns the source-backed audio resource paths indexed by Audio.SoundFileExtensions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 691 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string[]", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.GetSoundVolume", "family_id": "script.method.client.Game.GetSoundVolume", "kind": "method", "name": "GetSoundVolume", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetSoundVolume()", "description": "Returns the live sound-effect volume percentage owned by the audio manager", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 395 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.GetSpriteSize", "family_id": "script.method.client.Game.GetSpriteSize", "kind": "method", "name": "GetSpriteSize", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "isize Game.GetSpriteSize(uint32 sprId)", "description": "Returns the current sprite size for a client-local handle, or a zero size when the handle is unknown", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1117 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "isize", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetText#18a1958c0507d2fd", "family_id": "script.method.client.Game.GetText", "kind": "method", "name": "GetText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string Game.GetText(TextPackKey textKey, int32 textIndex)", "description": "Returns the zero-based current-language text variant for a key; an out-of-range index yields an empty string and a negative index throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 814 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null }, { "name": "textIndex", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetText#513ec7ba7fb47b7c", "family_id": "script.method.client.Game.GetText", "kind": "method", "name": "GetText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string Game.GetText(string langName, TextPackKey textKey)", "description": "Returns the text for a key from the requested language pack, using the current pack for an empty or current language name and caching other loaded packs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 800 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "langName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetText#6f20bf83e45a6a6d", "family_id": "script.method.client.Game.GetText", "kind": "method", "name": "GetText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string Game.GetText(TextPackKey textKey)", "description": "Returns the first current-language text variant for a key", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 807 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetTextCount", "family_id": "script.method.client.Game.GetTextCount", "kind": "method", "name": "GetTextCount", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetTextCount(TextPackKey textKey)", "description": "Returns the number of current-language text variants registered for a key", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 825 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.GetTextInfo", "family_id": "script.method.client.Game.GetTextInfo", "kind": "method", "name": "GetTextInfo", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.GetTextInfo(string text, isize size, TextFormat format, isize& resultSize, int32& resultLines)", "description": "Measures formatted text inside the supplied size, writing its resulting extent and line count, and throws when the selected font cannot be evaluated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1241 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "format", "type": "TextFormat", "nullable": false, "by_reference": false, "default": null }, { "name": "resultSize", "type": "isize&", "nullable": false, "by_reference": true, "default": null }, { "name": "resultLines", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Game.GetTextLines", "family_id": "script.method.client.Game.GetTextLines", "kind": "method", "name": "GetTextLines", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetTextLines(isize size, FontType font)", "description": "Returns how many complete lines of the selected font fit within a positive-size rectangle, or zero for nonpositive dimensions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1250 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "font", "type": "FontType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.HasChosen", "family_id": "script.method.client.Game.HasChosen", "kind": "method", "name": "HasChosen", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.HasChosen()", "description": "Returns whether the client currently has a chosen critter", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 49 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.HasCurLocation", "family_id": "script.method.client.Game.HasCurLocation", "kind": "method", "name": "HasCurLocation", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.HasCurLocation()", "description": "Returns whether the client currently has a Location view", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.HasCurMap", "family_id": "script.method.client.Game.HasCurMap", "kind": "method", "name": "HasCurMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.HasCurMap()", "description": "Returns whether the client is currently displaying a local Map view", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 109 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.HasCurPlayer", "family_id": "script.method.client.Game.HasCurPlayer", "kind": "method", "name": "HasCurPlayer", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.HasCurPlayer()", "description": "Returns whether the client currently has a replicated Player view", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.IsAlwaysOnTop", "family_id": "script.method.client.Game.IsAlwaysOnTop", "kind": "method", "name": "IsAlwaysOnTop", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsAlwaysOnTop()", "description": "Reports whether the client window currently stays above other windows", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 367 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.IsCacheEntry", "family_id": "script.method.client.Game.IsCacheEntry", "kind": "method", "name": "IsCacheEntry", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsCacheEntry(string name)", "description": "Returns whether the named client cache entry exists", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1911 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.IsConnected", "family_id": "script.method.client.Game.IsConnected", "kind": "method", "name": "IsConnected", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsConnected()", "description": "Returns whether the client connection is currently established", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 185 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.IsConnecting", "family_id": "script.method.client.Game.IsConnecting", "kind": "method", "name": "IsConnecting", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsConnecting()", "description": "Returns whether a connection attempt is currently in progress", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.IsFullscreen", "family_id": "script.method.client.Game.IsFullscreen", "kind": "method", "name": "IsFullscreen", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsFullscreen()", "description": "Returns whether the client window is currently fullscreen", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 157 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.IsMouseAvailable", "family_id": "script.method.client.Game.IsMouseAvailable", "kind": "method", "name": "IsMouseAvailable", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsMouseAvailable()", "description": "Returns whether the active input backend currently exposes mouse input", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 136 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.IsSpriteHit", "family_id": "script.method.client.Game.IsSpriteHit", "kind": "method", "name": "IsSpriteHit", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsSpriteHit(uint32 sprId, ipos pos)", "description": "Hit-tests a client position against the current sprite frame and returns false when the handle is unknown", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1130 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.IsTextPresent", "family_id": "script.method.client.Game.IsTextPresent", "kind": "method", "name": "IsTextPresent", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsTextPresent(TextPackKey textKey)", "description": "Returns whether the current language pack contains the supplied text key", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 832 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.IsVideoPlaying", "family_id": "script.method.client.Game.IsVideoPlaying", "kind": "method", "name": "IsVideoPlaying", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsVideoPlaying()", "description": "Returns whether a fullscreen video clip is currently active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 739 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.LoadMapSprite#7a0d7d6483239069", "family_id": "script.method.client.Game.LoadMapSprite", "kind": "method", "name": "LoadMapSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.LoadMapSprite(string sprName)", "description": "Loads a named sprite into the map-sprite atlas, starts its default animation, and returns a client-local handle, or zero when unresolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1082 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "sprName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.LoadMapSprite#aefb44cb240c9375", "family_id": "script.method.client.Game.LoadMapSprite", "kind": "method", "name": "LoadMapSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.LoadMapSprite(hstring nameHash)", "description": "Loads a hashed sprite resource into the map-sprite atlas, starts its default animation, and returns a client-local handle, or zero when unresolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1089 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "nameHash", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.LoadSeparateSprite#7a0d7d6483239069", "family_id": "script.method.client.Game.LoadSeparateSprite", "kind": "method", "name": "LoadSeparateSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.LoadSeparateSprite(string sprName)", "description": "Loads a named sprite as a separate one-image texture, starts its default animation, and returns a client-local handle, or zero when unresolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1096 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "sprName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.LoadSeparateSprite#aefb44cb240c9375", "family_id": "script.method.client.Game.LoadSeparateSprite", "kind": "method", "name": "LoadSeparateSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.LoadSeparateSprite(hstring nameHash)", "description": "Loads a hashed sprite resource as a separate one-image texture, starts its default animation, and returns a client-local handle, or zero when unresolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1103 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "nameHash", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.LoadSprite#7a0d7d6483239069", "family_id": "script.method.client.Game.LoadSprite", "kind": "method", "name": "LoadSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.LoadSprite(string sprName)", "description": "Loads a named sprite into the interface atlas, starts its default animation, and returns a client-local handle, or zero when unresolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1068 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "sprName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.LoadSprite#aefb44cb240c9375", "family_id": "script.method.client.Game.LoadSprite", "kind": "method", "name": "LoadSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.LoadSprite(hstring nameHash)", "description": "Loads a hashed sprite resource into the interface atlas, starts its default animation, and returns a client-local handle, or zero when unresolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1075 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "nameHash", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.MinimizeWindow", "family_id": "script.method.client.Game.MinimizeWindow", "kind": "method", "name": "MinimizeWindow", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.MinimizeWindow()", "description": "Requests minimization of the client window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 171 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.MousePos", "family_id": "script.method.client.Game.MousePos", "kind": "method", "name": "MousePos", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "ipos Game.MousePos()", "description": "Returns the latest mouse position processed by the client input pipeline", "flags": [ "Getter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 129 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "ipos", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.PlayMusic", "family_id": "script.method.client.Game.PlayMusic", "kind": "method", "name": "PlayMusic", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.PlayMusic(string musicName, timespan repeatTime)", "description": "Starts named music with the supplied repeat delay and returns whether playback was accepted; an empty name stops current music and returns true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 720 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "musicName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "repeatTime", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PlayParticleWithSeed", "family_id": "script.method.client.Game.PlayParticleWithSeed", "kind": "method", "name": "PlayParticleWithSeed", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.PlayParticleWithSeed(uint32 sprId, int32 seed)", "description": "Starts a loaded particle sprite with a deterministic seed and returns false for an unknown handle, non-particle sprite, or rejected playback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1202 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "seed", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PlaySound#1aa5e922f54f38a5", "family_id": "script.method.client.Game.PlaySound", "kind": "method", "name": "PlaySound", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.PlaySound(string soundName, float32 attenuation, float32 pan)", "description": "Starts the exact baked audio resource with initial attenuation and pan and returns its lifetime handle, or zero on failure", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 706 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "soundName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "attenuation", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "pan", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PlaySound#fac885e1d1fb5d17", "family_id": "script.method.client.Game.PlaySound", "kind": "method", "name": "PlaySound", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.PlaySound(string soundName)", "description": "Starts the exact baked audio resource and returns its non-reused lifetime handle, or zero when no live sound starts", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 699 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "soundName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PlaySprite", "family_id": "script.method.client.Game.PlaySprite", "kind": "method", "name": "PlaySprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PlaySprite(uint32 sprId, hstring animName, bool looped, bool reversed)", "description": "Starts the named animation on a client-local sprite with the requested looping and reverse flags; unknown handles are ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1189 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "animName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "looped", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "reversed", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PlayVideo", "family_id": "script.method.client.Game.PlayVideo", "kind": "method", "name": "PlayVideo", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PlayVideo(string videoName, bool canInterrupt, bool enqueue)", "description": "Starts fullscreen video playback, optionally queueing behind an active video; a nonqueued request replaces playback and clears the queue, and an empty name stops it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 732 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "videoName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "canInterrupt", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "enqueue", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PopDrawScissor", "family_id": "script.method.client.Game.PopDrawScissor", "kind": "method", "name": "PopDrawScissor", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PopDrawScissor()", "description": "Pops the top drawing scissor rectangle from the client renderer stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1582 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.Preload3dFiles", "family_id": "script.method.client.Game.Preload3dFiles", "kind": "method", "name": "Preload3dFiles", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.Preload3dFiles(string[] fnames)", "description": "Preloads each named model through the 3D model manager; throws when the 3D submodule or model sprite factory is unavailable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 857 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fnames", "type": "string[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PresentOffscreenSurface#2119d712f785fe8c", "family_id": "script.method.client.Game.PresentOffscreenSurface", "kind": "method", "name": "PresentOffscreenSurface", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PresentOffscreenSurface(int32 effectSubtype, int32 fromX, int32 fromY, int32 fromW, int32 fromH, int32 toX, int32 toY, int32 toW, int32 toH)", "description": "During RenderIface, consumes the active offscreen surface and draws independently clamped source and destination rectangles with the selected effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1706 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "fromX", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "fromY", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "fromW", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "fromH", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "toX", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "toY", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "toW", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "toH", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PresentOffscreenSurface#3c10a5be709fae45", "family_id": "script.method.client.Game.PresentOffscreenSurface", "kind": "method", "name": "PresentOffscreenSurface", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PresentOffscreenSurface(int32 effectSubtype, ipos pos, isize size)", "description": "During RenderIface, consumes the active offscreen surface and draws the clamped same-position source and destination rectangle with the selected effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1661 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PresentOffscreenSurface#5ec3a0fd048629a1", "family_id": "script.method.client.Game.PresentOffscreenSurface", "kind": "method", "name": "PresentOffscreenSurface", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PresentOffscreenSurface(int32 effectSubtype, ipos pos, isize size, float32 scriptValue0, float32 scriptValue1, float32 scriptValue2, float32 scriptValue3)", "description": "During RenderIface, sets the first four script values when supported, then consumes and draws the active offscreen surface in the clamped rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1678 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "scriptValue0", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "scriptValue1", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "scriptValue2", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "scriptValue3", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PresentOffscreenSurface#81efefba57ca2d31", "family_id": "script.method.client.Game.PresentOffscreenSurface", "kind": "method", "name": "PresentOffscreenSurface", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PresentOffscreenSurface(int32 effectSubtype)", "description": "During RenderIface, consumes the active offscreen surface and draws it over the screen with the selected offscreen effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1651 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PrewarmParticle", "family_id": "script.method.client.Game.PrewarmParticle", "kind": "method", "name": "PrewarmParticle", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.PrewarmParticle(uint32 sprId)", "description": "Advances a loaded particle sprite through its prewarm phase and returns false for an unknown handle or non-particle sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1221 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.PushDrawScissor", "family_id": "script.method.client.Game.PushDrawScissor", "kind": "method", "name": "PushDrawScissor", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.PushDrawScissor(ipos pos, isize size)", "description": "Pushes a drawing scissor rectangle onto the client renderer stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1575 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.RemoveCacheEntry", "family_id": "script.method.client.Game.RemoveCacheEntry", "kind": "method", "name": "RemoveCacheEntry", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.RemoveCacheEntry(string name)", "description": "Removes the named client cache entry when present", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1918 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ReplaceText#587f96d5350d1194", "family_id": "script.method.client.Game.ReplaceText", "kind": "method", "name": "ReplaceText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string Game.ReplaceText(string text, string from, string to)", "description": "Returns a copy of text with occurrences of the supplied substring replaced by another string", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 839 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "from", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "to", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ReplaceText#75a7b30c3e8c914d", "family_id": "script.method.client.Game.ReplaceText", "kind": "method", "name": "ReplaceText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "string Game.ReplaceText(string text, string from, int64 to)", "description": "Returns a copy of text with occurrences of the supplied substring replaced by the decimal representation of an integer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 848 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "from", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "to", "type": "int64", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SaveScreenshot", "family_id": "script.method.client.Game.SaveScreenshot", "kind": "method", "name": "SaveScreenshot", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SaveScreenshot(string filePath)", "description": "Reads the last main render target, corrects backend vertical flipping, and writes a PNG to a required nonempty path", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1794 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "filePath", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SaveText", "family_id": "script.method.client.Game.SaveText", "kind": "method", "name": "SaveText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SaveText(string filePath, string text)", "description": "Creates parent directories and truncates the target file before writing the supplied text bytes; write and directory failures throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1842 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "filePath", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ScreenSize", "family_id": "script.method.client.Game.ScreenSize", "kind": "method", "name": "ScreenSize", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "isize Game.ScreenSize()", "description": "Returns the current logical screen size", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 150 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "isize", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.SetAlwaysOnTop", "family_id": "script.method.client.Game.SetAlwaysOnTop", "kind": "method", "name": "SetAlwaysOnTop", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetAlwaysOnTop(bool enable)", "description": "Enables or disables the client window's always-on-top mode", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 374 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "enable", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetCacheData#34c4e9183aea7e54", "family_id": "script.method.client.Game.SetCacheData", "kind": "method", "name": "SetCacheData", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetCacheData(string name, uint8[] data, int32 dataSize)", "description": "Stores a resized copy of the byte array under a client cache entry, truncating or zero-extending it to a required nonnegative dataSize", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1877 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "uint8[]", "nullable": false, "by_reference": false, "default": null }, { "name": "dataSize", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetCacheData#4fb7a51531e48788", "family_id": "script.method.client.Game.SetCacheData", "kind": "method", "name": "SetCacheData", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetCacheData(string name, uint8[] data)", "description": "Stores the complete byte array under a client cache entry name", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1870 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "uint8[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetCacheText", "family_id": "script.method.client.Game.SetCacheText", "kind": "method", "name": "SetCacheText", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetCacheText(string name, string str)", "description": "Stores a string under a client cache entry name", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1897 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "str", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetEffect", "family_id": "script.method.client.Game.SetEffect", "kind": "method", "name": "SetEffect", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetEffect(EffectType effectType, int64 effectSubtype, string effectPath)", "description": "Rebinds effect slots selected by EffectType to an effect resource; subtype selects entity, font, or offscreen instances where that effect class requires one", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 890 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectType", "type": "EffectType", "nullable": false, "by_reference": false, "default": null }, { "name": "effectSubtype", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "effectPath", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetEffectScriptValue", "family_id": "script.method.client.Game.SetEffectScriptValue", "kind": "method", "name": "SetEffectScriptValue", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetEffectScriptValue(EffectType effectType, int64 effectSubtype, int32 valueIndex, float32 value)", "description": "Writes one script float at a validated index in the selected effect instance's script-value buffer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 897 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectType", "type": "EffectType", "nullable": false, "by_reference": false, "default": null }, { "name": "effectSubtype", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "valueIndex", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetEffectScriptValues", "family_id": "script.method.client.Game.SetEffectScriptValues", "kind": "method", "name": "SetEffectScriptValues", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetEffectScriptValues(EffectType effectType, int64 effectSubtype, int32 valueStartIndex, float32[] values, int32 valuesOffset = 0, int32 valuesCount = -1)", "description": "Copies a validated slice of the supplied values into the selected effect instance's script-value buffer starting at valueStartIndex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 904 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "effectType", "type": "EffectType", "nullable": false, "by_reference": false, "default": null }, { "name": "effectSubtype", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "valueStartIndex", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "values", "type": "float32[]", "nullable": false, "by_reference": false, "default": null }, { "name": "valuesOffset", "type": "int32", "nullable": false, "by_reference": false, "default": "0" }, { "name": "valuesCount", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.client.Game.SetForcedMousePos", "family_id": "script.method.client.Game.SetForcedMousePos", "kind": "method", "name": "SetForcedMousePos", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetForcedMousePos(ipos pos)", "description": "Forces the client's logical mouse position to the supplied value after each input poll without moving the native cursor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1958 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetMousePos", "family_id": "script.method.client.Game.SetMousePos", "kind": "method", "name": "SetMousePos", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetMousePos(ipos pos)", "description": "Moves the native input backend's mouse cursor to the supplied client position", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1951 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetMusicVolume", "family_id": "script.method.client.Game.SetMusicVolume", "kind": "method", "name": "SetMusicVolume", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetMusicVolume(int32 volume)", "description": "Changes the live music-volume percentage without mutating startup settings", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 388 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "volume", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetParticleScale", "family_id": "script.method.client.Game.SetParticleScale", "kind": "method", "name": "SetParticleScale", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.SetParticleScale(uint32 sprId, float32 scale)", "description": "Changes the scale of a loaded particle sprite and returns false for an unknown handle or non-particle sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1169 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "scale", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetResolution", "family_id": "script.method.client.Game.SetResolution", "kind": "method", "name": "SetResolution", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetResolution(int32 width, int32 height)", "description": "Changes the logical screen size and, for a non-virtual window, the native client window size to the supplied dimensions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 349 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "width", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "height", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetScreenKeyboard", "family_id": "script.method.client.Game.SetScreenKeyboard", "kind": "method", "name": "SetScreenKeyboard", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetScreenKeyboard(bool enabled)", "description": "Enables or disables the active input backend's on-screen keyboard", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 2003 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "enabled", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetSoundVolume", "family_id": "script.method.client.Game.SetSoundVolume", "kind": "method", "name": "SetSoundVolume", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetSoundVolume(int32 volume)", "description": "Changes the live sound-effect volume percentage without mutating startup settings", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 402 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "volume", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetSpriteTime", "family_id": "script.method.client.Game.SetSpriteTime", "kind": "method", "name": "SetSpriteTime", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetSpriteTime(uint32 sprId, float32 normalizedTime)", "description": "Sets the normalized playback time of a client-local sprite; unknown handles are ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "normalizedTime", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetUserConfig#404272fae1b8c4d2", "family_id": "script.method.client.Game.SetUserConfig", "kind": "method", "name": "SetUserConfig", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetUserConfig(string[] keyValues)", "description": "Replaces the cached user configuration with consecutive key/value pairs serialized as `key = value`, ignoring an unmatched final element", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1938 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "keyValues", "type": "string[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SetUserConfig#83f675b8f444529f", "family_id": "script.method.client.Game.SetUserConfig", "kind": "method", "name": "SetUserConfig", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetUserConfig(string=>string keyValues)", "description": "Replaces the cached user configuration with key/value lines serialized as `key = value`", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1925 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "keyValues", "type": "string=>string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateConnectingFailed", "family_id": "script.method.client.Game.SimulateConnectingFailed", "kind": "method", "name": "SimulateConnectingFailed", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateConnectingFailed()", "description": "Raises the client connecting-failed event as the transport would deliver it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1020 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.SimulateDisconnect", "family_id": "script.method.client.Game.SimulateDisconnect", "kind": "method", "name": "SimulateDisconnect", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateDisconnect()", "description": "Raises the disconnect notification without touching the connection itself", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1011 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.SimulateInfoMessage", "family_id": "script.method.client.Game.SimulateInfoMessage", "kind": "method", "name": "SimulateInfoMessage", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateInfoMessage(EngineInfoMessage infoMessage, string extraText = \"\")", "description": "Raises an engine info message with optional extra text, as the server would deliver it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1027 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "infoMessage", "type": "EngineInfoMessage", "nullable": false, "by_reference": false, "default": null }, { "name": "extraText", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" } ] }, { "id": "script.method.client.Game.SimulateKeyPress", "family_id": "script.method.client.Game.SimulateKeyPress", "kind": "method", "name": "SimulateKeyPress", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateKeyPress(KeyCode key, string text = \"\")", "description": "Injects a key-down event carrying optional text followed by key-up; KeyCode::None is a no-op", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1034 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "key", "type": "KeyCode", "nullable": false, "by_reference": false, "default": null }, { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" } ] }, { "id": "script.method.client.Game.SimulateKeyboardPress", "family_id": "script.method.client.Game.SimulateKeyboardPress", "kind": "method", "name": "SimulateKeyboardPress", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateKeyboardPress(KeyCode key1, KeyCode key2, string key1Text, string key2Text)", "description": "Injects key1 down, a complete key2 press, then key1 up, skipping either KeyCode::None value and doing nothing when both are None", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1046 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "key1", "type": "KeyCode", "nullable": false, "by_reference": false, "default": null }, { "name": "key2", "type": "KeyCode", "nullable": false, "by_reference": false, "default": null }, { "name": "key1Text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "key2Text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateMouseClick", "family_id": "script.method.client.Game.SimulateMouseClick", "kind": "method", "name": "SimulateMouseClick", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateMouseClick(ipos pos, MouseButton button)", "description": "Moves the simulated mouse when needed and injects either a wheel step or a matching button-down/button-up pair", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 961 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "button", "type": "MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateMouseDown", "family_id": "script.method.client.Game.SimulateMouseDown", "kind": "method", "name": "SimulateMouseDown", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateMouseDown(ipos pos, MouseButton button)", "description": "Moves the simulated mouse to the requested position when needed, then injects a button-down event", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 935 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "button", "type": "MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateMouseMove", "family_id": "script.method.client.Game.SimulateMouseMove", "kind": "method", "name": "SimulateMouseMove", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateMouseMove(ipos pos)", "description": "Injects a mouse-move input event when the requested position differs from the current client mouse position, including the computed delta", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 924 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateMouseUp", "family_id": "script.method.client.Game.SimulateMouseUp", "kind": "method", "name": "SimulateMouseUp", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateMouseUp(ipos pos, MouseButton button)", "description": "Moves the simulated mouse to the requested position when needed, then injects a button-up event", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 948 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "button", "type": "MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateTouchDown", "family_id": "script.method.client.Game.SimulateTouchDown", "kind": "method", "name": "SimulateTouchDown", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateTouchDown(int64 fingerId, ipos pos)", "description": "Injects a touch-down event for the supplied finger id and client position", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 983 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fingerId", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateTouchMove", "family_id": "script.method.client.Game.SimulateTouchMove", "kind": "method", "name": "SimulateTouchMove", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateTouchMove(int64 fingerId, ipos pos, ipos offsetPos)", "description": "Injects a touch-move event with the supplied finger id, position, and movement offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 990 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fingerId", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "offsetPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateTouchTap", "family_id": "script.method.client.Game.SimulateTouchTap", "kind": "method", "name": "SimulateTouchTap", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateTouchTap(ipos pos)", "description": "Injects a touch-tap event at the supplied client position", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1004 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SimulateTouchUp", "family_id": "script.method.client.Game.SimulateTouchUp", "kind": "method", "name": "SimulateTouchUp", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.SimulateTouchUp(int64 fingerId, ipos pos)", "description": "Injects a touch-up event for the supplied finger id and client position", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 997 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fingerId", "type": "int64", "nullable": false, "by_reference": false, "default": null }, { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.SortCrittersByDeep", "family_id": "script.method.client.Game.SortCrittersByDeep", "kind": "method", "name": "SortCrittersByDeep", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "Critter[] Game.SortCrittersByDeep(Critter[] critters)", "description": "Drops null handles and stably sorts critters by map render depth: hex Y, hex X, then sprite sort value when available, with handle order as the final tie-breaker", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 647 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "critters", "type": "Critter[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.StopSprite", "family_id": "script.method.client.Game.StopSprite", "kind": "method", "name": "StopSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.StopSprite(uint32 sprId)", "description": "Stops animation for a client-local sprite handle; unknown handles are ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 1143 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Game.ToggleFullscreen", "family_id": "script.method.client.Game.ToggleFullscreen", "kind": "method", "name": "ToggleFullscreen", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "void Game.ToggleFullscreen()", "description": "Switches the client window between fullscreen and windowed modes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 164 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Game.UpdateSound", "family_id": "script.method.client.Game.UpdateSound", "kind": "method", "name": "UpdateSound", "runtime_sides": [ "client", "mapper" ], "receiver": "Game", "signature": "bool Game.UpdateSound(uint32 soundId, float32 attenuation, float32 pan)", "description": "Updates attenuation and pan for a live sound handle and returns false after that sound has ended", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientGlobalScriptMethods.cpp", "line": 713 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "soundId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "attenuation", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "pan", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.ImGui.Image", "family_id": "script.method.client.ImGui.Image", "kind": "method", "name": "Image", "runtime_sides": [ "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Image(uint32 sprId, fsize imageSize, fpos uv0 = fpos(0.0f, 0.0f), fpos uv1 = fpos(1.0f, 1.0f))", "description": "Draws a client sprite in an ImGui layout slot at the requested positive size and UV range; partial UV drawing requires an atlas sprite, while a missing sprite leaves the slot blank", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientImGuiScriptMethods.cpp", "line": 142 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "imageSize", "type": "fsize", "nullable": false, "by_reference": false, "default": null }, { "name": "uv0", "type": "fpos", "nullable": false, "by_reference": false, "default": "fpos(0.0f, 0.0f)" }, { "name": "uv1", "type": "fpos", "nullable": false, "by_reference": false, "default": "fpos(1.0f, 1.0f)" } ] }, { "id": "script.method.client.ImGui.ImageButton", "family_id": "script.method.client.ImGui.ImageButton", "kind": "method", "name": "ImageButton", "runtime_sides": [ "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ImageButton(string strId, uint32 sprId, fsize imageSize, fpos uv0 = fpos(0.0f, 0.0f), fpos uv1 = fpos(1.0f, 1.0f), ucolor bgColor = ucolor(), ucolor tintColor = ucolor())", "description": "Creates a uniquely identified ImGui image button, draws its standard state frame plus optional background and sprite tint, and returns whether it was pressed; size and UV validation match Image", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientImGuiScriptMethods.cpp", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "sprId", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "imageSize", "type": "fsize", "nullable": false, "by_reference": false, "default": null }, { "name": "uv0", "type": "fpos", "nullable": false, "by_reference": false, "default": "fpos(0.0f, 0.0f)" }, { "name": "uv1", "type": "fpos", "nullable": false, "by_reference": false, "default": "fpos(1.0f, 1.0f)" }, { "name": "bgColor", "type": "ucolor", "nullable": false, "by_reference": false, "default": "ucolor()" }, { "name": "tintColor", "type": "ucolor", "nullable": false, "by_reference": false, "default": "ucolor()" } ] }, { "id": "script.method.client.Item.Clone", "family_id": "script.method.client.Item.Clone", "kind": "method", "name": "Clone", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "Item Item.Clone()", "description": "Creates a standalone client-side clone with the same id, prototype, and property values without inserting it into a map or inventory", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "Item", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.Finish", "family_id": "script.method.client.Item.Finish", "kind": "method", "name": "Finish", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.Finish()", "description": "Starts the standard fade-out and finish sequence for a map item once; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 231 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.GetAlpha", "family_id": "script.method.client.Item.GetAlpha", "kind": "method", "name": "GetAlpha", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "uint8 Item.GetAlpha()", "description": "Returns the map sprite's current rendered alpha, or 255 for an item outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "uint8", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.GetInnerItems", "family_id": "script.method.client.Item.GetInnerItems", "kind": "method", "name": "GetInnerItems", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "Item[] Item.GetInnerItems()", "description": "Returns a snapshot of handles to the item's immediate contained items, without recursively flattening nested containers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 194 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.GetMapPos", "family_id": "script.method.client.Item.GetMapPos", "kind": "method", "name": "GetMapPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.GetMapPos(mpos& hex)", "description": "Resolves the item's map hex from direct map ownership, its owning critter, or recursively through containing items; throws when the map or ownership chain is invalid", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 116 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Item.GetSpriteOffset", "family_id": "script.method.client.Item.GetSpriteOffset", "kind": "method", "name": "GetSpriteOffset", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "ipos Item.GetSpriteOffset()", "description": "Returns the current rendered pixel offset of this map item's sprite; throws if the item is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "ipos", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.IsAnimPlaying", "family_id": "script.method.client.Item.IsAnimPlaying", "kind": "method", "name": "IsAnimPlaying", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsAnimPlaying()", "description": "Reports whether this map item's sprite animation is playing; returns false for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 127 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.IsMoving", "family_id": "script.method.client.Item.IsMoving", "kind": "method", "name": "IsMoving", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsMoving()", "description": "Reports whether this map item is undergoing client-side visual movement; returns false for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 174 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.IsVisible", "family_id": "script.method.client.Item.IsVisible", "kind": "method", "name": "IsVisible", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsVisible()", "description": "Returns whether this map item's sprite currently participates in rendering; throws if the item is not on the loaded map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 43 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Item.MoveToHex", "family_id": "script.method.client.Item.MoveToHex", "kind": "method", "name": "MoveToHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.MoveToHex(mpos hex, float32 speed)", "description": "Starts client-side visual movement of a map item toward the target hex at the requested speed; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 185 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Item.PlayAnim", "family_id": "script.method.client.Item.PlayAnim", "kind": "method", "name": "PlayAnim", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.PlayAnim(hstring animName, bool looped, bool reversed)", "description": "Starts the named sprite animation for a map item with the requested looping and reverse modes; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "animName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "looped", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "reversed", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Item.SetAlpha", "family_id": "script.method.client.Item.SetAlpha", "kind": "method", "name": "SetAlpha", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.SetAlpha(uint8 alpha)", "description": "Fades a map item's sprite toward the requested target alpha; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 222 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "alpha", "type": "uint8", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Item.SetAnimDir", "family_id": "script.method.client.Item.SetAnimDir", "kind": "method", "name": "SetAnimDir", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.SetAnimDir(mdir dir)", "description": "Sets the directional variant used by a map item's sprite animation; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 165 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Item.SetAnimTime", "family_id": "script.method.client.Item.SetAnimTime", "kind": "method", "name": "SetAnimTime", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.SetAnimTime(float32 normalizedTime)", "description": "Sets the normalized playback position of a map item's sprite animation; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "normalizedTime", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Item.StopAnim", "family_id": "script.method.client.Item.StopAnim", "kind": "method", "name": "StopAnim", "runtime_sides": [ "client", "mapper" ], "receiver": "Item", "signature": "void Item.StopAnim()", "description": "Stops the current sprite animation for a map item; does nothing for items outside the map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientItemScriptMethods.cpp", "line": 147 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.AddFog#2b31b535aa5f8b00", "family_id": "script.method.client.Map.AddFog", "kind": "method", "name": "AddFog", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "FogLayer Map.AddFog(Critter? cr, DrawOrderType drawOrder, int32 flushEffectSubtype = -1)", "description": "Adds and returns a fog layer attached to an optional critter at the requested draw order, using an offscreen flush effect when its subtype is nonnegative", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 966 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "FogLayer", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter?", "nullable": true, "by_reference": false, "default": null }, { "name": "drawOrder", "type": "DrawOrderType", "nullable": false, "by_reference": false, "default": null }, { "name": "flushEffectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.client.Map.AddFog#d8badb89913d2e1b", "family_id": "script.method.client.Map.AddFog", "kind": "method", "name": "AddFog", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "FogLayer Map.AddFog(mpos hex, DrawOrderType drawOrder, int32 flushEffectSubtype = -1)", "description": "Adds and returns a fog layer at a valid hex and draw order, using an offscreen flush effect when its subtype is nonnegative; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 979 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "FogLayer", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "drawOrder", "type": "DrawOrderType", "nullable": false, "by_reference": false, "default": null }, { "name": "flushEffectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.client.Map.ApplyScreenScroll", "family_id": "script.method.client.Map.ApplyScreenScroll", "kind": "method", "name": "ApplyScreenScroll", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.ApplyScreenScroll(ipos offset, int32 speed, bool canStop)", "description": "Applies a pixel scroll delta using the requested speed and interruption policy", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 704 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "offset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "canStop", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.ChangeZoom", "family_id": "script.method.client.Map.ChangeZoom", "kind": "method", "name": "ChangeZoom", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.ChangeZoom(float32 targetZoom)", "description": "Starts a zoom change anchored under the mouse cursor, or the screen center when mouse input is unavailable; an unchanged target is ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 755 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "targetZoom", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.ClearTransparentEgg", "family_id": "script.method.client.Map.ClearTransparentEgg", "kind": "method", "name": "ClearTransparentEgg", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.ClearTransparentEgg(TransparentEggSlot slot)", "description": "Clears the selected transparent-egg slot from this map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 857 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "slot", "type": "TransparentEggSlot", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.CreateLocalItem", "family_id": "script.method.client.Map.CreateLocalItem", "kind": "method", "name": "CreateLocalItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Item Map.CreateLocalItem(hstring pid, mpos hex)", "description": "Creates and attaches a client-local item of a known prototype at a valid map hex; invalid prototypes or coordinates throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 1015 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.DrawEntitySprite", "family_id": "script.method.client.Map.DrawEntitySprite", "kind": "method", "name": "DrawEntitySprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.DrawEntitySprite(Entity entity, int32 effectSubtype, ucolor color, int32 padding)", "description": "Draws a client entity through the selected offscreen effect during a render event and returns whether drawing succeeded; throws outside rendering or for negative padding", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 148 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "effectSubtype", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null }, { "name": "padding", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.DrawMap", "family_id": "script.method.client.Map.DrawMap", "kind": "method", "name": "DrawMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.DrawMap()", "description": "Draws the loaded map during the RenderIface event; throws when called outside that render callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 44 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.DrawMapSprite", "family_id": "script.method.client.Map.DrawMapSprite", "kind": "method", "name": "DrawMapSprite", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.DrawMapSprite(MapSpriteHolder mapSpr)", "description": "Adds a holder-defined sprite to this map draw, silently skipping invalid, offscreen, or unresolved sprites and applying referenced item-prototype rendering rules when present", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "mapSpr", "type": "MapSpriteHolder", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCritter", "family_id": "script.method.client.Map.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter? Map.GetCritter(ident critterId)", "description": "Returns the critter with the supplied runtime id, or null for a zero or unknown id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 286 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "critterId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCritterAtScreenPos", "family_id": "script.method.client.Map.GetCritterAtScreenPos", "kind": "method", "name": "GetCritterAtScreenPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter? Map.GetCritterAtScreenPos(ipos pos, int32 extraRange = 0)", "description": "Returns the pixel-precise critter hit at a screen position, optionally retrying with an expanded range when the exact lookup finds none", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 873 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "extraRange", "type": "int32", "nullable": false, "by_reference": false, "default": "0" } ] }, { "id": "script.method.client.Map.GetCritterInRadius", "family_id": "script.method.client.Map.GetCritterInRadius", "kind": "method", "name": "GetCritterInRadius", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter? Map.GetCritterInRadius(mpos hex, int32 radius, CritterFindType findType)", "description": "Returns the matching critter nearest to a valid center hex within the requested radius after accounting for multihex size, or null when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 322 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCritterOnHex", "family_id": "script.method.client.Map.GetCritterOnHex", "kind": "method", "name": "GetCritterOnHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter? Map.GetCritterOnHex(mpos hex, CritterFindType findType)", "description": "Returns the matching critter nearest to a valid hex after accounting for multihex size, or null when none match; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCritters#addc705539406d44", "family_id": "script.method.client.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(hstring pid, CritterFindType findType)", "description": "Returns every critter on this map whose prototype id and find-type state match the supplied filters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 366 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCritters#d593b4ce96170bb4", "family_id": "script.method.client.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(CritterFindType findType = CritterFindType::Any)", "description": "Returns every critter on this map that passes the requested find-type filter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": "CritterFindType::Any" } ] }, { "id": "script.method.client.Map.GetCritters#e79de6b56cb9f3b3", "family_id": "script.method.client.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(ProtoCritter proto, CritterFindType findType)", "description": "Returns every critter on this map whose prototype and find-type state match the supplied filters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 384 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCrittersInPath", "family_id": "script.method.client.Map.GetCrittersInPath", "kind": "method", "name": "GetCrittersInPath", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType)", "description": "Traces the requested path corridor and returns matching critters intersected along it; invalid endpoint hexes throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 441 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCrittersInRadius", "family_id": "script.method.client.Map.GetCrittersInRadius", "kind": "method", "name": "GetCrittersInRadius", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersInRadius(mpos hex, int32 radius, CritterFindType findType)", "description": "Returns matching critters within the requested radius of a valid hex, ordered by multihex-adjusted distance from it; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 422 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCrittersOnHex", "family_id": "script.method.client.Map.GetCrittersOnHex", "kind": "method", "name": "GetCrittersOnHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersOnHex(mpos hex, CritterFindType findType)", "description": "Returns matching critters overlapping a valid hex, ordered by multihex-adjusted distance from it; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 403 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetCrittersWithBlockInPath", "family_id": "script.method.client.Map.GetCrittersWithBlockInPath", "kind": "method", "name": "GetCrittersWithBlockInPath", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersWithBlockInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType, mpos& preBlockHex, mpos& blockHex)", "description": "Traces the requested path corridor, returns matching critters, and writes the last pre-block and first blocking hexes; invalid endpoints throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 457 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null }, { "name": "preBlockHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "blockHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Map.GetEntityAtScreenPos", "family_id": "script.method.client.Map.GetEntityAtScreenPos", "kind": "method", "name": "GetEntityAtScreenPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Entity? Map.GetEntityAtScreenPos(ipos pos, bool ignoreTransparentEgg = false)", "description": "Returns the top selectable client entity at a screen position using pixel-precise hit testing, or null when none is hit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 886 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Entity?", "nullable": true }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "ignoreTransparentEgg", "type": "bool", "nullable": false, "by_reference": false, "default": "false" } ] }, { "id": "script.method.client.Map.GetHexAtScreenPos#8257da98c48140a5", "family_id": "script.method.client.Map.GetHexAtScreenPos", "kind": "method", "name": "GetHexAtScreenPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.GetHexAtScreenPos(ipos pos, mpos& hex, ipos& hexOffset)", "description": "Resolves a screen position to a map hex and its pixel offset within that hex, writes both outputs on success, and reports whether resolution succeeded", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 817 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "hexOffset", "type": "ipos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Map.GetHexAtScreenPos#858322c2894be6b9", "family_id": "script.method.client.Map.GetHexAtScreenPos", "kind": "method", "name": "GetHexAtScreenPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.GetHexAtScreenPos(ipos pos, mpos& hex)", "description": "Resolves a screen position to a map hex, writes the hex on success, and returns whether the position maps to the view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 810 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.client.Map.GetHexContentSize", "family_id": "script.method.client.Map.GetHexContentSize", "kind": "method", "name": "GetHexContentSize", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "isize Map.GetHexContentSize(mpos hex)", "description": "Returns the aggregate pixel size of content associated with the supplied hex in this map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 1008 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "isize", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetHexInPath", "family_id": "script.method.client.Map.GetHexInPath", "kind": "method", "name": "GetHexInPath", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.GetHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist)", "description": "Traces toward a valid destination and replaces it with the last hex before the path is blocked or reaches its distance limit; invalid endpoints throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 473 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetHexMapPos", "family_id": "script.method.client.Map.GetHexMapPos", "kind": "method", "name": "GetHexMapPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "ipos Map.GetHexMapPos(mpos hex)", "description": "Returns the integer map-space position of the top-left of a valid hex cell; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 785 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "ipos", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetHexScreenPos", "family_id": "script.method.client.Map.GetHexScreenPos", "kind": "method", "name": "GetHexScreenPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "ipos Map.GetHexScreenPos(mpos hex)", "description": "Returns the integer screen position of the visual center of a valid hex after current scrolling and projection; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 772 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "ipos", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetHexScreenPosF", "family_id": "script.method.client.Map.GetHexScreenPosF", "kind": "method", "name": "GetHexScreenPosF", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "fpos Map.GetHexScreenPosF(mpos hex)", "description": "Returns the floating-point screen position of a valid hex center after current scrolling and sprite zoom; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 796 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "fpos", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetHiddenRoofNum", "family_id": "script.method.client.Map.GetHiddenRoofNum", "kind": "method", "name": "GetHiddenRoofNum", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.GetHiddenRoofNum()", "description": "Returns the roof group currently hidden by this map view's roof-hiding logic", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 1050 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.GetItem", "family_id": "script.method.client.Map.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Item? Map.GetItem(ident itemId)", "description": "Returns the map item with the nonzero runtime id, or null when this map does not contain it; a zero id throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 242 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetItemAtScreenPos", "family_id": "script.method.client.Map.GetItemAtScreenPos", "kind": "method", "name": "GetItemAtScreenPos", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Item? Map.GetItemAtScreenPos(ipos pos)", "description": "Returns the top selectable map item at a screen position using pixel-precise hit testing, or null when none is hit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 864 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetItemOnHex", "family_id": "script.method.client.Map.GetItemOnHex", "kind": "method", "name": "GetItemOnHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Item? Map.GetItemOnHex(mpos hex)", "description": "Returns the map's single-item lookup result for a valid hex, or null when no item is selected there; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetItems", "family_id": "script.method.client.Map.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Item[] Map.GetItems()", "description": "Returns all client item views currently attached to this map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 266 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.GetItemsOnHex", "family_id": "script.method.client.Map.GetItemsOnHex", "kind": "method", "name": "GetItemsOnHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "Item[] Map.GetItemsOnHex(mpos hex)", "description": "Returns all client item views occupying a valid hex; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 274 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetManualScroll", "family_id": "script.method.client.Map.GetManualScroll", "kind": "method", "name": "GetManualScroll", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "ScrollDirection Map.GetManualScroll()", "description": "Returns the manual-scroll direction flags currently consumed by this map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 207 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "ScrollDirection", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.GetPath#11a78e57794a1f73", "family_id": "script.method.client.Map.GetPath", "kind": "method", "name": "GetPath", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "mdir[] Map.GetPath(mpos fromHex, mpos toHex, int32 cut)", "description": "Finds movement directions between valid hexes, optionally stopping the endpoint cut hexes short; returns an empty array when no movement or path is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 489 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "mdir[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetPath#2f15d4b55a4ef07c", "family_id": "script.method.client.Map.GetPath", "kind": "method", "name": "GetPath", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "mdir[] Map.GetPath(mpos fromHex, mpos toHex, int32 cut, callback(bool,Item) gagCallback)", "description": "Finds movement directions between valid hexes while the callback may pass gag items; returns an empty array when no movement or path is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 569 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "mdir[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallback", "type": "callback(bool,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetPath#9abc1ca3612a809e", "family_id": "script.method.client.Map.GetPath", "kind": "method", "name": "GetPath", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "mdir[] Map.GetPath(Critter cr, mpos toHex, int32 cut)", "description": "Finds movement directions from an on-map critter to a valid hex, accounting for its multihex and optionally stopping cut hexes short; returns an empty array when no movement or path is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 528 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "mdir[]", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetPathLength#39f192296d8a7003", "family_id": "script.method.client.Map.GetPathLength", "kind": "method", "name": "GetPathLength", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.GetPathLength(mpos fromHex, mpos toHex, int32 cut)", "description": "Returns the number of movement steps between valid hexes, optionally stopping cut hexes short; returns zero when cut removes the move or no path is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 612 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetPathLength#b62c50c709a20fb8", "family_id": "script.method.client.Map.GetPathLength", "kind": "method", "name": "GetPathLength", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.GetPathLength(Critter cr, mpos toHex, int32 cut)", "description": "Returns the number of movement steps from an on-map critter to a valid hex, accounting for its multihex and optional cut; returns zero when no movement or path is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 647 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetRoofNum", "family_id": "script.method.client.Map.GetRoofNum", "kind": "method", "name": "GetRoofNum", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.GetRoofNum(mpos hex)", "description": "Returns the roof group number at a valid map hex; an out-of-range coordinate throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 1039 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.GetScreenSize", "family_id": "script.method.client.Map.GetScreenSize", "kind": "method", "name": "GetScreenSize", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "isize Map.GetScreenSize()", "description": "Returns the current pixel size of the map view's rendering viewport", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 179 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "isize", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.GetVisibleHexes", "family_id": "script.method.client.Map.GetVisibleHexes", "kind": "method", "name": "GetVisibleHexes", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "mpos[] Map.GetVisibleHexes()", "description": "Returns every map hex currently selected for drawing by this view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 901 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "mpos[]", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.GetVisibleLayers", "family_id": "script.method.client.Map.GetVisibleLayers", "kind": "method", "name": "GetVisibleLayers", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "MapLayers Map.GetVisibleLayers()", "description": "Returns the set of layers currently visible in this map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 221 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "MapLayers", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.IsAutoScrolling", "family_id": "script.method.client.Map.IsAutoScrolling", "kind": "method", "name": "IsAutoScrolling", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsAutoScrolling()", "description": "Returns whether this map view is currently performing an automatic scroll", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 711 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.IsHexMovable", "family_id": "script.method.client.Map.IsHexMovable", "kind": "method", "name": "IsHexMovable", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsHexMovable(mpos hex)", "description": "Returns whether movement is currently unblocked on a valid hex; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 933 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.IsHexShootable", "family_id": "script.method.client.Map.IsHexShootable", "kind": "method", "name": "IsHexShootable", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsHexShootable(mpos hex)", "description": "Returns whether shooting is currently unblocked through a valid hex; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 944 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.IsHexValid", "family_id": "script.method.client.Map.IsHexValid", "kind": "method", "name": "IsHexValid", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsHexValid(mpos hex)", "description": "Returns whether the supplied hex lies inside this map's dimensions without throwing for an invalid coordinate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 894 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.IsHexVisible", "family_id": "script.method.client.Map.IsHexVisible", "kind": "method", "name": "IsHexVisible", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsHexVisible(mpos hex)", "description": "Returns the client visibility flag stored for a valid hex; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 922 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.IsOutsideArea", "family_id": "script.method.client.Map.IsOutsideArea", "kind": "method", "name": "IsOutsideArea", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsOutsideArea(mpos hex)", "description": "Returns whether a valid hex lies outside the map's configured playable area; an invalid hex throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 955 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.IsScrollCheck", "family_id": "script.method.client.Map.IsScrollCheck", "kind": "method", "name": "IsScrollCheck", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.IsScrollCheck()", "description": "Returns the map view's current scroll-check flag", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 193 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.MoveHexByDir#62392271e1b42030", "family_id": "script.method.client.Map.MoveHexByDir", "kind": "method", "name": "MoveHexByDir", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "bool Map.MoveHexByDir(mpos& hex, mdir dir)", "description": "Moves a hex one cell in the requested direction when the destination remains inside the map, updates the argument, and reports success", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 718 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.MoveHexByDir#b39016610645244b", "family_id": "script.method.client.Map.MoveHexByDir", "kind": "method", "name": "MoveHexByDir", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.MoveHexByDir(mpos& hex, mdir dir, int32 steps)", "description": "Moves a hex up to the requested number of in-bounds cells in one direction, updates the argument, and returns the completed step count", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 730 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "steps", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.MoveScreenToHex", "family_id": "script.method.client.Map.MoveScreenToHex", "kind": "method", "name": "MoveScreenToHex", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.MoveScreenToHex(mpos hex, ipos16 hex_offset, int32 speed, bool canStop)", "description": "Scrolls the view toward a valid hex using the supplied offset and nonnegative speed; speed zero jumps immediately and ignores the offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 685 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "hex_offset", "type": "ipos16", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "canStop", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.RebuildFog", "family_id": "script.method.client.Map.RebuildFog", "kind": "method", "name": "RebuildFog", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.RebuildFog()", "description": "Rebuilds this map view's fog geometry and rendering state from its current fog layers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 165 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.RedrawMap", "family_id": "script.method.client.Map.RedrawMap", "kind": "method", "name": "RedrawMap", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.RedrawMap()", "description": "Rebuilds the map view's renderable map state from its current client-side contents", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 748 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.client.Map.RunSpritePattern", "family_id": "script.method.client.Map.RunSpritePattern", "kind": "method", "name": "RunSpritePattern", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "SpritePattern? Map.RunSpritePattern(string spriteName, int32 spriteCount)", "description": "Starts a named sprite pattern with a positive frame count and returns its controller, or null when the pattern cannot be created", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 996 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "SpritePattern?", "nullable": true }, "arguments": [ { "name": "spriteName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "spriteCount", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetDayColors", "family_id": "script.method.client.Map.SetDayColors", "kind": "method", "name": "SetDayColors", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetDayColors(ucolor mapDayColor, int32 mapLightCapacity, ucolor globalDayColor, int32 globalLightCapacity)", "description": "Replaces the map-local and global day colors together with their light-capacity values for this client map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 172 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "mapDayColor", "type": "ucolor", "nullable": false, "by_reference": false, "default": null }, { "name": "mapLightCapacity", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "globalDayColor", "type": "ucolor", "nullable": false, "by_reference": false, "default": null }, { "name": "globalLightCapacity", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetExtraScrollOffset", "family_id": "script.method.client.Map.SetExtraScrollOffset", "kind": "method", "name": "SetExtraScrollOffset", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetExtraScrollOffset(fpos offset)", "description": "Sets a script-owned transient camera offset applied on top of ordinary map scrolling", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 235 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "offset", "type": "fpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetHiddenRoof", "family_id": "script.method.client.Map.SetHiddenRoof", "kind": "method", "name": "SetHiddenRoof", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetHiddenRoof(mpos hex)", "description": "Sets the hex used by this map view's roof-hiding logic", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 1032 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetManualScroll", "family_id": "script.method.client.Map.SetManualScroll", "kind": "method", "name": "SetManualScroll", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetManualScroll(ScrollDirection dirs)", "description": "Replaces the manual-scroll direction flags consumed by this map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 214 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "dirs", "type": "ScrollDirection", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetScreenSize", "family_id": "script.method.client.Map.SetScreenSize", "kind": "method", "name": "SetScreenSize", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetScreenSize(isize size)", "description": "Sets the pixel size used by this map view for projection, visibility, and rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 186 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetScrollCheck", "family_id": "script.method.client.Map.SetScrollCheck", "kind": "method", "name": "SetScrollCheck", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetScrollCheck(bool enabled)", "description": "Enables or disables the map view's scroll-check behavior", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 200 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "enabled", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetTransparentEgg#b6b974b26dd5da96", "family_id": "script.method.client.Map.SetTransparentEgg", "kind": "method", "name": "SetTransparentEgg", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetTransparentEgg(TransparentEggSlot slot, mpos hex, ipos hexOffset, isize eggSize, TransparentEggTarget target)", "description": "Configures a transparent-egg slot around an explicit hex-relative rectangle without attaching it to a critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 824 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "slot", "type": "TransparentEggSlot", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "hexOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "eggSize", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "target", "type": "TransparentEggTarget", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetTransparentEgg#d4f73ea0d2898f79", "family_id": "script.method.client.Map.SetTransparentEgg", "kind": "method", "name": "SetTransparentEgg", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetTransparentEgg(TransparentEggSlot slot, Critter? cr)", "description": "Configures a transparent-egg slot around an on-map critter's current sprite bounds, or clears the slot when the critter is absent, foreign, or not drawable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 831 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "slot", "type": "TransparentEggSlot", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.client.Map.SetVisibleLayers", "family_id": "script.method.client.Map.SetVisibleLayers", "kind": "method", "name": "SetVisibleLayers", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "void Map.SetVisibleLayers(MapLayers layers)", "description": "Replaces the set of layers visible in this map view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ClientMapScriptMethods.cpp", "line": 228 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "layers", "type": "MapLayers", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.AndroidBuild", "family_id": "script.method.common.Game.AndroidBuild", "kind": "method", "name": "AndroidBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.AndroidBuild()", "description": "Reports whether this binary targets Android", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 84 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.BreakIntoDebugger", "family_id": "script.method.common.Game.BreakIntoDebugger", "kind": "method", "name": "BreakIntoDebugger", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.BreakIntoDebugger()", "description": "Triggers the platform debugger break primitive for the current process", "flags": [], "stability": "internal", "since": null, "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 216 }, "contract": { "explicit": true, "selector": "script.method.common.Game.BreakIntoDebugger", "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 214 }, "notes": "Development-only debugger trap; intentionally not an embedding-project compatibility contract" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.CheckProtoCritter", "family_id": "script.method.common.Game.CheckProtoCritter", "kind": "method", "name": "CheckProtoCritter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.CheckProtoCritter(hstring pid)", "description": "Returns whether a critter prototype with the supplied id is registered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 612 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CheckProtoItem", "family_id": "script.method.common.Game.CheckProtoItem", "kind": "method", "name": "CheckProtoItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.CheckProtoItem(hstring pid)", "description": "Returns whether an item prototype with the supplied id is registered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 557 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CheckProtoLocation", "family_id": "script.method.common.Game.CheckProtoLocation", "kind": "method", "name": "CheckProtoLocation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.CheckProtoLocation(hstring pid)", "description": "Returns whether a location prototype with the supplied id is registered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 722 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CheckProtoMap", "family_id": "script.method.common.Game.CheckProtoMap", "kind": "method", "name": "CheckProtoMap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.CheckProtoMap(hstring pid)", "description": "Returns whether a map prototype with the supplied id is registered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 667 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CountTimeEvent#3f402d7af9d733a8", "family_id": "script.method.common.Game.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.CountTimeEvent(callback(void,any) func)", "description": "Counts all time events on this Engine instance that use the selected callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 931 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CountTimeEvent#93f88715f57381d8", "family_id": "script.method.common.Game.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.CountTimeEvent(callback(void,TimeEventContext) func)", "description": "Counts all time events on this Engine instance that use the selected context callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 945 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CountTimeEvent#a7d6bf3965b779f9", "family_id": "script.method.common.Game.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.CountTimeEvent(callback(void) func)", "description": "Counts all time events on this Engine instance that use the selected callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 924 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CountTimeEvent#b5319e6dc3f86b0f", "family_id": "script.method.common.Game.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.CountTimeEvent(callback(void,any[]) func)", "description": "Counts all time events on this Engine instance that use the selected callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 938 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any[])", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CountTimeEvent#e41a67022275199d", "family_id": "script.method.common.Game.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.CountTimeEvent(uint32 id)", "description": "Returns one when this Engine instance owns a time event with the supplied id, or zero when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 952 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.CurrentLanguage", "family_id": "script.method.common.Game.CurrentLanguage", "kind": "method", "name": "CurrentLanguage", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string Game.CurrentLanguage()", "description": "Returns the language pack currently owned by this Engine instance", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.DebugBuild", "family_id": "script.method.common.Game.DebugBuild", "kind": "method", "name": "DebugBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.DebugBuild()", "description": "Reports whether this is a native Debug build", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 147 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.DecodeUtf8", "family_id": "script.method.common.Game.DecodeUtf8", "kind": "method", "name": "DecodeUtf8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.DecodeUtf8(string text, int32& length)", "description": "Decodes the first UTF-8 code point from the supplied text, writes the consumed byte count, and returns the Unicode scalar value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 326 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "length", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.Game.DesktopBuild", "family_id": "script.method.common.Game.DesktopBuild", "kind": "method", "name": "DesktopBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.DesktopBuild()", "description": "Reports whether this binary targets a desktop platform", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 102 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.DivRem", "family_id": "script.method.common.Game.DivRem", "kind": "method", "name": "DivRem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.DivRem(int32 dividend, int32 divisor, int32& remainder)", "description": "Divides two signed integers, writes the remainder, and returns the quotient", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 821 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "dividend", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "divisor", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "remainder", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.Game.EncodeUtf8", "family_id": "script.method.common.Game.EncodeUtf8", "kind": "method", "name": "EncodeUtf8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string Game.EncodeUtf8(uint32 ucs)", "description": "Encodes one Unicode scalar value as a UTF-8 string", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 339 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "ucs", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetAllocatorStatistics", "family_id": "script.method.common.Game.GetAllocatorStatistics", "kind": "method", "name": "GetAllocatorStatistics", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string=>uint64 Game.GetAllocatorStatistics()", "description": "Returns module-global rpmalloc pages and calling-thread size-class capacities, or an empty dictionary when diagnostics are unavailable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 183 }, "contract": { "explicit": true, "selector": "script.method.common.Game.GetAllocatorStatistics", "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 181 }, "notes": "Opt-in diagnostic snapshot; availability and allocator scope are not a whole-process memory contract" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string=>uint64", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetClipboardText", "family_id": "script.method.common.Game.GetClipboardText", "kind": "method", "name": "GetClipboardText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string Game.GetClipboardText()", "description": "Returns text currently provided by the host application's clipboard integration", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 526 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetDirAngleDiff", "family_id": "script.method.common.Game.GetDirAngleDiff", "kind": "method", "name": "GetDirAngleDiff", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int16 Game.GetDirAngleDiff(mdir dir1, mdir dir2)", "description": "Returns the rounded signed shortest angular difference between two map directions in degrees", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 420 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int16", "nullable": false }, "arguments": [ { "name": "dir1", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "dir2", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetDirection", "family_id": "script.method.common.Game.GetDirection", "kind": "method", "name": "GetDirection", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "mdir Game.GetDirection(mpos fromHex, mpos toHex, float32 offset = 0.0f)", "description": "Returns the rounded angular map direction from one hex to another after applying the optional degree offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 377 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "mdir", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "offset", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" } ] }, { "id": "script.method.common.Game.GetDistance", "family_id": "script.method.common.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GetDistance(mpos hex1, mpos hex2)", "description": "Returns the hex-grid distance between two map positions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 368 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex1", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "hex2", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetHexInterval", "family_id": "script.method.common.Game.GetHexInterval", "kind": "method", "name": "GetHexInterval", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.GetHexInterval(mpos fromHex, mpos toHex, ipos& hexOffset)", "description": "Writes the pixel-space hex-grid offset from one map position to another", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 429 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "hexOffset", "type": "ipos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.Game.GetLanguage", "family_id": "script.method.common.Game.GetLanguage", "kind": "method", "name": "GetLanguage", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "LanguageName Game.GetLanguage()", "description": "Returns the language configured for this Engine instance as a hashed LanguageName", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 875 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "LanguageName", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetLineDirAngle", "family_id": "script.method.common.Game.GetLineDirAngle", "kind": "method", "name": "GetLineDirAngle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "mdir Game.GetLineDirAngle(ipos fromPos, ipos toPos)", "description": "Returns the rounded angular direction of a line between two integer pixel positions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 386 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "mdir", "nullable": false }, "arguments": [ { "name": "fromPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "toPos", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetModelAnimDuration", "family_id": "script.method.common.Game.GetModelAnimDuration", "kind": "method", "name": "GetModelAnimDuration", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "timespan Game.GetModelAnimDuration(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim)", "description": "Returns the baked duration for a model's state/action animation tuple, or zero when the model metadata, tuple, or 3D support is unavailable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 295 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "timespan", "nullable": false }, "arguments": [ { "name": "modelName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "stateAnim", "type": "CritterStateAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetPrecisionTime", "family_id": "script.method.common.Game.GetPrecisionTime", "kind": "method", "name": "GetPrecisionTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "nanotime Game.GetPrecisionTime()", "description": "Returns the current high-resolution monotonic time point for measuring process-local elapsed time", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 764 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "nanotime", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetProtoCritter", "family_id": "script.method.common.Game.GetProtoCritter", "kind": "method", "name": "GetProtoCritter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoCritter Game.GetProtoCritter(hstring pid)", "description": "Returns the registered critter prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoCritter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 599 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoCritter", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoCritters#5e6c5c33c1f46eab", "family_id": "script.method.common.Game.GetProtoCritters", "kind": "method", "name": "GetProtoCritters", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoCritter[] Game.GetProtoCritters()", "description": "Returns handles to every registered critter prototype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 619 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoCritter[]", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetProtoCritters#b2a34033b30fd6e4", "family_id": "script.method.common.Game.GetProtoCritters", "kind": "method", "name": "GetProtoCritters", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoCritter[] Game.GetProtoCritters(CritterProperty property, int32 propertyValue)", "description": "Returns registered critter prototypes whose selected integer-convertible property equals the supplied value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 635 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoCritter[]", "nullable": false }, "arguments": [ { "name": "property", "type": "CritterProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoItem", "family_id": "script.method.common.Game.GetProtoItem", "kind": "method", "name": "GetProtoItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoItem Game.GetProtoItem(hstring pid)", "description": "Returns the registered item prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoItem", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 544 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoItem", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoItems#dadf6ac4c721c1c3", "family_id": "script.method.common.Game.GetProtoItems", "kind": "method", "name": "GetProtoItems", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoItem[] Game.GetProtoItems()", "description": "Returns handles to every registered item prototype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 564 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoItem[]", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetProtoItems#ebadf2a9b94bef13", "family_id": "script.method.common.Game.GetProtoItems", "kind": "method", "name": "GetProtoItems", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoItem[] Game.GetProtoItems(ItemProperty property, int32 propertyValue)", "description": "Returns registered item prototypes whose selected integer-convertible property equals the supplied value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 580 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoItem[]", "nullable": false }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoLocation", "family_id": "script.method.common.Game.GetProtoLocation", "kind": "method", "name": "GetProtoLocation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoLocation Game.GetProtoLocation(hstring pid)", "description": "Returns the registered location prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoLocation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 709 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoLocation", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoLocations#1b5286830c6298ad", "family_id": "script.method.common.Game.GetProtoLocations", "kind": "method", "name": "GetProtoLocations", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoLocation[] Game.GetProtoLocations()", "description": "Returns handles to every registered location prototype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 729 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoLocation[]", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetProtoLocations#77f203867b4d1242", "family_id": "script.method.common.Game.GetProtoLocations", "kind": "method", "name": "GetProtoLocations", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoLocation[] Game.GetProtoLocations(LocationProperty property, int32 propertyValue)", "description": "Returns registered location prototypes whose selected integer-convertible property equals the supplied value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 745 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoLocation[]", "nullable": false }, "arguments": [ { "name": "property", "type": "LocationProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoMap", "family_id": "script.method.common.Game.GetProtoMap", "kind": "method", "name": "GetProtoMap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoMap Game.GetProtoMap(hstring pid)", "description": "Returns the registered map prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoMap", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 654 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoMap", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetProtoMaps#278f6581638f2219", "family_id": "script.method.common.Game.GetProtoMaps", "kind": "method", "name": "GetProtoMaps", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoMap[] Game.GetProtoMaps()", "description": "Returns handles to every registered map prototype", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 674 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoMap[]", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GetProtoMaps#54a26bee3bd9428d", "family_id": "script.method.common.Game.GetProtoMaps", "kind": "method", "name": "GetProtoMaps", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ProtoMap[] Game.GetProtoMaps(MapProperty property, int32 propertyValue)", "description": "Returns registered map prototypes whose selected integer-convertible property equals the supplied value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 690 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ProtoMap[]", "nullable": false }, "arguments": [ { "name": "property", "type": "MapProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.GetUnixTime", "family_id": "script.method.common.Game.GetUnixTime", "kind": "method", "name": "GetUnixTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint64 Game.GetUnixTime()", "description": "Returns the current Unix timestamp in whole seconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 359 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint64", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GitBranch", "family_id": "script.method.common.Game.GitBranch", "kind": "method", "name": "GitBranch", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string Game.GitBranch()", "description": "Returns the source branch recorded when this binary was built", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 163 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.GitCommit", "family_id": "script.method.common.Game.GitCommit", "kind": "method", "name": "GitCommit", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string Game.GitCommit()", "description": "Returns the source revision recorded when this binary was built", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 172 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.IOsBuild", "family_id": "script.method.common.Game.IOsBuild", "kind": "method", "name": "IOsBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IOsBuild()", "description": "Reports whether this binary targets iOS", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.ImGui", "family_id": "script.method.common.Game.ImGui", "kind": "method", "name": "ImGui", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ImGui Game.ImGui()", "description": "Returns the Engine ImGui script facade during an active ImGui frame; throws when no context or frame scope is available", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 114 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "ImGui", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.IsImGuiAvailable", "family_id": "script.method.common.Game.IsImGuiAvailable", "kind": "method", "name": "IsImGuiAvailable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsImGuiAvailable()", "description": "Returns whether an ImGui context exists and is currently inside an active frame scope", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 131 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.IsResourcePresent", "family_id": "script.method.common.Game.IsResourcePresent", "kind": "method", "name": "IsResourcePresent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.IsResourcePresent(string resourcePath)", "description": "Returns whether the Engine resource provider can resolve a file at the supplied resource path", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "resourcePath", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.LinuxBuild", "family_id": "script.method.common.Game.LinuxBuild", "kind": "method", "name": "LinuxBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.LinuxBuild()", "description": "Reports whether this binary targets Linux", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.Log", "family_id": "script.method.common.Game.Log", "kind": "method", "name": "Log", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.Log(string text)", "description": "Writes the supplied text as one Engine log message", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 225 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.LogError", "family_id": "script.method.common.Game.LogError", "kind": "method", "name": "LogError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.LogError(string text)", "description": "Writes the supplied text as one error-level Engine log message", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 243 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.LogWarning", "family_id": "script.method.common.Game.LogWarning", "kind": "method", "name": "LogWarning", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.LogWarning(string text)", "description": "Writes the supplied text as one warning-level Engine log message", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 234 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.MacOsBuild", "family_id": "script.method.common.Game.MacOsBuild", "kind": "method", "name": "MacOsBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.MacOsBuild()", "description": "Reports whether this binary targets macOS", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 75 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.MapDirCount", "family_id": "script.method.common.Game.MapDirCount", "kind": "method", "name": "MapDirCount", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.MapDirCount()", "description": "Returns the compile-time number of movement directions for the configured map geometry", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.MapHexagonal", "family_id": "script.method.common.Game.MapHexagonal", "kind": "method", "name": "MapHexagonal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.MapHexagonal()", "description": "Reports whether the configured map geometry is hexagonal", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 120 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.MapSquare", "family_id": "script.method.common.Game.MapSquare", "kind": "method", "name": "MapSquare", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.MapSquare()", "description": "Reports whether the configured map geometry is square", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 129 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.OpenLink", "family_id": "script.method.common.Game.OpenLink", "kind": "method", "name": "OpenLink", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.OpenLink(string link)", "description": "Asks the host application to open the supplied link using its platform integration", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 350 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "link", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.PackSynchronizedTime", "family_id": "script.method.common.Game.PackSynchronizedTime", "kind": "method", "name": "PackSynchronizedTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "synctime Game.PackSynchronizedTime(int32 year, int32 month, int32 day, int32 hour, int32 minute, int32 second, int32 millisecond)", "description": "Converts a local calendar date through milliseconds into the Engine synchronized-time domain; an invalid date throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 800 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "synctime", "nullable": false }, "arguments": [ { "name": "year", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "month", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "day", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "hour", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "minute", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "second", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "millisecond", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.PackTime", "family_id": "script.method.common.Game.PackTime", "kind": "method", "name": "PackTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "nanotime Game.PackTime(int32 year, int32 month, int32 day, int32 hour, int32 minute, int32 second, int32 millisecond, int32 microsecond, int32 nanosecond)", "description": "Converts a local calendar date and subsecond fields into the corresponding high-resolution time point; an invalid date throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 773 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "nanotime", "nullable": false }, "arguments": [ { "name": "year", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "month", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "day", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "hour", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "minute", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "second", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "millisecond", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "microsecond", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "nanosecond", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.Random", "family_id": "script.method.common.Game.Random", "kind": "method", "name": "Random", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.Random(int32 minValue, int32 maxValue)", "description": "Returns an Engine random integer in the inclusive range defined by the supplied minimum and maximum", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 319 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.ReadConfigSection", "family_id": "script.method.common.Game.ReadConfigSection", "kind": "method", "name": "ReadConfigSection", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string=>string Game.ReadConfigSection(string resourcePath, string sectionName)", "description": "Reads a resource as Engine config syntax and returns the requested section as key/value strings, or an empty map when that section is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 275 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string=>string", "nullable": false }, "arguments": [ { "name": "resourcePath", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "sectionName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.ReadResource", "family_id": "script.method.common.Game.ReadResource", "kind": "method", "name": "ReadResource", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "string Game.ReadResource(string resourcePath)", "description": "Reads and returns a text file through the Engine resource provider", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 268 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "resourcePath", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.RepeatTimeEvent#28154675b58100aa", "family_id": "script.method.common.Game.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.RepeatTimeEvent(uint32 id, timespan repeat)", "description": "Sets the repeat interval for the event with this id and reschedules its next firing from now; does nothing when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1022 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.RepeatTimeEvent#652b690f3dfe13f6", "family_id": "script.method.common.Game.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.RepeatTimeEvent(callback(void,any[]) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1008 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.RepeatTimeEvent#9e12c325ddb90694", "family_id": "script.method.common.Game.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.RepeatTimeEvent(callback(void) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 994 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.RepeatTimeEvent#a65d2cbccf611310", "family_id": "script.method.common.Game.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.RepeatTimeEvent(callback(void,TimeEventContext) func, timespan repeat)", "description": "Sets the repeat interval for every matching context-callback event and reschedules each next firing from now; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1015 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.RepeatTimeEvent#fc48af159fae9e5d", "family_id": "script.method.common.Game.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.RepeatTimeEvent(callback(void,any) func, timespan repeat)", "description": "Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1001 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.RequestQuit", "family_id": "script.method.common.Game.RequestQuit", "kind": "method", "name": "RequestQuit", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.RequestQuit(bool success = true)", "description": "Requests application shutdown and marks the eventual process result as success or failure according to the argument", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 252 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "success", "type": "bool", "nullable": false, "by_reference": false, "default": "true" } ] }, { "id": "script.method.common.Game.RotateDirAngle", "family_id": "script.method.common.Game.RotateDirAngle", "kind": "method", "name": "RotateDirAngle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "mdir Game.RotateDirAngle(mdir dir, bool clockwise, int16 step)", "description": "Rotates an angular direction clockwise or counterclockwise by the supplied degree step and normalizes it to the zero-through-359 range", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 395 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "mdir", "nullable": false }, "arguments": [ { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "clockwise", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "step", "type": "int16", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetClipboardText", "family_id": "script.method.common.Game.SetClipboardText", "kind": "method", "name": "SetClipboardText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetClipboardText(string text)", "description": "Replaces text in the host application's clipboard through its platform integration", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 535 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetTimeEventData#663f5a321c3707f7", "family_id": "script.method.common.Game.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetTimeEventData(callback(void,TimeEventContext) func, any data)", "description": "Replaces the single context payload value for every time event using the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1043 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetTimeEventData#995b7ca79df38c35", "family_id": "script.method.common.Game.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetTimeEventData(uint32 id, any data)", "description": "Replaces the single payload value for the time event with this id; does nothing when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1057 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetTimeEventData#adb2b4962b8e3874", "family_id": "script.method.common.Game.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetTimeEventData(uint32 id, any[] data)", "description": "Replaces the payload array for the time event with this id; does nothing when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1064 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetTimeEventData#f050f171334586b4", "family_id": "script.method.common.Game.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetTimeEventData(callback(void,TimeEventContext) func, any[] data)", "description": "Replaces the context payload array for every time event using the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1050 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetTimeEventData#f19e035707634deb", "family_id": "script.method.common.Game.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetTimeEventData(callback(void) func, any data)", "description": "Replaces the single direct payload value for every time event using the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1029 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.SetTimeEventData#f70e313f0f2186e1", "family_id": "script.method.common.Game.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.SetTimeEventData(callback(void,any[]) func, any[] data)", "description": "Replaces the direct payload array for every time event using the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 1036 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#0f8d3281846b110f", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, callback(void) func)", "description": "Schedules a one-shot time event on this Engine instance after the requested delay and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 833 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#2e2e75ee1f40e7ce", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,any[]) func, any[] data)", "description": "Schedules a repeating Engine time event with a direct callback payload array and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 896 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#3a6c8eb0039422c6", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,TimeEventContext) func, any[] data)", "description": "Schedules a repeating Engine time event whose callback context exposes the payload array, and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 917 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#60478fb435a8d90e", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, callback(void,TimeEventContext) func)", "description": "Schedules a one-shot Engine time event whose callback receives a context for inspecting or modifying that event, and returns its id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 854 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#69df693441c071bc", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, callback(void,TimeEventContext) func, any[] data)", "description": "Schedules a one-shot Engine time event whose callback context exposes the payload array, and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 868 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#803750a4ea861cf2", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,any) func, any data)", "description": "Schedules a repeating Engine time event with one direct callback payload value and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 889 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#8ff2132c2ddcab3e", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,TimeEventContext) func)", "description": "Schedules a repeating Engine time event whose callback receives a context for inspecting or modifying that event, and returns its id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 903 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#9c79861746d77659", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void) func)", "description": "Schedules a repeating time event on this Engine instance, with its first firing after delay and later firings at repeat, and returns its id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 882 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#9f7fe12a272e5705", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,TimeEventContext) func, any data)", "description": "Schedules a repeating Engine time event whose callback context exposes one payload value, and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 910 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#d2339300efa9e872", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, callback(void,any[]) func, any[] data)", "description": "Schedules a one-shot Engine time event, passes the payload array directly to the callback, and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 847 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#e60987dfd50cb4e5", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, callback(void,any) func, any data)", "description": "Schedules a one-shot Engine time event, passes one payload value directly to the callback, and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 840 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StartTimeEvent#fa4e11482a1cdbc0", "family_id": "script.method.common.Game.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "uint32 Game.StartTimeEvent(timespan delay, callback(void,TimeEventContext) func, any data)", "description": "Schedules a one-shot Engine time event whose callback context exposes one payload value, and returns its event id", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 861 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StopTimeEvent#1ed76dd699da2d1f", "family_id": "script.method.common.Game.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.StopTimeEvent(callback(void,any) func)", "description": "Stops all time events on this Engine instance that use the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 966 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StopTimeEvent#23bd9c39e1e601b4", "family_id": "script.method.common.Game.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.StopTimeEvent(callback(void,TimeEventContext) func)", "description": "Stops all time events on this Engine instance that use the selected context callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 980 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StopTimeEvent#a22b85adc04c5b0a", "family_id": "script.method.common.Game.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.StopTimeEvent(callback(void,any[]) func)", "description": "Stops all time events on this Engine instance that use the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 973 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,any[])", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StopTimeEvent#bc872e42a8dfd6ad", "family_id": "script.method.common.Game.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.StopTimeEvent(callback(void) func)", "description": "Stops all time events on this Engine instance that use the selected callback; does nothing when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 959 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.StopTimeEvent#be90949683fff93d", "family_id": "script.method.common.Game.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.StopTimeEvent(uint32 id)", "description": "Stops the time event with this id on the Engine instance; does nothing when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 987 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.TabletBuild", "family_id": "script.method.common.Game.TabletBuild", "kind": "method", "name": "TabletBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.TabletBuild()", "description": "Reports whether this binary targets a tablet or mobile platform", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.TraceHexLine#8955c6e7c8318b5a", "family_id": "script.method.common.Game.TraceHexLine", "kind": "method", "name": "TraceHexLine", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "mpos[] Game.TraceHexLine(msize mapSize, mpos fromHex, mpos toHex, int32 dist, float32 dirAngleOffset, ipos startOffset, ipos targetOffset)", "description": "Traces up to a nonnegative number of in-bounds hexes toward a target with angular and pixel offsets, excluding the start hex and stopping when the tracer cannot advance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 438 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "mpos[]", "nullable": false }, "arguments": [ { "name": "mapSize", "type": "msize", "nullable": false, "by_reference": false, "default": null }, { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "dirAngleOffset", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "startOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "targetOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.Game.TraceHexLine#a8077f78b077a5f9", "family_id": "script.method.common.Game.TraceHexLine", "kind": "method", "name": "TraceHexLine", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "mpos[] Game.TraceHexLine(msize mapSize, mpos fromHex, float32 dirAngle, int32 dist, ipos startOffset, ipos targetOffset, mpos& targetHex)", "description": "Traces up to a nonnegative number of in-bounds hexes at an explicit angle, excludes the start hex, and writes the last reached hex or the start when no step succeeds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 481 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "mpos[]", "nullable": false }, "arguments": [ { "name": "mapSize", "type": "msize", "nullable": false, "by_reference": false, "default": null }, { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dirAngle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "startOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "targetOffset", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "targetHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.Game.UnpackSynchronizedTime", "family_id": "script.method.common.Game.UnpackSynchronizedTime", "kind": "method", "name": "UnpackSynchronizedTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.UnpackSynchronizedTime(synctime time, int32& year, int32& month, int32& day, int32& hour, int32& minute, int32& second, int32& millisecond)", "description": "Decomposes an Engine synchronized time point into local calendar fields through milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 807 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "time", "type": "synctime", "nullable": false, "by_reference": false, "default": null }, { "name": "year", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "month", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "day", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "hour", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minute", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "second", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "millisecond", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.Game.UnpackTime", "family_id": "script.method.common.Game.UnpackTime", "kind": "method", "name": "UnpackTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "void Game.UnpackTime(nanotime time, int32& year, int32& month, int32& day, int32& hour, int32& minute, int32& second, int32& millisecond, int32& microsecond, int32& nanosecond)", "description": "Decomposes a high-resolution time point into local calendar and subsecond fields", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 782 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "time", "type": "nanotime", "nullable": false, "by_reference": false, "default": null }, { "name": "year", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "month", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "day", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "hour", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minute", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "second", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "millisecond", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "microsecond", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "nanosecond", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.Game.WebBuild", "family_id": "script.method.common.Game.WebBuild", "kind": "method", "name": "WebBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.WebBuild()", "description": "Reports whether this binary targets the Web platform", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 48 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.Game.WindowsBuild", "family_id": "script.method.common.Game.WindowsBuild", "kind": "method", "name": "WindowsBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.WindowsBuild()", "description": "Reports whether this binary targets Windows", "flags": [ "GlobalGetter" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonGlobalScriptMethods.cpp", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.AlignTextToFramePadding", "family_id": "script.method.common.ImGui.AlignTextToFramePadding", "kind": "method", "name": "AlignTextToFramePadding", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.AlignTextToFramePadding()", "description": "Advances the current line baseline so subsequent text aligns vertically with framed widgets", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 318 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.ArrowButton", "family_id": "script.method.common.ImGui.ArrowButton", "kind": "method", "name": "ArrowButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ArrowButton(string strId, ImGui_Dir dir)", "description": "Draws a square arrow button with a required nonempty ID and returns whether it was activated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1227 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "ImGui_Dir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Begin#432e0a449bff3d19", "family_id": "script.method.common.ImGui.Begin", "kind": "method", "name": "Begin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.Begin(string label, ImGui_WindowFlags flags = ImGui_WindowFlags::None)", "description": "Begins a required nonempty-label window and returns whether its contents should be submitted; always pair the call with End, even when it returns false", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 141 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_WindowFlags", "nullable": false, "by_reference": false, "default": "ImGui_WindowFlags::None" } ] }, { "id": "script.method.common.ImGui.Begin#d84f88f92ac145e9", "family_id": "script.method.common.ImGui.Begin", "kind": "method", "name": "Begin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.Begin(string label, bool& opened, ImGui_WindowFlags flags = ImGui_WindowFlags::None)", "description": "Begins a required nonempty-label closable window, updates opened when the close control is used, and returns whether to submit contents; always pair with End", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 152 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "opened", "type": "bool&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_WindowFlags", "nullable": false, "by_reference": false, "default": "ImGui_WindowFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginChild#91e43db0a33e8f18", "family_id": "script.method.common.ImGui.BeginChild", "kind": "method", "name": "BeginChild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginChild(string strId, isize size, ImGui_ChildFlags childFlags, ImGui_WindowFlags windowFlags)", "description": "Begins a required nonempty-ID child region with explicit child and window flags; always pair with EndChild regardless of the return value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1125 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "childFlags", "type": "ImGui_ChildFlags", "nullable": false, "by_reference": false, "default": null }, { "name": "windowFlags", "type": "ImGui_WindowFlags", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.BeginChild#ec21177b87910173", "family_id": "script.method.common.ImGui.BeginChild", "kind": "method", "name": "BeginChild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginChild(string strId, isize size, bool border)", "description": "Begins a required nonempty-ID child region with optional border and supplied size; always pair with EndChild regardless of the return value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1114 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "border", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.BeginCombo", "family_id": "script.method.common.ImGui.BeginCombo", "kind": "method", "name": "BeginCombo", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginCombo(string label, string previewValue, ImGui_ComboFlags flags = ImGui_ComboFlags::None)", "description": "Begins a required nonempty-label custom combo using previewValue and flags, returning whether popup contents may be submitted; call EndCombo only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1884 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "previewValue", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_ComboFlags", "nullable": false, "by_reference": false, "default": "ImGui_ComboFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginDisabled", "family_id": "script.method.common.ImGui.BeginDisabled", "kind": "method", "name": "BeginDisabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.BeginDisabled(bool disabled = true)", "description": "Begins a disabled scope when requested while still pushing a balanced scope when false; always pair with EndDisabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2317 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "disabled", "type": "bool", "nullable": false, "by_reference": false, "default": "true" } ] }, { "id": "script.method.common.ImGui.BeginGroup", "family_id": "script.method.common.ImGui.BeginGroup", "kind": "method", "name": "BeginGroup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.BeginGroup()", "description": "Begins grouping subsequent items into one composite layout and interaction bounding box", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 669 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.BeginItemTooltip", "family_id": "script.method.common.ImGui.BeginItemTooltip", "kind": "method", "name": "BeginItemTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginItemTooltip()", "description": "Begins a tooltip when the last item is hovered and returns whether it opened; call EndTooltip only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1440 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.BeginListBox", "family_id": "script.method.common.ImGui.BeginListBox", "kind": "method", "name": "BeginListBox", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginListBox(string label, isize size = isize())", "description": "Begins a required nonempty-label list box of the supplied size and returns whether contents may be submitted; call EndListBox only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1914 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": "isize()" } ] }, { "id": "script.method.common.ImGui.BeginMainMenuBar", "family_id": "script.method.common.ImGui.BeginMainMenuBar", "kind": "method", "name": "BeginMainMenuBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginMainMenuBar()", "description": "Begins the main viewport menu bar and returns whether contents may be submitted; call EndMainMenuBar only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1573 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.BeginMenu", "family_id": "script.method.common.ImGui.BeginMenu", "kind": "method", "name": "BeginMenu", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginMenu(string label, bool enabled = true)", "description": "Begins a required nonempty-label enabled or disabled menu and returns whether it is open; call EndMenu only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1601 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "enabled", "type": "bool", "nullable": false, "by_reference": false, "default": "true" } ] }, { "id": "script.method.common.ImGui.BeginMenuBar", "family_id": "script.method.common.ImGui.BeginMenuBar", "kind": "method", "name": "BeginMenuBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginMenuBar()", "description": "Begins the current window's menu bar and returns whether contents may be submitted; call EndMenuBar only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1587 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.BeginPopup", "family_id": "script.method.common.ImGui.BeginPopup", "kind": "method", "name": "BeginPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginPopup(string strId, ImGui_WindowFlags flags = ImGui_WindowFlags::None)", "description": "Begins a required nonempty-ID nonmodal popup and returns whether to submit its contents; call EndPopup only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1479 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_WindowFlags", "nullable": false, "by_reference": false, "default": "ImGui_WindowFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginPopupContextItem", "family_id": "script.method.common.ImGui.BeginPopupContextItem", "kind": "method", "name": "BeginPopupContextItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginPopupContextItem(string strId = \"\", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None)", "description": "Opens and begins a context popup for the last item under the supplied flags, using the last item's ID when strId is empty; call EndPopup only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1512 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" }, { "name": "popupFlags", "type": "ImGui_PopupFlags", "nullable": false, "by_reference": false, "default": "ImGui_PopupFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginPopupContextVoid", "family_id": "script.method.common.ImGui.BeginPopupContextVoid", "kind": "method", "name": "BeginPopupContextVoid", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginPopupContextVoid(string strId = \"\", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::MouseButtonRight)", "description": "Opens and begins a context popup over empty space under the supplied flags, deriving an ID when strId is empty; call EndPopup only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1530 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" }, { "name": "popupFlags", "type": "ImGui_PopupFlags", "nullable": false, "by_reference": false, "default": "ImGui_PopupFlags::MouseButtonRight" } ] }, { "id": "script.method.common.ImGui.BeginPopupContextWindow", "family_id": "script.method.common.ImGui.BeginPopupContextWindow", "kind": "method", "name": "BeginPopupContextWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginPopupContextWindow(string strId = \"\", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None)", "description": "Opens and begins a context popup for the current window under the supplied flags, deriving an ID when strId is empty; call EndPopup only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1521 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" }, { "name": "popupFlags", "type": "ImGui_PopupFlags", "nullable": false, "by_reference": false, "default": "ImGui_PopupFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginPopupModal#1e97b73df215a7fc", "family_id": "script.method.common.ImGui.BeginPopupModal", "kind": "method", "name": "BeginPopupModal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginPopupModal(string name, bool& opened, ImGui_WindowFlags flags)", "description": "Begins a closable required nonempty-name modal popup, updates opened from its close control, and returns whether to submit contents; EndPopup is conditional on true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1501 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "opened", "type": "bool&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_WindowFlags", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.BeginPopupModal#d6ec4d0ad6e4297f", "family_id": "script.method.common.ImGui.BeginPopupModal", "kind": "method", "name": "BeginPopupModal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginPopupModal(string name)", "description": "Begins a required nonempty-name modal popup and returns whether to submit its contents; call EndPopup only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1490 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.BeginTabBar", "family_id": "script.method.common.ImGui.BeginTabBar", "kind": "method", "name": "BeginTabBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginTabBar(string strId, ImGui_TabBarFlags flags = ImGui_TabBarFlags::None)", "description": "Begins a tab bar with a required nonempty ID and returns whether contents may be submitted; call EndTabBar only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1771 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TabBarFlags", "nullable": false, "by_reference": false, "default": "ImGui_TabBarFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginTabItem#8769abbb356a8660", "family_id": "script.method.common.ImGui.BeginTabItem", "kind": "method", "name": "BeginTabItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginTabItem(string label, ImGui_TabItemFlags flags = ImGui_TabItemFlags::None)", "description": "Begins a required nonempty-label tab item and returns whether its contents are visible; call EndTabItem only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1789 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TabItemFlags", "nullable": false, "by_reference": false, "default": "ImGui_TabItemFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginTabItem#99825a7be7e7e25c", "family_id": "script.method.common.ImGui.BeginTabItem", "kind": "method", "name": "BeginTabItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginTabItem(string label, bool& opened, ImGui_TabItemFlags flags = ImGui_TabItemFlags::None)", "description": "Begins a closable required nonempty-label tab item, updates opened from its close control, and returns whether contents are visible; EndTabItem is conditional on true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1800 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "opened", "type": "bool&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_TabItemFlags", "nullable": false, "by_reference": false, "default": "ImGui_TabItemFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginTable", "family_id": "script.method.common.ImGui.BeginTable", "kind": "method", "name": "BeginTable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginTable(string strId, int32 columns, ImGui_TableFlags flags = ImGui_TableFlags::None)", "description": "Begins a table with a required nonempty ID and positive column count, returning whether contents may be submitted; call EndTable only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1630 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "columns", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TableFlags", "nullable": false, "by_reference": false, "default": "ImGui_TableFlags::None" } ] }, { "id": "script.method.common.ImGui.BeginTooltip", "family_id": "script.method.common.ImGui.BeginTooltip", "kind": "method", "name": "BeginTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.BeginTooltip()", "description": "Begins an unconditional tooltip window; pair it with EndTooltip", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1454 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.Bullet", "family_id": "script.method.common.ImGui.Bullet", "kind": "method", "name": "Bullet", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Bullet()", "description": "Emits a standalone bullet and advances the cursor on the same line for following content", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 500 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.BulletText", "family_id": "script.method.common.ImGui.BulletText", "kind": "method", "name": "BulletText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.BulletText(string text)", "description": "Renders the supplied text preceded by an ImGui bullet", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1948 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Button", "family_id": "script.method.common.ImGui.Button", "kind": "method", "name": "Button", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.Button(string label)", "description": "Draws a required nonempty-label button and returns whether it was activated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 602 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.CalcItemWidth", "family_id": "script.method.common.ImGui.CalcItemWidth", "kind": "method", "name": "CalcItemWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.CalcItemWidth()", "description": "Resolves and returns the width ImGui would use for the next item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 641 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.CalcTextSize", "family_id": "script.method.common.ImGui.CalcTextSize", "kind": "method", "name": "CalcTextSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fsize ImGui.CalcTextSize(string text, bool hideTextAfterDoubleHash = false, float32 wrapWidth = -1.0f)", "description": "Measures text using the current font, optionally hiding the ID suffix after ## and wrapping at the supplied width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 310 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fsize", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "hideTextAfterDoubleHash", "type": "bool", "nullable": false, "by_reference": false, "default": "false" }, { "name": "wrapWidth", "type": "float32", "nullable": false, "by_reference": false, "default": "-1.0f" } ] }, { "id": "script.method.common.ImGui.Checkbox", "family_id": "script.method.common.ImGui.Checkbox", "kind": "method", "name": "Checkbox", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.Checkbox(string label, bool& value)", "description": "Draws a required nonempty-label checkbox, updates value on interaction, and returns whether it changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 683 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "bool&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.common.ImGui.CheckboxFlags#458f2952235bd5d1", "family_id": "script.method.common.ImGui.CheckboxFlags", "kind": "method", "name": "CheckboxFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.CheckboxFlags(string label, int32& flags, int32 flagsValue)", "description": "Draws a required nonempty-label checkbox that toggles the selected signed flag bits and returns whether flags changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 694 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flagsValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.CheckboxFlags#f574f68257656ebd", "family_id": "script.method.common.ImGui.CheckboxFlags", "kind": "method", "name": "CheckboxFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.CheckboxFlags(string label, uint32& flags, uint32 flagsValue)", "description": "Draws a required nonempty-label checkbox that toggles the selected unsigned flag bits and returns whether flags changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 705 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "uint32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flagsValue", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.CloseCurrentPopup", "family_id": "script.method.common.ImGui.CloseCurrentPopup", "kind": "method", "name": "CloseCurrentPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.CloseCurrentPopup()", "description": "Requests closure of the current popup at the end of the frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1546 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.CollapsingHeader", "family_id": "script.method.common.ImGui.CollapsingHeader", "kind": "method", "name": "CollapsingHeader", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.CollapsingHeader(string label, ImGui_TreeNodeFlags flags = ImGui_TreeNodeFlags::None)", "description": "Draws a required nonempty-label collapsing header and returns whether its contents are visible; it does not push a tree scope", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1143 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TreeNodeFlags", "nullable": false, "by_reference": false, "default": "ImGui_TreeNodeFlags::None" } ] }, { "id": "script.method.common.ImGui.ColorButton", "family_id": "script.method.common.ImGui.ColorButton", "kind": "method", "name": "ColorButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ColorButton(string descId, ucolor color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None, fsize size = fsize())", "description": "Draws a color preview button with a required nonempty description ID, packed ucolor, flags, and optional size, returning whether it was activated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2146 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "descId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_ColorEditFlags", "nullable": false, "by_reference": false, "default": "ImGui_ColorEditFlags::None" }, { "name": "size", "type": "fsize", "nullable": false, "by_reference": false, "default": "fsize()" } ] }, { "id": "script.method.common.ImGui.ColorEdit3", "family_id": "script.method.common.ImGui.ColorEdit3", "kind": "method", "name": "ColorEdit3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ColorEdit3(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None)", "description": "Draws a required nonempty-label RGB editor, converts ucolor channels to floats, preserves alpha, and stores clamped 8-bit RGB only when changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2070 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_ColorEditFlags", "nullable": false, "by_reference": false, "default": "ImGui_ColorEditFlags::None" } ] }, { "id": "script.method.common.ImGui.ColorEdit4", "family_id": "script.method.common.ImGui.ColorEdit4", "kind": "method", "name": "ColorEdit4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ColorEdit4(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None)", "description": "Draws a required nonempty-label RGBA editor, converts ucolor channels to floats, and stores clamped 8-bit RGBA only when changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2089 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_ColorEditFlags", "nullable": false, "by_reference": false, "default": "ImGui_ColorEditFlags::None" } ] }, { "id": "script.method.common.ImGui.ColorPicker3", "family_id": "script.method.common.ImGui.ColorPicker3", "kind": "method", "name": "ColorPicker3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ColorPicker3(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None)", "description": "Draws a required nonempty-label RGB picker, converts ucolor channels to floats, preserves alpha, and stores clamped 8-bit RGB only when changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2108 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_ColorEditFlags", "nullable": false, "by_reference": false, "default": "ImGui_ColorEditFlags::None" } ] }, { "id": "script.method.common.ImGui.ColorPicker4", "family_id": "script.method.common.ImGui.ColorPicker4", "kind": "method", "name": "ColorPicker4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ColorPicker4(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None)", "description": "Draws a required nonempty-label RGBA picker, converts ucolor channels to floats, and stores clamped 8-bit RGBA only when changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2127 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_ColorEditFlags", "nullable": false, "by_reference": false, "default": "ImGui_ColorEditFlags::None" } ] }, { "id": "script.method.common.ImGui.Combo", "family_id": "script.method.common.ImGui.Combo", "kind": "method", "name": "Combo", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.Combo(string label, int32& currentItem, string itemsSeparatedByZeros, int32 popupMaxHeightInItems = -1)", "description": "Draws a required nonempty-label combo from a NUL-separated item string, updates currentItem on selection, and returns whether it changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1895 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "currentItem", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "itemsSeparatedByZeros", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "popupMaxHeightInItems", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.common.ImGui.DragFloat", "family_id": "script.method.common.ImGui.DragFloat", "kind": "method", "name": "DragFloat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragFloat(string label, float32& value, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label float drag editor with speed, bounds, three-decimal display, and slider flags; updates value and reports changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 787 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragFloat2", "family_id": "script.method.common.ImGui.DragFloat2", "kind": "method", "name": "DragFloat2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragFloat2(string label, float32& valueX, float32& valueY, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label two-component float drag editor and writes both components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 809 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragFloat3", "family_id": "script.method.common.ImGui.DragFloat3", "kind": "method", "name": "DragFloat3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragFloat3(string label, float32& valueX, float32& valueY, float32& valueZ, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label three-component float drag editor and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 828 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragFloat4", "family_id": "script.method.common.ImGui.DragFloat4", "kind": "method", "name": "DragFloat4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragFloat4(string label, float32& valueX, float32& valueY, float32& valueZ, float32& valueW, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label four-component float drag editor and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 848 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueW", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragInt", "family_id": "script.method.common.ImGui.DragInt", "kind": "method", "name": "DragInt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragInt(string label, int32& value, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label integer drag editor with speed, bounds, and slider flags; updates value and reports changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 798 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragInt2", "family_id": "script.method.common.ImGui.DragInt2", "kind": "method", "name": "DragInt2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragInt2(string label, int32& valueX, int32& valueY, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label two-component integer drag editor and writes both components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 869 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragInt3", "family_id": "script.method.common.ImGui.DragInt3", "kind": "method", "name": "DragInt3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragInt3(string label, int32& valueX, int32& valueY, int32& valueZ, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label three-component integer drag editor and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 888 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.DragInt4", "family_id": "script.method.common.ImGui.DragInt4", "kind": "method", "name": "DragInt4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.DragInt4(string label, int32& valueX, int32& valueY, int32& valueZ, int32& valueW, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label four-component integer drag editor and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 908 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueW", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "speed", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.Dummy", "family_id": "script.method.common.ImGui.Dummy", "kind": "method", "name": "Dummy", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Dummy(isize size)", "description": "Submits an invisible layout item of the supplied size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 648 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.End", "family_id": "script.method.common.ImGui.End", "kind": "method", "name": "End", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.End()", "description": "Ends the current window begun by Begin; this is required regardless of Begin's return value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 163 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndChild", "family_id": "script.method.common.ImGui.EndChild", "kind": "method", "name": "EndChild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndChild()", "description": "Ends the current child region begun by BeginChild; this is required regardless of BeginChild's return value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1136 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndCombo", "family_id": "script.method.common.ImGui.EndCombo", "kind": "method", "name": "EndCombo", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndCombo()", "description": "Ends custom combo contents begun by a successful BeginCombo call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1907 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndDisabled", "family_id": "script.method.common.ImGui.EndDisabled", "kind": "method", "name": "EndDisabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndDisabled()", "description": "Ends the current scope begun by BeginDisabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2324 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndGroup", "family_id": "script.method.common.ImGui.EndGroup", "kind": "method", "name": "EndGroup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndGroup()", "description": "Ends the current group and exposes it as the last submitted item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 676 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndListBox", "family_id": "script.method.common.ImGui.EndListBox", "kind": "method", "name": "EndListBox", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndListBox()", "description": "Ends a list box begun by a successful BeginListBox call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1925 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndMainMenuBar", "family_id": "script.method.common.ImGui.EndMainMenuBar", "kind": "method", "name": "EndMainMenuBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndMainMenuBar()", "description": "Ends a main menu bar begun by a successful BeginMainMenuBar call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1580 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndMenu", "family_id": "script.method.common.ImGui.EndMenu", "kind": "method", "name": "EndMenu", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndMenu()", "description": "Ends a menu begun by a successful BeginMenu call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1612 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndMenuBar", "family_id": "script.method.common.ImGui.EndMenuBar", "kind": "method", "name": "EndMenuBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndMenuBar()", "description": "Ends a window menu bar begun by a successful BeginMenuBar call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1594 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndPopup", "family_id": "script.method.common.ImGui.EndPopup", "kind": "method", "name": "EndPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndPopup()", "description": "Ends a popup begun by a successful BeginPopup, BeginPopupModal, or context-popup call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1539 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndTabBar", "family_id": "script.method.common.ImGui.EndTabBar", "kind": "method", "name": "EndTabBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndTabBar()", "description": "Ends a tab bar begun by a successful BeginTabBar call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1782 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndTabItem", "family_id": "script.method.common.ImGui.EndTabItem", "kind": "method", "name": "EndTabItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndTabItem()", "description": "Ends a tab item begun by a successful BeginTabItem call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1811 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndTable", "family_id": "script.method.common.ImGui.EndTable", "kind": "method", "name": "EndTable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndTable()", "description": "Ends a table begun by a successful BeginTable call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1644 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.EndTooltip", "family_id": "script.method.common.ImGui.EndTooltip", "kind": "method", "name": "EndTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.EndTooltip()", "description": "Ends the current tooltip begun by BeginTooltip or a successful BeginItemTooltip", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1461 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetClipboardText", "family_id": "script.method.common.ImGui.GetClipboardText", "kind": "method", "name": "GetClipboardText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "string ImGui.GetClipboardText()", "description": "Returns text from ImGui's platform clipboard backend, or an empty string when the backend returns null", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2331 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetContentRegionAvailX", "family_id": "script.method.common.ImGui.GetContentRegionAvailX", "kind": "method", "name": "GetContentRegionAvailX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetContentRegionAvailX()", "description": "Returns the horizontal space available from the current cursor to the content-region boundary", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 532 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetContentRegionAvailY", "family_id": "script.method.common.ImGui.GetContentRegionAvailY", "kind": "method", "name": "GetContentRegionAvailY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetContentRegionAvailY()", "description": "Returns the vertical space available from the current cursor to the content-region boundary", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 539 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetCursorPosX", "family_id": "script.method.common.ImGui.GetCursorPosX", "kind": "method", "name": "GetCursorPosX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetCursorPosX()", "description": "Returns the current cursor's local X coordinate within the window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 546 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetCursorPosY", "family_id": "script.method.common.ImGui.GetCursorPosY", "kind": "method", "name": "GetCursorPosY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetCursorPosY()", "description": "Returns the current cursor's local Y coordinate within the window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 553 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetCursorScreenPos", "family_id": "script.method.common.ImGui.GetCursorScreenPos", "kind": "method", "name": "GetCursorScreenPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetCursorScreenPos()", "description": "Returns the current cursor position in screen coordinates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 560 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetFrameCount", "family_id": "script.method.common.ImGui.GetFrameCount", "kind": "method", "name": "GetFrameCount", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "int32 ImGui.GetFrameCount()", "description": "Returns the ImGui frame counter narrowed to int32", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 332 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetFrameHeight", "family_id": "script.method.common.ImGui.GetFrameHeight", "kind": "method", "name": "GetFrameHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetFrameHeight()", "description": "Returns the standard framed-widget height for the current font and style", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 353 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetFrameHeightWithSpacing", "family_id": "script.method.common.ImGui.GetFrameHeightWithSpacing", "kind": "method", "name": "GetFrameHeightWithSpacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetFrameHeightWithSpacing()", "description": "Returns the standard framed-widget height plus vertical item spacing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 360 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetItemRectMax", "family_id": "script.method.common.ImGui.GetItemRectMax", "kind": "method", "name": "GetItemRectMax", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetItemRectMax()", "description": "Returns the maximum screen-space corner of the last submitted item's bounding rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1340 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetItemRectMin", "family_id": "script.method.common.ImGui.GetItemRectMin", "kind": "method", "name": "GetItemRectMin", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetItemRectMin()", "description": "Returns the minimum screen-space corner of the last submitted item's bounding rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1333 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetItemRectSize", "family_id": "script.method.common.ImGui.GetItemRectSize", "kind": "method", "name": "GetItemRectSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fsize ImGui.GetItemRectSize()", "description": "Returns the size of the last submitted item's bounding rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fsize", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetMouseDragDelta", "family_id": "script.method.common.ImGui.GetMouseDragDelta", "kind": "method", "name": "GetMouseDragDelta", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetMouseDragDelta(ImGui_MouseButton mouseButton = ImGui_MouseButton::Left, float32 lockThreshold = -1.0f)", "description": "Returns mouse displacement since the selected button was clicked after crossing the supplied or configured drag threshold", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1410 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": "ImGui_MouseButton::Left" }, { "name": "lockThreshold", "type": "float32", "nullable": false, "by_reference": false, "default": "-1.0f" } ] }, { "id": "script.method.common.ImGui.GetMousePos", "family_id": "script.method.common.ImGui.GetMousePos", "kind": "method", "name": "GetMousePos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetMousePos()", "description": "Returns the current ImGui mouse position in screen coordinates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1354 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetMousePosOnOpeningCurrentPopup", "family_id": "script.method.common.ImGui.GetMousePosOnOpeningCurrentPopup", "kind": "method", "name": "GetMousePosOnOpeningCurrentPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetMousePosOnOpeningCurrentPopup()", "description": "Returns the mouse position captured when the current popup was opened", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1361 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetScrollMaxX", "family_id": "script.method.common.ImGui.GetScrollMaxX", "kind": "method", "name": "GetScrollMaxX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetScrollMaxX()", "description": "Returns the maximum horizontal scroll offset of the current window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 444 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetScrollMaxY", "family_id": "script.method.common.ImGui.GetScrollMaxY", "kind": "method", "name": "GetScrollMaxY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetScrollMaxY()", "description": "Returns the maximum vertical scroll offset of the current window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 451 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetScrollX", "family_id": "script.method.common.ImGui.GetScrollX", "kind": "method", "name": "GetScrollX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetScrollX()", "description": "Returns the current window's horizontal scroll offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 416 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetScrollY", "family_id": "script.method.common.ImGui.GetScrollY", "kind": "method", "name": "GetScrollY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetScrollY()", "description": "Returns the current window's vertical scroll offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetTextLineHeight", "family_id": "script.method.common.ImGui.GetTextLineHeight", "kind": "method", "name": "GetTextLineHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetTextLineHeight()", "description": "Returns the current font's text-line height without inter-line spacing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 339 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetTextLineHeightWithSpacing", "family_id": "script.method.common.ImGui.GetTextLineHeightWithSpacing", "kind": "method", "name": "GetTextLineHeightWithSpacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetTextLineHeightWithSpacing()", "description": "Returns the current font's text-line height including ImGui item spacing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetTime", "family_id": "script.method.common.ImGui.GetTime", "kind": "method", "name": "GetTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float64 ImGui.GetTime()", "description": "Returns elapsed ImGui time in seconds since context initialization", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float64", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetTreeNodeToLabelSpacing", "family_id": "script.method.common.ImGui.GetTreeNodeToLabelSpacing", "kind": "method", "name": "GetTreeNodeToLabelSpacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetTreeNodeToLabelSpacing()", "description": "Returns the horizontal spacing from a tree-node arrow or bullet to its label", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 518 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetWindowHeight", "family_id": "script.method.common.ImGui.GetWindowHeight", "kind": "method", "name": "GetWindowHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetWindowHeight()", "description": "Returns the current window height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 409 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetWindowPos", "family_id": "script.method.common.ImGui.GetWindowPos", "kind": "method", "name": "GetWindowPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fpos ImGui.GetWindowPos()", "description": "Returns the current window's top-left position in screen coordinates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 374 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fpos", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetWindowSize", "family_id": "script.method.common.ImGui.GetWindowSize", "kind": "method", "name": "GetWindowSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "fsize ImGui.GetWindowSize()", "description": "Returns the current window's size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 381 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "fsize", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.GetWindowWidth", "family_id": "script.method.common.ImGui.GetWindowWidth", "kind": "method", "name": "GetWindowWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "float32 ImGui.GetWindowWidth()", "description": "Returns the current window width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 402 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.Indent", "family_id": "script.method.common.ImGui.Indent", "kind": "method", "name": "Indent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Indent(float32 indentW = 0.0f)", "description": "Increases the current line's horizontal indentation by the supplied amount or the style default when zero", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 655 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "indentW", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" } ] }, { "id": "script.method.common.ImGui.InputFloat", "family_id": "script.method.common.ImGui.InputFloat", "kind": "method", "name": "InputFloat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputFloat(string label, float32& value, float32 step = 0.0f, float32 stepFast = 0.0f, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label float input with step controls, three-decimal formatting, and text-input flags; updates value and reports changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2181 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "step", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" }, { "name": "stepFast", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputFloat2", "family_id": "script.method.common.ImGui.InputFloat2", "kind": "method", "name": "InputFloat2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputFloat2(string label, float32& valueX, float32& valueY, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label two-component float input and writes both components back only when editing changes them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2192 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputFloat3", "family_id": "script.method.common.ImGui.InputFloat3", "kind": "method", "name": "InputFloat3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputFloat3(string label, float32& valueX, float32& valueY, float32& valueZ, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label three-component float input and writes all components back only when editing changes them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2211 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputFloat4", "family_id": "script.method.common.ImGui.InputFloat4", "kind": "method", "name": "InputFloat4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputFloat4(string label, float32& valueX, float32& valueY, float32& valueZ, float32& valueW, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label four-component float input and writes all components back only when editing changes them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2231 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueW", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputInt", "family_id": "script.method.common.ImGui.InputInt", "kind": "method", "name": "InputInt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputInt(string label, int32& value, int32 step = 1, int32 stepFast = 100, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label signed integer input, updates value, and returns whether editing changed it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 716 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "step", "type": "int32", "nullable": false, "by_reference": false, "default": "1" }, { "name": "stepFast", "type": "int32", "nullable": false, "by_reference": false, "default": "100" }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputInt2", "family_id": "script.method.common.ImGui.InputInt2", "kind": "method", "name": "InputInt2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputInt2(string label, int32& valueX, int32& valueY, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label two-component integer input and writes both components back only when editing changes them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 727 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputInt3", "family_id": "script.method.common.ImGui.InputInt3", "kind": "method", "name": "InputInt3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputInt3(string label, int32& valueX, int32& valueY, int32& valueZ, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label three-component integer input and writes all components back only when editing changes them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 746 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputInt4", "family_id": "script.method.common.ImGui.InputInt4", "kind": "method", "name": "InputInt4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputInt4(string label, int32& valueX, int32& valueY, int32& valueZ, int32& valueW, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label four-component integer input and writes all components back only when editing changes them", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 766 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueW", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputText", "family_id": "script.method.common.ImGui.InputText", "kind": "method", "name": "InputText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputText(string label, string& value, uint32 maxLength, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label single-line text input backed by maxLength bytes, rejecting zero capacity or an oversized initial value and writing back only on change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2252 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "string&", "nullable": false, "by_reference": true, "default": null }, { "name": "maxLength", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputTextMultiline", "family_id": "script.method.common.ImGui.InputTextMultiline", "kind": "method", "name": "InputTextMultiline", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputTextMultiline(string label, string& value, uint32 maxLength, isize size, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label multiline text input of the supplied size backed by maxLength bytes, rejecting invalid capacity and writing back only on change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2273 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "string&", "nullable": false, "by_reference": true, "default": null }, { "name": "maxLength", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InputTextWithHint", "family_id": "script.method.common.ImGui.InputTextWithHint", "kind": "method", "name": "InputTextWithHint", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InputTextWithHint(string label, string hint, string& value, uint32 maxLength, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None)", "description": "Draws a required nonempty-label text input with hint backed by maxLength bytes, rejecting invalid capacity and writing value back only on change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2294 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "hint", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "string&", "nullable": false, "by_reference": true, "default": null }, { "name": "maxLength", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_InputTextFlags", "nullable": false, "by_reference": false, "default": "ImGui_InputTextFlags::None" } ] }, { "id": "script.method.common.ImGui.InvisibleButton", "family_id": "script.method.common.ImGui.InvisibleButton", "kind": "method", "name": "InvisibleButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.InvisibleButton(string strId, fsize size, ImGui_ButtonFlags flags = ImGui_ButtonFlags::None)", "description": "Submits an invisible button with a required nonempty ID, explicit size, and button flags, and returns whether it was activated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1238 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "fsize", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_ButtonFlags", "nullable": false, "by_reference": false, "default": "ImGui_ButtonFlags::None" } ] }, { "id": "script.method.common.ImGui.IsAnyItemActive", "family_id": "script.method.common.ImGui.IsAnyItemActive", "kind": "method", "name": "IsAnyItemActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsAnyItemActive()", "description": "Returns whether any ImGui item is currently active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 493 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsAnyItemFocused", "family_id": "script.method.common.ImGui.IsAnyItemFocused", "kind": "method", "name": "IsAnyItemFocused", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsAnyItemFocused()", "description": "Returns whether any ImGui item currently owns keyboard focus", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1291 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsAnyItemHovered", "family_id": "script.method.common.ImGui.IsAnyItemHovered", "kind": "method", "name": "IsAnyItemHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsAnyItemHovered()", "description": "Returns whether any ImGui item is currently hovered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 486 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemActivated", "family_id": "script.method.common.ImGui.IsItemActivated", "kind": "method", "name": "IsItemActivated", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemActivated()", "description": "Returns whether the last submitted item became active this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1263 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemActive", "family_id": "script.method.common.ImGui.IsItemActive", "kind": "method", "name": "IsItemActive", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemActive()", "description": "Returns whether the last submitted item is currently active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1312 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemClicked", "family_id": "script.method.common.ImGui.IsItemClicked", "kind": "method", "name": "IsItemClicked", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemClicked(ImGui_MouseButton mouseButton = ImGui_MouseButton::Left)", "description": "Returns whether the last submitted item was clicked with the selected mouse button this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": "ImGui_MouseButton::Left" } ] }, { "id": "script.method.common.ImGui.IsItemDeactivated", "family_id": "script.method.common.ImGui.IsItemDeactivated", "kind": "method", "name": "IsItemDeactivated", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemDeactivated()", "description": "Returns whether the last submitted item stopped being active this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1270 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemDeactivatedAfterEdit", "family_id": "script.method.common.ImGui.IsItemDeactivatedAfterEdit", "kind": "method", "name": "IsItemDeactivatedAfterEdit", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemDeactivatedAfterEdit()", "description": "Returns whether the last submitted item stopped being active this frame after its value was edited", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1277 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemEdited", "family_id": "script.method.common.ImGui.IsItemEdited", "kind": "method", "name": "IsItemEdited", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemEdited()", "description": "Returns whether the last submitted item's value was edited this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1319 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemHovered", "family_id": "script.method.common.ImGui.IsItemHovered", "kind": "method", "name": "IsItemHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemHovered(ImGui_HoveredFlags flags = ImGui_HoveredFlags::None)", "description": "Returns whether the last submitted item is hovered under the supplied hover flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1249 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "flags", "type": "ImGui_HoveredFlags", "nullable": false, "by_reference": false, "default": "ImGui_HoveredFlags::None" } ] }, { "id": "script.method.common.ImGui.IsItemToggledOpen", "family_id": "script.method.common.ImGui.IsItemToggledOpen", "kind": "method", "name": "IsItemToggledOpen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemToggledOpen()", "description": "Returns whether the last submitted tree node or collapsing header toggled its open state this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1284 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsItemVisible", "family_id": "script.method.common.ImGui.IsItemVisible", "kind": "method", "name": "IsItemVisible", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsItemVisible()", "description": "Returns whether the last submitted item overlaps the current clipping rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1326 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsMouseClicked", "family_id": "script.method.common.ImGui.IsMouseClicked", "kind": "method", "name": "IsMouseClicked", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsMouseClicked(ImGui_MouseButton mouseButton)", "description": "Returns whether the selected mouse button was clicked this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1375 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.IsMouseDoubleClicked", "family_id": "script.method.common.ImGui.IsMouseDoubleClicked", "kind": "method", "name": "IsMouseDoubleClicked", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsMouseDoubleClicked(ImGui_MouseButton mouseButton)", "description": "Returns whether the selected mouse button registered a double-click this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1389 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.IsMouseDown", "family_id": "script.method.common.ImGui.IsMouseDown", "kind": "method", "name": "IsMouseDown", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsMouseDown(ImGui_MouseButton mouseButton)", "description": "Returns whether the selected mouse button is currently held down", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1368 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.IsMouseDragging", "family_id": "script.method.common.ImGui.IsMouseDragging", "kind": "method", "name": "IsMouseDragging", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsMouseDragging(ImGui_MouseButton mouseButton, float32 lockThreshold = -1.0f)", "description": "Returns whether the selected mouse button is dragging beyond the supplied threshold, or the configured threshold when negative", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1403 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": null }, { "name": "lockThreshold", "type": "float32", "nullable": false, "by_reference": false, "default": "-1.0f" } ] }, { "id": "script.method.common.ImGui.IsMouseHoveringRect", "family_id": "script.method.common.ImGui.IsMouseHoveringRect", "kind": "method", "name": "IsMouseHoveringRect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsMouseHoveringRect(fpos rectMin, fpos rectMax, bool clip = true)", "description": "Returns whether the mouse is inside the supplied screen-space rectangle, optionally intersected with the current clip rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1396 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "rectMin", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "rectMax", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "clip", "type": "bool", "nullable": false, "by_reference": false, "default": "true" } ] }, { "id": "script.method.common.ImGui.IsMouseReleased", "family_id": "script.method.common.ImGui.IsMouseReleased", "kind": "method", "name": "IsMouseReleased", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsMouseReleased(ImGui_MouseButton mouseButton)", "description": "Returns whether the selected mouse button was released this frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1382 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.IsPopupOpen", "family_id": "script.method.common.ImGui.IsPopupOpen", "kind": "method", "name": "IsPopupOpen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsPopupOpen(string strId, ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None)", "description": "Returns whether a popup matching the required nonempty ID is open under the supplied query flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1553 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "popupFlags", "type": "ImGui_PopupFlags", "nullable": false, "by_reference": false, "default": "ImGui_PopupFlags::None" } ] }, { "id": "script.method.common.ImGui.IsRectVisible#05fb9e94e4abfe05", "family_id": "script.method.common.ImGui.IsRectVisible", "kind": "method", "name": "IsRectVisible", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsRectVisible(fsize size)", "description": "Returns whether a rectangle of the supplied size at the current cursor position overlaps the current clipping rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 388 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "size", "type": "fsize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.IsRectVisible#417dc43e9e79eea8", "family_id": "script.method.common.ImGui.IsRectVisible", "kind": "method", "name": "IsRectVisible", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsRectVisible(fpos rectMin, fpos rectMax)", "description": "Returns whether the supplied screen-space rectangle overlaps the current clipping rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 395 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "rectMin", "type": "fpos", "nullable": false, "by_reference": false, "default": null }, { "name": "rectMax", "type": "fpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.IsWindowAppearing", "family_id": "script.method.common.ImGui.IsWindowAppearing", "kind": "method", "name": "IsWindowAppearing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsWindowAppearing()", "description": "Returns whether the current window has just appeared after being hidden, inactive, or newly created", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 367 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.IsWindowFocused", "family_id": "script.method.common.ImGui.IsWindowFocused", "kind": "method", "name": "IsWindowFocused", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsWindowFocused(ImGui_FocusedFlags flags = ImGui_FocusedFlags::None)", "description": "Returns whether the current window is focused under the supplied focus flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "flags", "type": "ImGui_FocusedFlags", "nullable": false, "by_reference": false, "default": "ImGui_FocusedFlags::None" } ] }, { "id": "script.method.common.ImGui.IsWindowHovered", "family_id": "script.method.common.ImGui.IsWindowHovered", "kind": "method", "name": "IsWindowHovered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.IsWindowHovered(ImGui_HoveredFlags flags = ImGui_HoveredFlags::None)", "description": "Returns whether the current window is hovered under the supplied hover flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1305 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "flags", "type": "ImGui_HoveredFlags", "nullable": false, "by_reference": false, "default": "ImGui_HoveredFlags::None" } ] }, { "id": "script.method.common.ImGui.LoadIniSettingsFromDisk", "family_id": "script.method.common.ImGui.LoadIniSettingsFromDisk", "kind": "method", "name": "LoadIniSettingsFromDisk", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LoadIniSettingsFromDisk(string iniFilename)", "description": "Loads ImGui window and table settings from a required nonempty filesystem path using ImGui's direct disk API", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "iniFilename", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.LoadIniSettingsFromMemory", "family_id": "script.method.common.ImGui.LoadIniSettingsFromMemory", "kind": "method", "name": "LoadIniSettingsFromMemory", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LoadIniSettingsFromMemory(string iniData)", "description": "Replaces ImGui window and table settings from the exact supplied in-memory ini bytes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2368 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "iniData", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.LogButtons", "family_id": "script.method.common.ImGui.LogButtons", "kind": "method", "name": "LogButtons", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LogButtons()", "description": "Draws ImGui's logging controls for starting and stopping supported log destinations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1870 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.LogFinish", "family_id": "script.method.common.ImGui.LogFinish", "kind": "method", "name": "LogFinish", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LogFinish()", "description": "Finishes the active ImGui logging session and flushes its destination", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1863 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.LogText", "family_id": "script.method.common.ImGui.LogText", "kind": "method", "name": "LogText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LogText(string text)", "description": "Appends the supplied text verbatim to the active ImGui logging destination without rendering a widget", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1877 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.LogToClipboard", "family_id": "script.method.common.ImGui.LogToClipboard", "kind": "method", "name": "LogToClipboard", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LogToClipboard(int32 autoOpenDepth = -1)", "description": "Starts automatic ImGui text logging to the clipboard with optional tree auto-open depth", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1856 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "autoOpenDepth", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.common.ImGui.LogToFile", "family_id": "script.method.common.ImGui.LogToFile", "kind": "method", "name": "LogToFile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LogToFile(int32 autoOpenDepth = -1, string filename = \"\")", "description": "Starts automatic ImGui text logging to the optional filename, or the configured default when empty, with optional tree auto-open depth", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1848 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "autoOpenDepth", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" }, { "name": "filename", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" } ] }, { "id": "script.method.common.ImGui.LogToTTY", "family_id": "script.method.common.ImGui.LogToTTY", "kind": "method", "name": "LogToTTY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.LogToTTY(int32 autoOpenDepth = -1)", "description": "Starts automatic ImGui text logging to the terminal, optionally auto-opening tree nodes to the supplied depth", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1841 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "autoOpenDepth", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.common.ImGui.MenuItem", "family_id": "script.method.common.ImGui.MenuItem", "kind": "method", "name": "MenuItem", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.MenuItem(string label, bool selected = false, bool enabled = true)", "description": "Draws a required nonempty-label menu item with display-only selected state and enabled state, returning whether it was activated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1619 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "selected", "type": "bool", "nullable": false, "by_reference": false, "default": "false" }, { "name": "enabled", "type": "bool", "nullable": false, "by_reference": false, "default": "true" } ] }, { "id": "script.method.common.ImGui.NewLine", "family_id": "script.method.common.ImGui.NewLine", "kind": "method", "name": "NewLine", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.NewLine()", "description": "Ends the current line and advances the layout cursor to a new line", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1107 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.OpenPopup", "family_id": "script.method.common.ImGui.OpenPopup", "kind": "method", "name": "OpenPopup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.OpenPopup(string strId, ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None)", "description": "Marks a popup with the required nonempty ID to open on the next matching BeginPopup call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1468 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "popupFlags", "type": "ImGui_PopupFlags", "nullable": false, "by_reference": false, "default": "ImGui_PopupFlags::None" } ] }, { "id": "script.method.common.ImGui.OpenPopupOnItemClick", "family_id": "script.method.common.ImGui.OpenPopupOnItemClick", "kind": "method", "name": "OpenPopupOnItemClick", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.OpenPopupOnItemClick(string strId = \"\", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::MouseButtonRight)", "description": "Opens a context popup when the last item is clicked under the supplied flags, using the last item's ID when strId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1564 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" }, { "name": "popupFlags", "type": "ImGui_PopupFlags", "nullable": false, "by_reference": false, "default": "ImGui_PopupFlags::MouseButtonRight" } ] }, { "id": "script.method.common.ImGui.PlotHistogram", "family_id": "script.method.common.ImGui.PlotHistogram", "kind": "method", "name": "PlotHistogram", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PlotHistogram(string label, float32[] values, int32 valuesOffset = 0, string overlay = \"\", float32 scaleMin = 3.402823466e+38f, float32 scaleMax = 3.402823466e+38f, fsize graphSize = fsize())", "description": "Draws a required nonempty-label histogram over the supplied values with offset, optional overlay, scale bounds, and graph size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2006 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "values", "type": "float32[]", "nullable": false, "by_reference": false, "default": null }, { "name": "valuesOffset", "type": "int32", "nullable": false, "by_reference": false, "default": "0" }, { "name": "overlay", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" }, { "name": "scaleMin", "type": "float32", "nullable": false, "by_reference": false, "default": "3.402823466e+38f" }, { "name": "scaleMax", "type": "float32", "nullable": false, "by_reference": false, "default": "3.402823466e+38f" }, { "name": "graphSize", "type": "fsize", "nullable": false, "by_reference": false, "default": "fsize()" } ] }, { "id": "script.method.common.ImGui.PlotLines", "family_id": "script.method.common.ImGui.PlotLines", "kind": "method", "name": "PlotLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PlotLines(string label, float32[] values, int32 valuesOffset = 0, string overlay = \"\", float32 scaleMin = 3.402823466e+38f, float32 scaleMax = 3.402823466e+38f, fsize graphSize = fsize())", "description": "Draws a required nonempty-label line plot over the supplied values with offset, optional overlay, scale bounds, and graph size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1993 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "values", "type": "float32[]", "nullable": false, "by_reference": false, "default": null }, { "name": "valuesOffset", "type": "int32", "nullable": false, "by_reference": false, "default": "0" }, { "name": "overlay", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" }, { "name": "scaleMin", "type": "float32", "nullable": false, "by_reference": false, "default": "3.402823466e+38f" }, { "name": "scaleMax", "type": "float32", "nullable": false, "by_reference": false, "default": "3.402823466e+38f" }, { "name": "graphSize", "type": "fsize", "nullable": false, "by_reference": false, "default": "fsize()" } ] }, { "id": "script.method.common.ImGui.PopID", "family_id": "script.method.common.ImGui.PopID", "kind": "method", "name": "PopID", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PopID()", "description": "Pops the most recently pushed component from the ImGui ID stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 191 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.PopItemWidth", "family_id": "script.method.common.ImGui.PopItemWidth", "kind": "method", "name": "PopItemWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PopItemWidth()", "description": "Restores the previous default item width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 634 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.PopStyleColor", "family_id": "script.method.common.ImGui.PopStyleColor", "kind": "method", "name": "PopStyleColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PopStyleColor(int32 count = 1)", "description": "Pops count entries from the ImGui style-color stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 205 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "count", "type": "int32", "nullable": false, "by_reference": false, "default": "1" } ] }, { "id": "script.method.common.ImGui.PopStyleVar", "family_id": "script.method.common.ImGui.PopStyleVar", "kind": "method", "name": "PopStyleVar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PopStyleVar(int32 count = 1)", "description": "Pops count entries from the ImGui style-variable stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 226 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "count", "type": "int32", "nullable": false, "by_reference": false, "default": "1" } ] }, { "id": "script.method.common.ImGui.PopTextWrapPos", "family_id": "script.method.common.ImGui.PopTextWrapPos", "kind": "method", "name": "PopTextWrapPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PopTextWrapPos()", "description": "Restores the previous text-wrapping position", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 588 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.ProgressBar#815e8744ccf75287", "family_id": "script.method.common.ImGui.ProgressBar", "kind": "method", "name": "ProgressBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.ProgressBar(float32 fraction)", "description": "Draws a progress bar using fraction as the completion ratio and ImGui's default size and overlay", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1932 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fraction", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.ProgressBar#f96f13b84ae54c68", "family_id": "script.method.common.ImGui.ProgressBar", "kind": "method", "name": "ProgressBar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.ProgressBar(float32 fraction, isize size, string overlay = \"\")", "description": "Draws a progress bar with the supplied completion ratio and size, using an explicit overlay or ImGui's percentage text when empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1939 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fraction", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "overlay", "type": "string", "nullable": false, "by_reference": false, "default": "\"\"" } ] }, { "id": "script.method.common.ImGui.PushID#a0aa657cec446999", "family_id": "script.method.common.ImGui.PushID", "kind": "method", "name": "PushID", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushID(string strId)", "description": "Pushes a required nonempty string component onto the ImGui ID stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 171 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "strId", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.PushID#e81ac04f2708cf59", "family_id": "script.method.common.ImGui.PushID", "kind": "method", "name": "PushID", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushID(int32 intId)", "description": "Pushes an integer component onto the ImGui ID stack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 183 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "intId", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.PushItemWidth", "family_id": "script.method.common.ImGui.PushItemWidth", "kind": "method", "name": "PushItemWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushItemWidth(float32 itemWidth)", "description": "Pushes a default width for subsequent items; restore it with PopItemWidth", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 627 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "itemWidth", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.PushStyleColor", "family_id": "script.method.common.ImGui.PushStyleColor", "kind": "method", "name": "PushStyleColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushStyleColor(ImGui_Col colorId, float32 r, float32 g, float32 b, float32 a)", "description": "Pushes an RGBA override for the selected ImGui style color; restore it with PopStyleColor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 198 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "colorId", "type": "ImGui_Col", "nullable": false, "by_reference": false, "default": null }, { "name": "r", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "g", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "b", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "a", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.PushStyleVar", "family_id": "script.method.common.ImGui.PushStyleVar", "kind": "method", "name": "PushStyleVar", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushStyleVar(ImGui_StyleVar styleVar, float32 value)", "description": "Pushes a scalar override for a scalar-valued ImGui style variable; restore it with PopStyleVar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "styleVar", "type": "ImGui_StyleVar", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.PushStyleVarVec2", "family_id": "script.method.common.ImGui.PushStyleVarVec2", "kind": "method", "name": "PushStyleVarVec2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushStyleVarVec2(ImGui_StyleVar styleVar, float32 x, float32 y)", "description": "Pushes a two-component override for a vector-valued ImGui style variable; restore it with PopStyleVar", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 219 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "styleVar", "type": "ImGui_StyleVar", "nullable": false, "by_reference": false, "default": null }, { "name": "x", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "y", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.PushTextWrapPos", "family_id": "script.method.common.ImGui.PushTextWrapPos", "kind": "method", "name": "PushTextWrapPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.PushTextWrapPos(float32 wrapLocalPosX = 0.0f)", "description": "Pushes a local X coordinate at which subsequent text wraps; zero uses the content-region boundary", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 581 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "wrapLocalPosX", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" } ] }, { "id": "script.method.common.ImGui.RadioButton#91a4f0c54483dccb", "family_id": "script.method.common.ImGui.RadioButton", "kind": "method", "name": "RadioButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.RadioButton(string label, int32& value, int32 buttonValue)", "description": "Draws a required nonempty-label radio button, assigns buttonValue to value when activated, and returns whether the assignment occurred", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1205 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "buttonValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.RadioButton#d8d7646ac97bdd7b", "family_id": "script.method.common.ImGui.RadioButton", "kind": "method", "name": "RadioButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.RadioButton(string label, bool active)", "description": "Draws a required nonempty-label radio button using active as display state and returns whether it was activated; active is not written back", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1194 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "active", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.ResetMouseDragDelta", "family_id": "script.method.common.ImGui.ResetMouseDragDelta", "kind": "method", "name": "ResetMouseDragDelta", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.ResetMouseDragDelta(ImGui_MouseButton mouseButton = ImGui_MouseButton::Left)", "description": "Resets the accumulated drag origin for the selected mouse button to the current mouse position", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1417 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "mouseButton", "type": "ImGui_MouseButton", "nullable": false, "by_reference": false, "default": "ImGui_MouseButton::Left" } ] }, { "id": "script.method.common.ImGui.SameLine", "family_id": "script.method.common.ImGui.SameLine", "kind": "method", "name": "SameLine", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SameLine(float32 offsetFromStartX = 0.0f, float32 spacing = -1.0f)", "description": "Places the next item on the current line with optional start offset and spacing overrides", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 613 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "offsetFromStartX", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" }, { "name": "spacing", "type": "float32", "nullable": false, "by_reference": false, "default": "-1.0f" } ] }, { "id": "script.method.common.ImGui.SaveIniSettingsToDisk", "family_id": "script.method.common.ImGui.SaveIniSettingsToDisk", "kind": "method", "name": "SaveIniSettingsToDisk", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SaveIniSettingsToDisk(string iniFilename)", "description": "Saves current ImGui window and table settings to a required nonempty filesystem path using ImGui's direct disk API", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2357 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "iniFilename", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SaveIniSettingsToMemory", "family_id": "script.method.common.ImGui.SaveIniSettingsToMemory", "kind": "method", "name": "SaveIniSettingsToMemory", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "string ImGui.SaveIniSettingsToMemory()", "description": "Serializes current ImGui window and table settings to a string, or returns an empty string when ImGui supplies no buffer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2375 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.Selectable", "family_id": "script.method.common.ImGui.Selectable", "kind": "method", "name": "Selectable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.Selectable(string label, bool selected = false, ImGui_SelectableFlags flags = ImGui_SelectableFlags::None)", "description": "Draws a required nonempty-label selectable using selected as display state and returns whether it was activated; selected is not written back", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1183 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "selected", "type": "bool", "nullable": false, "by_reference": false, "default": "false" }, { "name": "flags", "type": "ImGui_SelectableFlags", "nullable": false, "by_reference": false, "default": "ImGui_SelectableFlags::None" } ] }, { "id": "script.method.common.ImGui.Separator", "family_id": "script.method.common.ImGui.Separator", "kind": "method", "name": "Separator", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Separator()", "description": "Draws a separator appropriate to the current horizontal or vertical layout context", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1093 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.SeparatorText", "family_id": "script.method.common.ImGui.SeparatorText", "kind": "method", "name": "SeparatorText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SeparatorText(string label)", "description": "Draws a separator carrying a required nonempty label", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 507 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetClipboardText", "family_id": "script.method.common.ImGui.SetClipboardText", "kind": "method", "name": "SetClipboardText", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetClipboardText(string text)", "description": "Replaces text in ImGui's platform clipboard backend", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2339 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetColorEditOptions", "family_id": "script.method.common.ImGui.SetColorEditOptions", "kind": "method", "name": "SetColorEditOptions", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetColorEditOptions(ImGui_ColorEditFlags flags)", "description": "Sets default display, data-type, picker, and input options for subsequent color editors and pickers", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2159 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "flags", "type": "ImGui_ColorEditFlags", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetCursorPos", "family_id": "script.method.common.ImGui.SetCursorPos", "kind": "method", "name": "SetCursorPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetCursorPos(float32 x, float32 y)", "description": "Sets the current cursor position in window-local coordinates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 567 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "x", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "y", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetCursorScreenPos", "family_id": "script.method.common.ImGui.SetCursorScreenPos", "kind": "method", "name": "SetCursorScreenPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetCursorScreenPos(fpos pos)", "description": "Sets the current cursor position in screen coordinates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 574 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "fpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetItemDefaultFocus", "family_id": "script.method.common.ImGui.SetItemDefaultFocus", "kind": "method", "name": "SetItemDefaultFocus", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetItemDefaultFocus()", "description": "Gives the last submitted item default focus when its appearing window has no restored focus state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1424 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.SetItemTooltip", "family_id": "script.method.common.ImGui.SetItemTooltip", "kind": "method", "name": "SetItemTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetItemTooltip(string text)", "description": "Shows a text tooltip for the last item when ImGui's item-tooltip hover policy is satisfied", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1447 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetKeyboardFocusHere", "family_id": "script.method.common.ImGui.SetKeyboardFocusHere", "kind": "method", "name": "SetKeyboardFocusHere", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetKeyboardFocusHere(int32 offset = 0)", "description": "Requests keyboard focus for a focusable item at the supplied offset relative to the next submitted item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 595 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "offset", "type": "int32", "nullable": false, "by_reference": false, "default": "0" } ] }, { "id": "script.method.common.ImGui.SetNextItemOpen", "family_id": "script.method.common.ImGui.SetNextItemOpen", "kind": "method", "name": "SetNextItemOpen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextItemOpen(bool isOpen, ImGui_Cond cond = ImGui_Cond::None)", "description": "Sets the next tree node or collapsing header's open state subject to the supplied ImGui condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 525 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "isOpen", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "cond", "type": "ImGui_Cond", "nullable": false, "by_reference": false, "default": "ImGui_Cond::None" } ] }, { "id": "script.method.common.ImGui.SetNextItemWidth", "family_id": "script.method.common.ImGui.SetNextItemWidth", "kind": "method", "name": "SetNextItemWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextItemWidth(float32 itemWidth)", "description": "Overrides the width of the next submitted item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 620 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "itemWidth", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetNextWindowBgAlpha", "family_id": "script.method.common.ImGui.SetNextWindowBgAlpha", "kind": "method", "name": "SetNextWindowBgAlpha", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowBgAlpha(float32 alpha)", "description": "Overrides the background alpha of the next window", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "alpha", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetNextWindowCollapsed", "family_id": "script.method.common.ImGui.SetNextWindowCollapsed", "kind": "method", "name": "SetNextWindowCollapsed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowCollapsed(bool collapsed, ImGui_Cond cond = ImGui_Cond::None)", "description": "Sets whether the next window is collapsed subject to the supplied ImGui condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 247 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collapsed", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "cond", "type": "ImGui_Cond", "nullable": false, "by_reference": false, "default": "ImGui_Cond::None" } ] }, { "id": "script.method.common.ImGui.SetNextWindowContentSize", "family_id": "script.method.common.ImGui.SetNextWindowContentSize", "kind": "method", "name": "SetNextWindowContentSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowContentSize(isize size)", "description": "Sets the explicit content size of the next window, controlling its scrollable extent independently of the window size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetNextWindowFocus", "family_id": "script.method.common.ImGui.SetNextWindowFocus", "kind": "method", "name": "SetNextWindowFocus", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowFocus()", "description": "Requests focus for the next window begun in the current frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 268 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.SetNextWindowPos", "family_id": "script.method.common.ImGui.SetNextWindowPos", "kind": "method", "name": "SetNextWindowPos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowPos(ipos pos, ImGui_Cond cond = ImGui_Cond::None)", "description": "Sets the next window's screen position subject to the supplied ImGui condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 233 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "pos", "type": "ipos", "nullable": false, "by_reference": false, "default": null }, { "name": "cond", "type": "ImGui_Cond", "nullable": false, "by_reference": false, "default": "ImGui_Cond::None" } ] }, { "id": "script.method.common.ImGui.SetNextWindowScroll", "family_id": "script.method.common.ImGui.SetNextWindowScroll", "kind": "method", "name": "SetNextWindowScroll", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowScroll(fpos scroll)", "description": "Sets the next window's initial scroll coordinates; negative components leave the corresponding axis unchanged", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 275 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "scroll", "type": "fpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetNextWindowSize", "family_id": "script.method.common.ImGui.SetNextWindowSize", "kind": "method", "name": "SetNextWindowSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowSize(isize size, ImGui_Cond cond = ImGui_Cond::None)", "description": "Sets the next window's size subject to the supplied ImGui condition", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 240 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "cond", "type": "ImGui_Cond", "nullable": false, "by_reference": false, "default": "ImGui_Cond::None" } ] }, { "id": "script.method.common.ImGui.SetNextWindowSizeConstraints", "family_id": "script.method.common.ImGui.SetNextWindowSizeConstraints", "kind": "method", "name": "SetNextWindowSizeConstraints", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetNextWindowSizeConstraints(isize sizeMin, isize sizeMax)", "description": "Constrains the next window's size between the supplied minimum and maximum dimensions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "sizeMin", "type": "isize", "nullable": false, "by_reference": false, "default": null }, { "name": "sizeMax", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetScrollFromPosX", "family_id": "script.method.common.ImGui.SetScrollFromPosX", "kind": "method", "name": "SetScrollFromPosX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetScrollFromPosX(float32 localX, float32 centerXRatio = 0.5f)", "description": "Adjusts horizontal scrolling so a local X position appears at the requested viewport ratio", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 472 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "localX", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "centerXRatio", "type": "float32", "nullable": false, "by_reference": false, "default": "0.5f" } ] }, { "id": "script.method.common.ImGui.SetScrollFromPosY", "family_id": "script.method.common.ImGui.SetScrollFromPosY", "kind": "method", "name": "SetScrollFromPosY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetScrollFromPosY(float32 localY, float32 centerYRatio = 0.5f)", "description": "Adjusts vertical scrolling so a local Y position appears at the requested viewport ratio", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 479 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "localY", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "centerYRatio", "type": "float32", "nullable": false, "by_reference": false, "default": "0.5f" } ] }, { "id": "script.method.common.ImGui.SetScrollHereX", "family_id": "script.method.common.ImGui.SetScrollHereX", "kind": "method", "name": "SetScrollHereX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetScrollHereX(float32 centerXRatio = 0.5f)", "description": "Adjusts horizontal scrolling so the current cursor position appears at the requested viewport ratio", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 458 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "centerXRatio", "type": "float32", "nullable": false, "by_reference": false, "default": "0.5f" } ] }, { "id": "script.method.common.ImGui.SetScrollHereY", "family_id": "script.method.common.ImGui.SetScrollHereY", "kind": "method", "name": "SetScrollHereY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetScrollHereY(float32 centerYRatio = 0.5f)", "description": "Adjusts vertical scrolling so the current cursor position appears at the requested viewport ratio", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 465 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "centerYRatio", "type": "float32", "nullable": false, "by_reference": false, "default": "0.5f" } ] }, { "id": "script.method.common.ImGui.SetScrollX", "family_id": "script.method.common.ImGui.SetScrollX", "kind": "method", "name": "SetScrollX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetScrollX(float32 scrollX)", "description": "Sets the current window's horizontal scroll offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 430 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "scrollX", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetScrollY", "family_id": "script.method.common.ImGui.SetScrollY", "kind": "method", "name": "SetScrollY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetScrollY(float32 scrollY)", "description": "Sets the current window's vertical scroll offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 437 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "scrollY", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetTabItemClosed", "family_id": "script.method.common.ImGui.SetTabItemClosed", "kind": "method", "name": "SetTabItemClosed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetTabItemClosed(string tabLabel)", "description": "Notifies ImGui that a required nonempty-label tab was closed externally so its tab-bar state can be updated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1829 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "tabLabel", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SetTooltip", "family_id": "script.method.common.ImGui.SetTooltip", "kind": "method", "name": "SetTooltip", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.SetTooltip(string text)", "description": "Immediately renders a tooltip containing the supplied text verbatim", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1431 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SliderFloat", "family_id": "script.method.common.ImGui.SliderFloat", "kind": "method", "name": "SliderFloat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderFloat(string label, float32& value, float32 minValue, float32 maxValue)", "description": "Draws a required nonempty-label bounded float slider, updates value, and returns whether it changed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 929 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.SliderFloat2", "family_id": "script.method.common.ImGui.SliderFloat2", "kind": "method", "name": "SliderFloat2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderFloat2(string label, float32& valueX, float32& valueY, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label two-component bounded float slider and writes both components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 951 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SliderFloat3", "family_id": "script.method.common.ImGui.SliderFloat3", "kind": "method", "name": "SliderFloat3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderFloat3(string label, float32& valueX, float32& valueY, float32& valueZ, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label three-component bounded float slider and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 970 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SliderFloat4", "family_id": "script.method.common.ImGui.SliderFloat4", "kind": "method", "name": "SliderFloat4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderFloat4(string label, float32& valueX, float32& valueY, float32& valueZ, float32& valueW, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label four-component bounded float slider and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 990 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueW", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SliderInt", "family_id": "script.method.common.ImGui.SliderInt", "kind": "method", "name": "SliderInt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderInt(string label, int32& value, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label bounded integer slider with the supplied flags, updates value, and reports changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 940 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SliderInt2", "family_id": "script.method.common.ImGui.SliderInt2", "kind": "method", "name": "SliderInt2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderInt2(string label, int32& valueX, int32& valueY, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label two-component bounded integer slider and writes both components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1011 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SliderInt3", "family_id": "script.method.common.ImGui.SliderInt3", "kind": "method", "name": "SliderInt3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderInt3(string label, int32& valueX, int32& valueY, int32& valueZ, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label three-component bounded integer slider and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1030 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SliderInt4", "family_id": "script.method.common.ImGui.SliderInt4", "kind": "method", "name": "SliderInt4", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SliderInt4(string label, int32& valueX, int32& valueY, int32& valueZ, int32& valueW, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label four-component bounded integer slider and writes all components back only when they change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1050 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueX", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueY", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueZ", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "valueW", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.SmallButton", "family_id": "script.method.common.ImGui.SmallButton", "kind": "method", "name": "SmallButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.SmallButton(string label)", "description": "Draws a required nonempty-label button without standard frame padding and returns whether it was activated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1216 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Spacing", "family_id": "script.method.common.ImGui.Spacing", "kind": "method", "name": "Spacing", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Spacing()", "description": "Adds one standard vertical spacing unit to the current layout", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1100 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TabItemButton", "family_id": "script.method.common.ImGui.TabItemButton", "kind": "method", "name": "TabItemButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TabItemButton(string label, ImGui_TabItemFlags flags = ImGui_TabItemFlags::None)", "description": "Draws a required nonempty-label tab-bar button and returns whether it was activated; it does not create a tab contents scope", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1818 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TabItemFlags", "nullable": false, "by_reference": false, "default": "ImGui_TabItemFlags::None" } ] }, { "id": "script.method.common.ImGui.TableAngledHeadersRow", "family_id": "script.method.common.ImGui.TableAngledHeadersRow", "kind": "method", "name": "TableAngledHeadersRow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableAngledHeadersRow()", "description": "Emits an angled-header row for columns configured with angled-header flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1764 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableGetColumnCount", "family_id": "script.method.common.ImGui.TableGetColumnCount", "kind": "method", "name": "TableGetColumnCount", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "int32 ImGui.TableGetColumnCount()", "description": "Returns the current table's column count, or zero outside a table", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1715 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableGetColumnFlags", "family_id": "script.method.common.ImGui.TableGetColumnFlags", "kind": "method", "name": "TableGetColumnFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "ImGui_TableColumnFlags ImGui.TableGetColumnFlags(int32 columnN = -1)", "description": "Returns the requested table column's current status flags, using the current column when columnN is negative", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1743 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "ImGui_TableColumnFlags", "nullable": false }, "arguments": [ { "name": "columnN", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.common.ImGui.TableGetColumnIndex", "family_id": "script.method.common.ImGui.TableGetColumnIndex", "kind": "method", "name": "TableGetColumnIndex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "int32 ImGui.TableGetColumnIndex()", "description": "Returns the current table column index, or -1 before selecting a column or outside a table", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1722 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableGetColumnName", "family_id": "script.method.common.ImGui.TableGetColumnName", "kind": "method", "name": "TableGetColumnName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "string ImGui.TableGetColumnName(int32 columnN = -1)", "description": "Returns the requested table column's configured name, using the current column when columnN is negative", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1736 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "string", "nullable": false }, "arguments": [ { "name": "columnN", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.common.ImGui.TableGetHoveredColumn", "family_id": "script.method.common.ImGui.TableGetHoveredColumn", "kind": "method", "name": "TableGetHoveredColumn", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "int32 ImGui.TableGetHoveredColumn()", "description": "Returns the hovered table column index, with ImGui sentinel values for none or unused trailing space", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1757 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableGetRowIndex", "family_id": "script.method.common.ImGui.TableGetRowIndex", "kind": "method", "name": "TableGetRowIndex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "int32 ImGui.TableGetRowIndex()", "description": "Returns the current table row index, or -1 before starting a row or outside a table", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1729 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableHeader", "family_id": "script.method.common.ImGui.TableHeader", "kind": "method", "name": "TableHeader", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableHeader(string label)", "description": "Emits a required nonempty-label header cell for the current table column", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1679 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TableHeadersRow", "family_id": "script.method.common.ImGui.TableHeadersRow", "kind": "method", "name": "TableHeadersRow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableHeadersRow()", "description": "Emits one table header row from columns configured by TableSetupColumn", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1672 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableNextColumn", "family_id": "script.method.common.ImGui.TableNextColumn", "kind": "method", "name": "TableNextColumn", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TableNextColumn()", "description": "Advances to the next table column, creating a row when needed, and returns whether the destination column is visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1658 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.TableNextRow", "family_id": "script.method.common.ImGui.TableNextRow", "kind": "method", "name": "TableNextRow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableNextRow(ImGui_TableRowFlags rowFlags = ImGui_TableRowFlags::None)", "description": "Advances the current table to a new row using the supplied row flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1651 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "rowFlags", "type": "ImGui_TableRowFlags", "nullable": false, "by_reference": false, "default": "ImGui_TableRowFlags::None" } ] }, { "id": "script.method.common.ImGui.TableSetBgColor", "family_id": "script.method.common.ImGui.TableSetBgColor", "kind": "method", "name": "TableSetBgColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableSetBgColor(ImGui_TableBgTarget target, ucolor color, int32 columnN = -1)", "description": "Overrides a table row or cell background target with the supplied packed color, using the current column when columnN is negative", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1708 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "target", "type": "ImGui_TableBgTarget", "nullable": false, "by_reference": false, "default": null }, { "name": "color", "type": "ucolor", "nullable": false, "by_reference": false, "default": null }, { "name": "columnN", "type": "int32", "nullable": false, "by_reference": false, "default": "-1" } ] }, { "id": "script.method.common.ImGui.TableSetColumnEnabled", "family_id": "script.method.common.ImGui.TableSetColumnEnabled", "kind": "method", "name": "TableSetColumnEnabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableSetColumnEnabled(int32 columnN, bool enabled)", "description": "Enables or disables a table column by zero-based index", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1750 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "columnN", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "enabled", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TableSetColumnIndex", "family_id": "script.method.common.ImGui.TableSetColumnIndex", "kind": "method", "name": "TableSetColumnIndex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TableSetColumnIndex(int32 columnN)", "description": "Selects a table column by zero-based index and returns whether that column is visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1665 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "columnN", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TableSetupColumn", "family_id": "script.method.common.ImGui.TableSetupColumn", "kind": "method", "name": "TableSetupColumn", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableSetupColumn(string label, ImGui_TableColumnFlags flags = ImGui_TableColumnFlags::None)", "description": "Configures the next table column with a required nonempty label and column flags before the first row is submitted", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1690 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TableColumnFlags", "nullable": false, "by_reference": false, "default": "ImGui_TableColumnFlags::None" } ] }, { "id": "script.method.common.ImGui.TableSetupScrollFreeze", "family_id": "script.method.common.ImGui.TableSetupScrollFreeze", "kind": "method", "name": "TableSetupScrollFreeze", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TableSetupScrollFreeze(int32 cols, int32 rows)", "description": "Freezes the requested leading table columns and rows when the table scrolls", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1701 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cols", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "rows", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Text", "family_id": "script.method.common.ImGui.Text", "kind": "method", "name": "Text", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Text(string text)", "description": "Renders text verbatim without interpreting it as a printf-style format string", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 289 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TextColored", "family_id": "script.method.common.ImGui.TextColored", "kind": "method", "name": "TextColored", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TextColored(string text, float32 r, float32 g, float32 b, float32 a)", "description": "Renders the supplied text with an explicit RGBA color", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2019 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "r", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "g", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "b", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "a", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TextDisabled", "family_id": "script.method.common.ImGui.TextDisabled", "kind": "method", "name": "TextDisabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TextDisabled(string text)", "description": "Renders text using ImGui's disabled-text style", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 296 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TextLink", "family_id": "script.method.common.ImGui.TextLink", "kind": "method", "name": "TextLink", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TextLink(string label)", "description": "Draws a required nonempty-label text link and returns whether it was activated without opening a URL itself", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1955 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TextLinkOpenURL#6af05af1a530865a", "family_id": "script.method.common.ImGui.TextLinkOpenURL", "kind": "method", "name": "TextLinkOpenURL", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TextLinkOpenURL(string label, string url)", "description": "Draws a required nonempty-label link, asks ImGui's platform URL handler to open the required URL when activated, and reports activation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1979 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "url", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TextLinkOpenURL#b52d43bc02aa8901", "family_id": "script.method.common.ImGui.TextLinkOpenURL", "kind": "method", "name": "TextLinkOpenURL", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TextLinkOpenURL(string label)", "description": "Draws a required nonempty-label link, asks ImGui's platform URL handler to open the label when activated, and reports activation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1967 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TextWrapped", "family_id": "script.method.common.ImGui.TextWrapped", "kind": "method", "name": "TextWrapped", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TextWrapped(string text)", "description": "Renders text with wrapping at the current content-region boundary", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 303 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TreeNode", "family_id": "script.method.common.ImGui.TreeNode", "kind": "method", "name": "TreeNode", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TreeNode(string label)", "description": "Draws a required nonempty-label tree node and returns whether it is open; call TreePop only when true", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1154 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TreeNodeEx", "family_id": "script.method.common.ImGui.TreeNodeEx", "kind": "method", "name": "TreeNodeEx", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.TreeNodeEx(string label, ImGui_TreeNodeFlags flags)", "description": "Draws a required nonempty-label tree node with explicit flags and returns whether it is open; call TreePop only when true unless NoTreePushOnOpen is set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1165 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_TreeNodeFlags", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.TreePop", "family_id": "script.method.common.ImGui.TreePop", "kind": "method", "name": "TreePop", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.TreePop()", "description": "Pops the tree scope pushed by an open TreeNode or TreeNodeEx call", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1176 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.common.ImGui.Unindent", "family_id": "script.method.common.ImGui.Unindent", "kind": "method", "name": "Unindent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Unindent(float32 indentW = 0.0f)", "description": "Decreases the current line's horizontal indentation by the supplied amount or the style default when zero", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 662 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "indentW", "type": "float32", "nullable": false, "by_reference": false, "default": "0.0f" } ] }, { "id": "script.method.common.ImGui.VSliderFloat", "family_id": "script.method.common.ImGui.VSliderFloat", "kind": "method", "name": "VSliderFloat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.VSliderFloat(string label, fsize size, float32& value, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label vertical float slider of the supplied size and bounds, updates value, and reports changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1071 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "fsize", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.VSliderInt", "family_id": "script.method.common.ImGui.VSliderInt", "kind": "method", "name": "VSliderInt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.VSliderInt(string label, fsize size, int32& value, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None)", "description": "Draws a required nonempty-label vertical integer slider of the supplied size and bounds, updates value, and reports changes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 1082 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "label", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "size", "type": "fsize", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "minValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "maxValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "flags", "type": "ImGui_SliderFlags", "nullable": false, "by_reference": false, "default": "ImGui_SliderFlags::None" } ] }, { "id": "script.method.common.ImGui.Value#031100c2fda9013e", "family_id": "script.method.common.ImGui.Value", "kind": "method", "name": "Value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Value(string prefix, bool value)", "description": "Renders a boolean value after a required nonempty prefix using ImGui's standard value formatting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2026 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "prefix", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Value#11dff794976df969", "family_id": "script.method.common.ImGui.Value", "kind": "method", "name": "Value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Value(string prefix, int32 value)", "description": "Renders a signed integer value after a required nonempty prefix using ImGui's standard value formatting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2037 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "prefix", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Value#69d025366813cd9a", "family_id": "script.method.common.ImGui.Value", "kind": "method", "name": "Value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Value(string prefix, uint32 value)", "description": "Renders an unsigned integer value after a required nonempty prefix using ImGui's standard value formatting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2048 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "prefix", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.common.ImGui.Value#90152b1c9fa83617", "family_id": "script.method.common.ImGui.Value", "kind": "method", "name": "Value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "void ImGui.Value(string prefix, float32 value)", "description": "Renders a float value after a required nonempty prefix using ImGui's standard value formatting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/CommonImGuiScriptMethods.cpp", "line": 2059 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "receivers": [ "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "prefix", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddCritter#7053965abb306d1b", "family_id": "script.method.mapper.Game.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Critter Game.AddCritter(hstring pid, mpos hex)", "description": "Creates a critter from the supplied prototype id on a valid hex of the currently shown Mapper map and returns its editable client view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 140 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddCritter#fa5e6a45b39828c0", "family_id": "script.method.mapper.Game.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Critter Game.AddCritter(ProtoCritter proto, mpos hex)", "description": "Creates a critter from the supplied prototype on a valid hex of the currently shown Mapper map and returns its editable client view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 154 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddItem#659cb03d0e702e66", "family_id": "script.method.mapper.Game.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Item Game.AddItem(ProtoItem proto, mpos hex)", "description": "Creates an item from the supplied prototype on a valid hex of the currently shown Mapper map and returns its editable client view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 126 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddItem#f08c1b76d0bf34c1", "family_id": "script.method.mapper.Game.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Item Game.AddItem(hstring pid, mpos hex)", "description": "Creates an item from the supplied prototype id on a valid hex of the currently shown Mapper map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 112 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddMapperIgnoredItemPids", "family_id": "script.method.mapper.Game.AddMapperIgnoredItemPids", "kind": "method", "name": "AddMapperIgnoredItemPids", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.AddMapperIgnoredItemPids(hstring[] itemPids)", "description": "Adds item prototype ids to the current map's Mapper ignore set and rebuilds the map view so the filtering takes effect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 865 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "itemPids", "type": "hstring[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddMessage", "family_id": "script.method.mapper.Game.AddMessage", "kind": "method", "name": "AddMessage", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.AddMessage(string message)", "description": "Appends a message to the Mapper's on-screen message log", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 683 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "message", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.AddTile", "family_id": "script.method.mapper.Game.AddTile", "kind": "method", "name": "AddTile", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Item Game.AddTile(hstring pid, mpos hex, int32 layer, bool roof)", "description": "Adds an editable floor or roof tile of a known item prototype to a valid current-map hex, clamping its layer to the supported zero-through-four range", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 320 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "layer", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "roof", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.CalcMapperFitZoom", "family_id": "script.method.mapper.Game.CalcMapperFitZoom", "kind": "method", "name": "CalcMapperFitZoom", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "float32 Game.CalcMapperFitZoom(isize viewportSize)", "description": "Calculates the smaller horizontal or vertical zoom needed to fit the configured playable area, or the full map bounds, inside a positive viewport", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 888 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "float32", "nullable": false }, "arguments": [ { "name": "viewportSize", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.CenterMapperOnHex", "family_id": "script.method.mapper.Game.CenterMapperOnHex", "kind": "method", "name": "CenterMapperOnHex", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.CenterMapperOnHex(mpos hex)", "description": "Centers and rebuilds the current Mapper view on a valid in-map hex; an invalid hex or missing current map throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 746 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.CenterMapperOnPlayableArea", "family_id": "script.method.mapper.Game.CenterMapperOnPlayableArea", "kind": "method", "name": "CenterMapperOnPlayableArea", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.CenterMapperOnPlayableArea()", "description": "Centers and rebuilds the Mapper view on the configured axial playable area, including off-map coordinates, or on the map dimensions when no area is configured", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 724 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.CenterMapperOnRawHex", "family_id": "script.method.mapper.Game.CenterMapperOnRawHex", "kind": "method", "name": "CenterMapperOnRawHex", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.CenterMapperOnRawHex(ipos rawHex)", "description": "Centers and rebuilds the current Mapper view on an unclamped raw hex coordinate, allowing authored playable areas outside the map rectangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 759 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "rawHex", "type": "ipos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.DeleteEntities", "family_id": "script.method.mapper.Game.DeleteEntities", "kind": "method", "name": "DeleteEntities", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.DeleteEntities(Entity[] entities)", "description": "Deletes each non-null, non-destroyed editable entity in the supplied collection and skips unusable entries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 234 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entities", "type": "Entity[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.DeleteEntity", "family_id": "script.method.mapper.Game.DeleteEntity", "kind": "method", "name": "DeleteEntity", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.DeleteEntity(Entity entity)", "description": "Deletes one editable entity through the Mapper's normal deletion path", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 227 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.FindEntityById", "family_id": "script.method.mapper.Game.FindEntityById", "kind": "method", "name": "FindEntityById", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Entity? Game.FindEntityById(ident id)", "description": "Finds an editable entity by runtime id on the currently shown Mapper map, or returns null when it is absent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Entity?", "nullable": true }, "arguments": [ { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.GetCritterOnHex", "family_id": "script.method.mapper.Game.GetCritterOnHex", "kind": "method", "name": "GetCritterOnHex", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Critter? Game.GetCritterOnHex(mpos hex, CritterFindType findType)", "description": "Returns the first critter on a hex that passes the requested find-type filter, or null when none match", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 186 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.GetCrittersOnHex", "family_id": "script.method.mapper.Game.GetCrittersOnHex", "kind": "method", "name": "GetCrittersOnHex", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Critter[] Game.GetCrittersOnHex(mpos hex, CritterFindType findType)", "description": "Returns all critters on a hex of the current Mapper map that pass the requested find-type filter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 201 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.GetCurMapHexSize", "family_id": "script.method.mapper.Game.GetCurMapHexSize", "kind": "method", "name": "GetCurMapHexSize", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "msize Game.GetCurMapHexSize()", "description": "Returns the current Mapper map's dimensions in hex cells; throws when no map is shown", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 690 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "msize", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.GetCurMapPixelSize", "family_id": "script.method.mapper.Game.GetCurMapPixelSize", "kind": "method", "name": "GetCurMapPixelSize", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "isize Game.GetCurMapPixelSize()", "description": "Returns the current Mapper map's full hex-grid bounding size in pixels; throws when no map is shown", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 699 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "isize", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.GetItemOnHex", "family_id": "script.method.mapper.Game.GetItemOnHex", "kind": "method", "name": "GetItemOnHex", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Item? Game.GetItemOnHex(mpos hex)", "description": "Returns the current Mapper map's single-item lookup result for a hex, or null when no item is selected there", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 168 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.GetItemsOnHex", "family_id": "script.method.mapper.Game.GetItemsOnHex", "kind": "method", "name": "GetItemsOnHex", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Item[] Game.GetItemsOnHex(mpos hex)", "description": "Returns all editable item views occupying a hex on the currently shown Mapper map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 177 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.GetLoadedMaps", "family_id": "script.method.mapper.Game.GetLoadedMaps", "kind": "method", "name": "GetLoadedMaps", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Map[] Game.GetLoadedMaps(int32& index)", "description": "Returns all loaded Mapper maps in load order and writes the current map's index, or -1 when no returned map is current", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 418 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Map[]", "nullable": false }, "arguments": [ { "name": "index", "type": "int32&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.mapper.Game.GetMapFileNames", "family_id": "script.method.mapper.Game.GetMapFileNames", "kind": "method", "name": "GetMapFileNames", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "string[] Game.GetMapFileNames(string dir, bool recursive)", "description": "Enumerates declared map names from prototype files under a Mapper maps directory, optionally descending recursively", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 442 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "string[]", "nullable": false }, "arguments": [ { "name": "dir", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "recursive", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.GetMapperScrollBorderHexes", "family_id": "script.method.mapper.Game.GetMapperScrollBorderHexes", "kind": "method", "name": "GetMapperScrollBorderHexes", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "mpos[] Game.GetMapperScrollBorderHexes()", "description": "Returns drawable in-map hexes lying on the configured axial scroll-area border, or an empty array when no map or border is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 818 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "mpos[]", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.GetMapperTrackOverlayHexes", "family_id": "script.method.mapper.Game.GetMapperTrackOverlayHexes", "kind": "method", "name": "GetMapperTrackOverlayHexes", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "mpos[] Game.GetMapperTrackOverlayHexes()", "description": "Returns the hex sequence currently exposed by the Mapper track overlay", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 804 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "mpos[]", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.GetMapperTrackOverlayKinds", "family_id": "script.method.mapper.Game.GetMapperTrackOverlayKinds", "kind": "method", "name": "GetMapperTrackOverlayKinds", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "int32[] Game.GetMapperTrackOverlayKinds()", "description": "Returns the per-entry kind values aligned with the Mapper track overlay hex sequence", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 811 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "int32[]", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.GetSelectedEntities", "family_id": "script.method.mapper.Game.GetSelectedEntities", "kind": "method", "name": "GetSelectedEntities", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Entity[] Game.GetSelectedEntities()", "description": "Returns a snapshot of all entities in the Mapper's current selection order", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 284 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Entity[]", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.GetSelectedEntity", "family_id": "script.method.mapper.Game.GetSelectedEntity", "kind": "method", "name": "GetSelectedEntity", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Entity? Game.GetSelectedEntity()", "description": "Returns the first selected Mapper entity, or null when the selection is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 277 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Entity?", "nullable": true }, "arguments": [] }, { "id": "script.method.mapper.Game.GetVisibleMapLayers", "family_id": "script.method.mapper.Game.GetVisibleMapLayers", "kind": "method", "name": "GetVisibleMapLayers", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "MapLayers Game.GetVisibleMapLayers()", "description": "Returns the map layers currently visible in the Mapper viewport", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "MapLayers", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.IsMapperHexOverlayVisible", "family_id": "script.method.mapper.Game.IsMapperHexOverlayVisible", "kind": "method", "name": "IsMapperHexOverlayVisible", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "bool Game.IsMapperHexOverlayVisible()", "description": "Returns whether the Mapper-wide hex overlay is visible", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 797 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.IsMapperOverlayVisible", "family_id": "script.method.mapper.Game.IsMapperOverlayVisible", "kind": "method", "name": "IsMapperOverlayVisible", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "bool Game.IsMapperOverlayVisible()", "description": "Returns whether the current map's general Mapper overlay is visible, or false when no map is shown", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 777 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.mapper.Game.LoadMap", "family_id": "script.method.mapper.Game.LoadMap", "kind": "method", "name": "LoadMap", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Map? Game.LoadMap(string fileName)", "description": "Loads a map from the Mapper file system by file name and returns its view, or null when loading fails", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 371 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "fileName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.MoveEntity", "family_id": "script.method.mapper.Game.MoveEntity", "kind": "method", "name": "MoveEntity", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.MoveEntity(Entity? entity, mpos hex)", "description": "Moves a non-null editable entity to a valid hex of the current Mapper map; a null entity is ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity?", "nullable": true, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.NewMap", "family_id": "script.method.mapper.Game.NewMap", "kind": "method", "name": "NewMap", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Map? Game.NewMap(string name, int32 width, int32 height)", "description": "Creates and loads a minimal named map with dimensions clamped to Engine limits and its work hex at the center; an empty name throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 339 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "width", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "height", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.NewMapFromText", "family_id": "script.method.mapper.Game.NewMapFromText", "kind": "method", "name": "NewMapFromText", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "Map? Game.NewMapFromText(string name, string text)", "description": "Loads a named map from authored text that contains a ProtoMap section; an empty name or missing section throws, while parse failure may return null", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 357 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "text", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.ResizeMap", "family_id": "script.method.mapper.Game.ResizeMap", "kind": "method", "name": "ResizeMap", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.ResizeMap(int32 width, int32 height)", "description": "Resizes the currently shown Mapper map to the requested dimensions through the editor's normal resize operation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 465 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "width", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "height", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SaveMap", "family_id": "script.method.mapper.Game.SaveMap", "kind": "method", "name": "SaveMap", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SaveMap(Map map, string customName)", "description": "Saves the supplied Mapper map using an optional custom name through the normal map-save path", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 386 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "customName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SaveMapToPath", "family_id": "script.method.mapper.Game.SaveMapToPath", "kind": "method", "name": "SaveMapToPath", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SaveMapToPath(Map map, string subDir, string name)", "description": "Saves a map beneath the Mapper maps root using a subdirectory and separator-free name; empty names and parent traversal are rejected", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 393 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "subDir", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SaveMapperScreenshot", "family_id": "script.method.mapper.Game.SaveMapperScreenshot", "kind": "method", "name": "SaveMapperScreenshot", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SaveMapperScreenshot(string filePath)", "description": "Saves the current map rendering as PNG to a nonempty file path using the Mapper's map-only screenshot path", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 931 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "filePath", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SelectEntities", "family_id": "script.method.mapper.Game.SelectEntities", "kind": "method", "name": "SelectEntities", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SelectEntities(Entity[] entities, bool set)", "description": "Adds or removes every non-null entity in the supplied collection from the Mapper selection according to set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entities", "type": "Entity[]", "nullable": false, "by_reference": false, "default": null }, { "name": "set", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SelectEntity", "family_id": "script.method.mapper.Game.SelectEntity", "kind": "method", "name": "SelectEntity", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SelectEntity(Entity entity, bool set)", "description": "Adds one editable entity to the Mapper selection when set is true, or removes it when false", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 249 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "set", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetEntityProperty", "family_id": "script.method.mapper.Game.SetEntityProperty", "kind": "method", "name": "SetEntityProperty", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "bool Game.SetEntityProperty(Entity entity, string propName, string valueText)", "description": "Parses and applies a named property value to an editable entity, returning whether Mapper accepted the text; an unknown property name throws", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 307 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "propName", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "valueText", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMapperHexOverlayVisible", "family_id": "script.method.mapper.Game.SetMapperHexOverlayVisible", "kind": "method", "name": "SetMapperHexOverlayVisible", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMapperHexOverlayVisible(bool visible)", "description": "Shows or hides the Mapper-wide hex overlay", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 790 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "visible", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMapperHiddenSpritesVisible", "family_id": "script.method.mapper.Game.SetMapperHiddenSpritesVisible", "kind": "method", "name": "SetMapperHiddenSpritesVisible", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMapperHiddenSpritesVisible(bool visible)", "description": "Shows or hides sprites marked as hidden on the currently displayed Mapper map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 856 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "visible", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMapperOverlayVisible", "family_id": "script.method.mapper.Game.SetMapperOverlayVisible", "kind": "method", "name": "SetMapperOverlayVisible", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMapperOverlayVisible(bool visible)", "description": "Shows or hides the general Mapper overlay on the currently displayed map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 768 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "visible", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMapperScrollCheckEnabled", "family_id": "script.method.mapper.Game.SetMapperScrollCheckEnabled", "kind": "method", "name": "SetMapperScrollCheckEnabled", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMapperScrollCheckEnabled(bool enabled)", "description": "Enables or disables scroll checking on the current Mapper map and rebuilds its view", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 878 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "enabled", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMapperViewSize", "family_id": "script.method.mapper.Game.SetMapperViewSize", "kind": "method", "name": "SetMapperViewSize", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMapperViewSize(isize size)", "description": "Sets a positive rendering viewport size on the currently shown Mapper map; nonpositive dimensions or a missing map throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 711 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "size", "type": "isize", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMapperZoom", "family_id": "script.method.mapper.Game.SetMapperZoom", "kind": "method", "name": "SetMapperZoom", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMapperZoom(float32 zoom)", "description": "Applies a positive zoom immediately to the current Mapper map and updates its zoom target; nonpositive values or a missing map throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 917 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "zoom", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetMouseScroll", "family_id": "script.method.mapper.Game.SetMouseScroll", "kind": "method", "name": "SetMouseScroll", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetMouseScroll(bool inFullscreen, bool inWindow)", "description": "Configures whether edge-driven mouse scrolling is enabled in fullscreen and windowed Mapper modes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 104 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "inFullscreen", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "inWindow", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.SetVisibleMapLayers", "family_id": "script.method.mapper.Game.SetVisibleMapLayers", "kind": "method", "name": "SetVisibleMapLayers", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.SetVisibleMapLayers(MapLayers layers)", "description": "Replaces the map layers visible in the Mapper viewport and applies the visibility state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 96 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "layers", "type": "MapLayers", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.ShowMap", "family_id": "script.method.mapper.Game.ShowMap", "kind": "method", "name": "ShowMap", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.ShowMap(Map map)", "description": "Makes the supplied loaded map the map currently shown by the Mapper", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 411 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabDelete", "family_id": "script.method.mapper.Game.TabDelete", "kind": "method", "name": "TabDelete", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.TabDelete(int32 tab)", "description": "Clears a valid Mapper content tab, recreates its empty aggregate default subtab, and makes that subtab active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 637 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabGetCritterPids", "family_id": "script.method.mapper.Game.TabGetCritterPids", "kind": "method", "name": "TabGetCritterPids", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "hstring[] Game.TabGetCritterPids(int32 tab, string subTab)", "description": "Returns critter prototype ids from a valid Mapper tab and named subtab, using the aggregate default subtab when the name is empty; an unknown named subtab returns an empty array", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 494 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "hstring[]", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "subTab", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabGetItemPids", "family_id": "script.method.mapper.Game.TabGetItemPids", "kind": "method", "name": "TabGetItemPids", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "hstring[] Game.TabGetItemPids(int32 tab, string subTab)", "description": "Returns item prototype ids from a valid Mapper tab and named subtab, using the aggregate default subtab when the name is empty; an unknown named subtab returns an empty array", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 473 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "hstring[]", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "subTab", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabSelect", "family_id": "script.method.mapper.Game.TabSelect", "kind": "method", "name": "TabSelect", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.TabSelect(int32 tab, string subTab, bool show)", "description": "Optionally shows a valid Mapper panel mode and selects an existing named or default content subtab when that mode owns content tabs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 650 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "subTab", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "show", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabSetCritterPids", "family_id": "script.method.mapper.Game.TabSetCritterPids", "kind": "method", "name": "TabSetCritterPids", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.TabSetCritterPids(int32 tab, string subTab, hstring[] critterPids)", "description": "Replaces a custom Mapper subtab's critter prototypes, or deletes that subtab for an empty list, then rebuilds the aggregate default list and active prototype palette; unknown ids throw", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 576 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "subTab", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "critterPids", "type": "hstring[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabSetItemPids", "family_id": "script.method.mapper.Game.TabSetItemPids", "kind": "method", "name": "TabSetItemPids", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.TabSetItemPids(int32 tab, string subTab, hstring[] itemPids)", "description": "Replaces a custom Mapper subtab's known item prototypes, or deletes that subtab for an empty list, then rebuilds the aggregate default list and active prototype palette", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 515 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "subTab", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "itemPids", "type": "hstring[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.TabSetName", "family_id": "script.method.mapper.Game.TabSetName", "kind": "method", "name": "TabSetName", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.TabSetName(int32 tab, string tabName)", "description": "Replaces the display name of a valid Mapper panel mode", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 672 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "tab", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "tabName", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.mapper.Game.UnloadMap", "family_id": "script.method.mapper.Game.UnloadMap", "kind": "method", "name": "UnloadMap", "runtime_sides": [ "mapper" ], "receiver": "Game", "signature": "void Game.UnloadMap(Map map)", "description": "Unloads the supplied map view from the Mapper", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/MapperGlobalScriptMethods.cpp", "line": 379 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "mapper", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.Action", "family_id": "script.method.server.Critter.Action", "kind": "method", "name": "Action", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.Action(CritterAction action, int32 actionData, AbstractItem? contextItem)", "description": "SyncScope: requires self + context item when non-null; sends/broadcasts action only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 705 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "action", "type": "CritterAction", "nullable": false, "by_reference": false, "default": null }, { "name": "actionData", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "contextItem", "type": "AbstractItem?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.AddItem#6029176d1f44719d", "family_id": "script.method.server.Critter.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item Critter.AddItem(ProtoItem proto)", "description": "SyncScope: requires self; creates and attaches a new inventory item under self's cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 473 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.AddItem#e8b1d5e540061d17", "family_id": "script.method.server.Critter.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item Critter.AddItem(hstring pid)", "description": "SyncScope: requires self; creates and attaches a new inventory item under self's cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 455 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.AttachToCritter", "family_id": "script.method.server.Critter.AttachToCritter", "kind": "method", "name": "AttachToCritter", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.AttachToCritter(Critter cr)", "description": "SyncScope: requires self + cr, and both must be on the same covered map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 922 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.ChangeItemSlot", "family_id": "script.method.server.Critter.ChangeItemSlot", "kind": "method", "name": "ChangeItemSlot", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.ChangeItemSlot(ident itemId, CritterItemSlot slot)", "description": "SyncScope: requires self + inventory item; mutates item slot and fires movement/equipment events", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 589 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "slot", "type": "CritterItemSlot", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.ChangeMovingSpeed", "family_id": "script.method.server.Critter.ChangeMovingSpeed", "kind": "method", "name": "ChangeMovingSpeed", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.ChangeMovingSpeed(int32 speed)", "description": "SyncScope: requires self; changes current movement speed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 911 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.DetachAllCritters", "family_id": "script.method.server.Critter.DetachAllCritters", "kind": "method", "name": "DetachAllCritters", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.DetachAllCritters()", "description": "SyncScope: requires self and attached critters; detaches each attached critter and refreshes visibility", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 974 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.DetachFromCritter", "family_id": "script.method.server.Critter.DetachFromCritter", "kind": "method", "name": "DetachFromCritter", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.DetachFromCritter()", "description": "SyncScope: requires self + current map; detaches self and refreshes visibility", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 962 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.Disconnect", "family_id": "script.method.server.Critter.Disconnect", "kind": "method", "name": "Disconnect", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.Disconnect()", "description": "SyncScope: requires self + its auto-widened Player link; closes that player's connection", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 732 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.GetAttachedCritters", "family_id": "script.method.server.Critter.GetAttachedCritters", "kind": "method", "name": "GetAttachedCritters", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Critter[] Critter.GetAttachedCritters()", "description": "SyncScope: requires self; returned attached critters need their own cover before mutation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 985 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.GetCritter", "family_id": "script.method.server.Critter.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Critter? Critter.GetCritter(ident id, CritterSeeType seeType)", "description": "SyncScope: requires self; observer lookup may need self's map covered when self is mapped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "seeType", "type": "CritterSeeType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetCritters", "family_id": "script.method.server.Critter.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Critter[] Critter.GetCritters(CritterSeeType seeType, CritterFindType findType)", "description": "SyncScope: requires self and current map when mapped; returned critters are covered only while that cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 384 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "seeType", "type": "CritterSeeType", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetGlobalMapCritterIds", "family_id": "script.method.server.Critter.GetGlobalMapCritterIds", "kind": "method", "name": "GetGlobalMapCritterIds", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "ident[] Critter.GetGlobalMapCritterIds(uint64& revision)", "description": "SyncScope: requires self; returns the ids of self's current global-map group together with the group's\nmembership revision (empty with revision 0 when self is mapped). Group members are independent Critter roots\nthat self's cover does not include, so a caller that sends initial info to, transfers, or destroys a\nglobal-map critter resolves and covers the returned ids and then re-reads ids plus revision to prove the\nmembership did not change while it was acquiring that cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "ident[]", "nullable": false }, "arguments": [ { "name": "revision", "type": "uint64&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.server.Critter.GetItem#20907df3571a66a9", "family_id": "script.method.server.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned inventory item is covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 511 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetItem#3e4a8f273e418d3b", "family_id": "script.method.server.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(ident itemId)", "description": "SyncScope: requires self; returned inventory item is covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 485 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetItem#5042179ea08a430e", "family_id": "script.method.server.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(hstring protoId)", "description": "SyncScope: requires self; returned inventory item is covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 497 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetItem#8eedde0030f87e84", "family_id": "script.method.server.Critter.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item? Critter.GetItem(ProtoItem proto)", "description": "SyncScope: requires self; returned inventory item is covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 504 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetItems#83c145745774df22", "family_id": "script.method.server.Critter.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item[] Critter.GetItems(ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned inventory items are covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 534 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetItems#a6ae510092488b1e", "family_id": "script.method.server.Critter.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item[] Critter.GetItems(hstring protoId)", "description": "SyncScope: requires self; returned inventory items are covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 553 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetItems#b851260ade7c353c", "family_id": "script.method.server.Critter.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item[] Critter.GetItems()", "description": "SyncScope: requires self; returned inventory items are covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 526 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.GetItems#ef66ddcc26718dfe", "family_id": "script.method.server.Critter.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Item[] Critter.GetItems(ProtoItem proto)", "description": "SyncScope: requires self; returned inventory items are covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 571 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.GetMap", "family_id": "script.method.server.Critter.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Map? Critter.GetMap()", "description": "SyncScope: requires self; returns the current parent map handle, but does not cover it for later reads", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 100 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Map?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Critter.GetMovingContext", "family_id": "script.method.server.Critter.GetMovingContext", "kind": "method", "name": "GetMovingContext", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "MovingContext? Critter.GetMovingContext()", "description": "SyncScope: requires self; returned movement context is a snapshot handle for self's active move", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "MovingContext?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Critter.GetMovingState", "family_id": "script.method.server.Critter.GetMovingState", "kind": "method", "name": "GetMovingState", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "MovingState Critter.GetMovingState()", "description": "SyncScope: requires self; reads current movement state only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 897 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "MovingState", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.GetMovingUid", "family_id": "script.method.server.Critter.GetMovingUid", "kind": "method", "name": "GetMovingUid", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "uint32 Critter.GetMovingUid()", "description": "SyncScope: requires self; reads current movement uid only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "uint32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.GetPlayer", "family_id": "script.method.server.Critter.GetPlayer", "kind": "method", "name": "GetPlayer", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "Player? Critter.GetPlayer()", "description": "SyncScope: requires self; returns the auto-widen partner Player when one is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "Player?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Critter.GetPlayerOfflineTime", "family_id": "script.method.server.Critter.GetPlayerOfflineTime", "kind": "method", "name": "GetPlayerOfflineTime", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "timespan Critter.GetPlayerOfflineTime()", "description": "SyncScope: requires self; reads offline state for this critter's player link only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 993 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "timespan", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.GetVisibilityMode", "family_id": "script.method.server.Critter.GetVisibilityMode", "kind": "method", "name": "GetVisibilityMode", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "CritterVisibilityMode Critter.GetVisibilityMode(Critter cr)", "description": "SyncScope: requires self + cr; reads self's visibility-mode cache for a covered critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 433 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "CritterVisibilityMode", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.IsAlive", "family_id": "script.method.server.Critter.IsAlive", "kind": "method", "name": "IsAlive", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsAlive()", "description": "SyncScope: requires self; reads current condition state only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 334 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.IsDead", "family_id": "script.method.server.Critter.IsDead", "kind": "method", "name": "IsDead", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsDead()", "description": "SyncScope: requires self; reads current condition state only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 348 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.IsKnockout", "family_id": "script.method.server.Critter.IsKnockout", "kind": "method", "name": "IsKnockout", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsKnockout()", "description": "SyncScope: requires self; reads current condition state only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 341 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.IsMoving", "family_id": "script.method.server.Critter.IsMoving", "kind": "method", "name": "IsMoving", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsMoving()", "description": "SyncScope: requires self; reads current movement flag only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 70 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.IsOnline", "family_id": "script.method.server.Critter.IsOnline", "kind": "method", "name": "IsOnline", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsOnline()", "description": "SyncScope: requires self + its auto-widened Player link; reads online state only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 778 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.IsSee#11f3357f2df75c38", "family_id": "script.method.server.Critter.IsSee", "kind": "method", "name": "IsSee", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsSee(Critter cr)", "description": "SyncScope: requires self + cr; checks self's visibility cache for a covered critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 407 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.IsSee#c05ec9ee4a1d9b41", "family_id": "script.method.server.Critter.IsSee", "kind": "method", "name": "IsSee", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsSee(Item item)", "description": "SyncScope: requires self + item; checks self's visible-item cache for a covered item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 446 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.IsSeenBy", "family_id": "script.method.server.Critter.IsSeenBy", "kind": "method", "name": "IsSeenBy", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "bool Critter.IsSeenBy(Critter cr)", "description": "SyncScope: requires self + cr; checks cr's visibility cache for this covered critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 420 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.MakeControllable", "family_id": "script.method.server.Critter.MakeControllable", "kind": "method", "name": "MakeControllable", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.MakeControllable(bool controllable)", "description": "SyncScope: requires self + current map; changes controllable/player state and may self-sync map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 745 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "controllable", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.MoveToHex#59785332969dbd15", "family_id": "script.method.server.Critter.MoveToHex", "kind": "method", "name": "MoveToHex", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "MovingContext Critter.MoveToHex(mpos hex, int32 cut, int32 speed, callback(bool,Critter,Item) gagCallabck)", "description": "SyncScope: requires self + current map; starts movement and returns the new movement context", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 869 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "MovingContext", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallabck", "type": "callback(bool,Critter,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.MoveToHex#877a3be2a55ba41a", "family_id": "script.method.server.Critter.MoveToHex", "kind": "method", "name": "MoveToHex", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "MovingContext Critter.MoveToHex(mpos hex, int32 cut, ipos16 endHexOffset, int32 speed, callback(bool,Critter,Item) gagCallabck)", "description": "SyncScope: requires self + current map; starts movement and returns the new movement context", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 878 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "MovingContext", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "endHexOffset", "type": "ipos16", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallabck", "type": "callback(bool,Critter,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.MoveToHex#b27a6e0f0f8ceddb", "family_id": "script.method.server.Critter.MoveToHex", "kind": "method", "name": "MoveToHex", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "MovingContext Critter.MoveToHex(mpos hex, int32 cut, ipos16 endHexOffset, int32 maxPathLength, int32 speed, callback(bool,Critter,Item) gagCallabck)", "description": "A request whose route would be longer than maxPathLength steps is refused as HexTooFar, and the refusal costs\nno more than a search of that depth; 0 keeps Geometry.MaxPathFindLength", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 888 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "MovingContext", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "endHexOffset", "type": "ipos16", "nullable": false, "by_reference": false, "default": null }, { "name": "maxPathLength", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "speed", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallabck", "type": "callback(bool,Critter,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.RefreshView", "family_id": "script.method.server.Critter.RefreshView", "kind": "method", "name": "RefreshView", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.RefreshView()", "description": "SyncScope: requires self + current map when mapped; recomputes visible critters/items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 355 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.RefreshVisibility", "family_id": "script.method.server.Critter.RefreshVisibility", "kind": "method", "name": "RefreshVisibility", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.RefreshVisibility()", "description": "SyncScope: requires self + current map when mapped; recomputes visible critters/items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 1000 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.SendGlobalMapGroupInfo", "family_id": "script.method.server.Critter.SendGlobalMapGroupInfo", "kind": "method", "name": "SendGlobalMapGroupInfo", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.SendGlobalMapGroupInfo()", "description": "SyncScope: requires self + every critter of self's current global-map group; sends the other members to self's\nplayer without acquiring any cover. Initial info sends only the critter itself, so a caller that attaches a\nglobal-map critter to a player covers the group (Sync::WidenCritterWithGlobalMapGroup) and then calls this", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 122 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.SendItems", "family_id": "script.method.server.Critter.SendItems", "kind": "method", "name": "SendItems", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.SendItems(Item[] items, bool owned = false, bool withInnerEntities = false, any contextParam = any())", "description": "SyncScope: requires self + every non-null item in items; sends a network payload without changing cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 714 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "items", "type": "Item[]", "nullable": false, "by_reference": false, "default": null }, { "name": "owned", "type": "bool", "nullable": false, "by_reference": false, "default": "false" }, { "name": "withInnerEntities", "type": "bool", "nullable": false, "by_reference": false, "default": "false" }, { "name": "contextParam", "type": "any", "nullable": false, "by_reference": false, "default": "any()" } ] }, { "id": "script.method.server.Critter.SetCondition", "family_id": "script.method.server.Critter.SetCondition", "kind": "method", "name": "SetCondition", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.SetCondition(CritterCondition cond, CritterActionAnim actionAnim, AbstractItem? contextItem)", "description": "SyncScope: requires self + current map when mapped + context item when non-null; mutates condition and map fields", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 659 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cond", "type": "CritterCondition", "nullable": false, "by_reference": false, "default": null }, { "name": "actionAnim", "type": "CritterActionAnim", "nullable": false, "by_reference": false, "default": null }, { "name": "contextItem", "type": "AbstractItem?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.SetDir", "family_id": "script.method.server.Critter.SetDir", "kind": "method", "name": "SetDir", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.SetDir(mdir dir)", "description": "SyncScope: requires self; mutates direction and broadcasts it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 363 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.SetupScript", "family_id": "script.method.server.Critter.SetupScript", "kind": "method", "name": "SetupScript", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.SetupScript(callback(void,Critter,bool) initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 44 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "callback(void,Critter,bool)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.SetupScriptEx", "family_id": "script.method.server.Critter.SetupScriptEx", "kind": "method", "name": "SetupScriptEx", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.SetupScriptEx(hstring initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.StopMoving", "family_id": "script.method.server.Critter.StopMoving", "kind": "method", "name": "StopMoving", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.StopMoving()", "description": "SyncScope: requires self; stops current movement", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 904 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.TransferToGlobal", "family_id": "script.method.server.Critter.TransferToGlobal", "kind": "method", "name": "TransferToGlobal", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToGlobal()", "description": "SyncScope: requires self + current source map when self is mapped; mutates self to global-map state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 239 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Critter.TransferToGlobalGroup", "family_id": "script.method.server.Critter.TransferToGlobalGroup", "kind": "method", "name": "TransferToGlobalGroup", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToGlobalGroup(Critter globalCr)", "description": "SyncScope: requires self + globalCr; if self is mapped also requires self's current source map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 281 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "globalCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.TransferToGlobalWithGroup", "family_id": "script.method.server.Critter.TransferToGlobalWithGroup", "kind": "method", "name": "TransferToGlobalWithGroup", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToGlobalWithGroup(Critter[] group)", "description": "SyncScope: requires self + current source map and every group critter + its current source map before transfer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "group", "type": "Critter[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.TransferToHex#8438d509ef6a8651", "family_id": "script.method.server.Critter.TransferToHex", "kind": "method", "name": "TransferToHex", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToHex(mpos hex, mdir dir)", "description": "SyncScope: requires self + current map; transfer keeps self covered and mutates current-map placement/dir", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 167 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.TransferToHex#a9a09ef8641e16c0", "family_id": "script.method.server.Critter.TransferToHex", "kind": "method", "name": "TransferToHex", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToHex(mpos hex)", "description": "SyncScope: requires self + current map; transfer keeps self covered and mutates current-map placement", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 145 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.TransferToMap#c9880f573836f54f", "family_id": "script.method.server.Critter.TransferToMap", "kind": "method", "name": "TransferToMap", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToMap(Map map, mpos hex)", "description": "SyncScope: requires self + source map if mapped + destination map + destination location; scripts should use Sync::LockForTransferToMap(self, map)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 198 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Critter.TransferToMap#dc3840f5d203dd4b", "family_id": "script.method.server.Critter.TransferToMap", "kind": "method", "name": "TransferToMap", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "void Critter.TransferToMap(Map map, mpos hex, mdir dir, bool preciseHex = false)", "description": "SyncScope: requires self + source map if mapped + destination map + destination location; scripts should use Sync::LockForTransferToMap(self, map)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerCritterScriptMethods.cpp", "line": 216 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Critter" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "preciseHex", "type": "bool", "nullable": false, "by_reference": false, "default": "false" } ] }, { "id": "script.method.server.Entity.CountTimeEvent#08f3341698dc846a", "family_id": "script.method.server.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity,any) func)", "description": "SyncScope: requires self; counts events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 156 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.CountTimeEvent#5609075e34e56857", "family_id": "script.method.server.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity) func)", "description": "SyncScope: requires self; counts events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 149 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.CountTimeEvent#9c7dd3ed70f86a7d", "family_id": "script.method.server.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity,TimeEventContext) func)", "description": "SyncScope: requires self; counts events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 170 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.CountTimeEvent#ad56856359be786a", "family_id": "script.method.server.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(callback(void,Entity,any[]) func)", "description": "SyncScope: requires self; counts events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 163 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.CountTimeEvent#e41a67022275199d", "family_id": "script.method.server.Entity.CountTimeEvent", "kind": "method", "name": "CountTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "int32 Entity.CountTimeEvent(uint32 id)", "description": "SyncScope: requires self; counts events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 177 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.GetRefCount", "family_id": "script.method.server.Entity.GetRefCount", "kind": "method", "name": "GetRefCount", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "int32 Entity.GetRefCount()", "description": "A reference-leak diagnostic: every script wrapper and in-flight native pin is counted, so only a difference\nmeasured around a controlled sequence of calls means anything", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game", "Player", "Location", "Map", "Critter", "Item", "ImGui" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Entity.IsPersistent", "family_id": "script.method.server.Entity.IsPersistent", "kind": "method", "name": "IsPersistent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "bool Entity.IsPersistent()", "description": "SyncScope: requires self; reads persistence flag only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 43 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game", "Player", "Location", "Map", "Critter", "Item", "ImGui" ], "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Entity.MakePersistent", "family_id": "script.method.server.Entity.MakePersistent", "kind": "method", "name": "MakePersistent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.MakePersistent(bool persistent)", "description": "SyncScope: requires self; persistence cascade may self-sync covered child entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 50 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game", "Player", "Location", "Map", "Critter", "Item", "ImGui" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "persistent", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.RepeatTimeEvent#28154675b58100aa", "family_id": "script.method.server.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(uint32 id, timespan repeat)", "description": "SyncScope: requires self; updates repeat for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 247 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.RepeatTimeEvent#35eb685e9352ee97", "family_id": "script.method.server.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity,any) func, timespan repeat)", "description": "SyncScope: requires self; updates repeat for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 226 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.RepeatTimeEvent#4c1ec6146e414fed", "family_id": "script.method.server.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity,any[]) func, timespan repeat)", "description": "SyncScope: requires self; updates repeat for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 233 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.RepeatTimeEvent#d107502adf65e851", "family_id": "script.method.server.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity,TimeEventContext) func, timespan repeat)", "description": "SyncScope: requires self; updates repeat for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 240 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.RepeatTimeEvent#d3e5bb91010a5ee6", "family_id": "script.method.server.Entity.RepeatTimeEvent", "kind": "method", "name": "RepeatTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.RepeatTimeEvent(callback(void,Entity) func, timespan repeat)", "description": "SyncScope: requires self; updates repeat for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 219 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.SetTimeEventData#09c025b7150b6bcd", "family_id": "script.method.server.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,any) func, any data)", "description": "SyncScope: requires self; updates data for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.SetTimeEventData#46ce3a8e59df0b76", "family_id": "script.method.server.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,any[]) func, any[] data)", "description": "SyncScope: requires self; updates data for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.SetTimeEventData#995b7ca79df38c35", "family_id": "script.method.server.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(uint32 id, any data)", "description": "SyncScope: requires self; updates data for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.SetTimeEventData#adb2b4962b8e3874", "family_id": "script.method.server.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(uint32 id, any[] data)", "description": "SyncScope: requires self; updates data for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 289 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.SetTimeEventData#c02fbdd5c31ecb21", "family_id": "script.method.server.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any[] data)", "description": "SyncScope: requires self; updates data for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 275 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.SetTimeEventData#c41820f30638ac18", "family_id": "script.method.server.Entity.SetTimeEventData", "kind": "method", "name": "SetTimeEventData", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any data)", "description": "SyncScope: requires self; updates data for event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 268 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#170befe9003e3411", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any data)", "description": "SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#1e937a7976df63ac", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func)", "description": "SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#492d95e09fb651ed", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any[] data)", "description": "SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 100 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#494379a91f97d59e", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity) func)", "description": "SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 107 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#64daaaa7e6125cb3", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any[] data)", "description": "SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 142 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#805b4b72ba72a604", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any[]) func, any[] data)", "description": "SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 121 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#9e1b092a1d7fb963", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any) func, any data)", "description": "SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 114 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#ae9a39c7d8c1d6fa", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any) func, any data)", "description": "SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 72 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#af2f95f5513a4cfa", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func)", "description": "SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 128 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#b494dfd4a4fa81ea", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any[]) func, any[] data)", "description": "SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 79 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#d9b6635334d5ae05", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any data)", "description": "SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null }, { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StartTimeEvent#e59548a665ddb838", "family_id": "script.method.server.Entity.StartTimeEvent", "kind": "method", "name": "StartTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity) func)", "description": "SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 65 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "uint32", "nullable": false }, "arguments": [ { "name": "delay", "type": "timespan", "nullable": false, "by_reference": false, "default": null }, { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StopTimeEvent#1ff4e8b7bdb6f35c", "family_id": "script.method.server.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity,any) func)", "description": "SyncScope: requires self; stops events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 191 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StopTimeEvent#58fd464d379e5ea5", "family_id": "script.method.server.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity,TimeEventContext) func)", "description": "SyncScope: requires self; stops events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 205 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,TimeEventContext)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StopTimeEvent#be90949683fff93d", "family_id": "script.method.server.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(uint32 id)", "description": "SyncScope: requires self; stops event bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "id", "type": "uint32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StopTimeEvent#d792082ed73a8fc8", "family_id": "script.method.server.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity) func)", "description": "SyncScope: requires self; stops events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 184 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Entity.StopTimeEvent#ddfbd34ed1764f92", "family_id": "script.method.server.Entity.StopTimeEvent", "kind": "method", "name": "StopTimeEvent", "runtime_sides": [ "server" ], "receiver": "Entity", "signature": "void Entity.StopTimeEvent(callback(void,Entity,any[]) func)", "description": "SyncScope: requires self; stops events bound to self, no cover change", "flags": [ "TimeEventRelated" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerEntityScriptMethods.cpp", "line": 198 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player", "Location", "Map", "Critter", "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "func", "type": "callback(void,Entity,any[])", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CallStaticItemFunction", "family_id": "script.method.server.Game.CallStaticItemFunction", "kind": "method", "name": "CallStaticItemFunction", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.CallStaticItemFunction(Critter? cr, StaticItem staticItem, Item? usedItem, any param)", "description": "SyncScope: requires cr and usedItem when non-null; staticItem is static map data, not a live entity cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter?", "nullable": true, "by_reference": false, "default": null }, { "name": "staticItem", "type": "StaticItem", "nullable": false, "by_reference": false, "default": null }, { "name": "usedItem", "type": "Item?", "nullable": true, "by_reference": false, "default": null }, { "name": "param", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CloneItem", "family_id": "script.method.server.Game.CloneItem", "kind": "method", "name": "CloneItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item Game.CloneItem(Item item)", "description": "Clones the complete live item and returns the new item with synchronization cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 333 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateCritter#151d7b0fa45c079e", "family_id": "script.method.server.Game.CreateCritter", "kind": "method", "name": "CreateCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter Game.CreateCritter(hstring protoId, bool forPlayer, CritterProperty=>any props)", "description": "SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "forPlayer", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "CritterProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateCritter#e68fa5ea3ffe3cc4", "family_id": "script.method.server.Game.CreateCritter", "kind": "method", "name": "CreateCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter Game.CreateCritter(ProtoCritter proto, bool forPlayer)", "description": "SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "forPlayer", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateCritter#e774d859a418b9da", "family_id": "script.method.server.Game.CreateCritter", "kind": "method", "name": "CreateCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter Game.CreateCritter(hstring protoId, bool forPlayer)", "description": "SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "forPlayer", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateCritter#e8d3f028fa79075f", "family_id": "script.method.server.Game.CreateCritter", "kind": "method", "name": "CreateCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter Game.CreateCritter(ProtoCritter proto, bool forPlayer, CritterProperty=>any props)", "description": "SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 97 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "forPlayer", "type": "bool", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "CritterProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateItem#27766bb940021b1f", "family_id": "script.method.server.Game.CreateItem", "kind": "method", "name": "CreateItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item Game.CreateItem(hstring protoId, ItemProperty=>int32 props)", "description": "Creates an item with integer property overrides applied before OnItemInit and returns it with synchronization cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 313 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "ItemProperty=>int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateItem#6029176d1f44719d", "family_id": "script.method.server.Game.CreateItem", "kind": "method", "name": "CreateItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item Game.CreateItem(ProtoItem proto)", "description": "Creates an item from the supplied prototype descriptor and returns it with synchronization cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 306 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateItem#ba49673cbfedbc07", "family_id": "script.method.server.Game.CreateItem", "kind": "method", "name": "CreateItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item Game.CreateItem(hstring protoId)", "description": "Creates an item from the supplied prototype id and returns it with synchronization cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 295 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateLocation#03c25a496a41709a", "family_id": "script.method.server.Game.CreateLocation", "kind": "method", "name": "CreateLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location Game.CreateLocation(hstring protoId, hstring[] map_pids, LocationProperty=>any props)", "description": "SyncScope: creates a new location/maps in the current context; returned location is covered by registration self-sync", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 613 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "map_pids", "type": "hstring[]", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "LocationProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateLocation#09335f3291c54d05", "family_id": "script.method.server.Game.CreateLocation", "kind": "method", "name": "CreateLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location Game.CreateLocation(ProtoLocation proto, LocationProperty=>any props)", "description": "SyncScope: creates a new location in the current context; returned location is covered by registration self-sync", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 598 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoLocation", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "LocationProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateLocation#392f59fecd72fe17", "family_id": "script.method.server.Game.CreateLocation", "kind": "method", "name": "CreateLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location Game.CreateLocation(ProtoLocation proto)", "description": "SyncScope: creates a new location in the current context; returned location is covered by registration self-sync", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 561 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoLocation", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateLocation#4f3d2969824dd3bc", "family_id": "script.method.server.Game.CreateLocation", "kind": "method", "name": "CreateLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location Game.CreateLocation(hstring protoId)", "description": "SyncScope: creates a new location in the current context; returned location is covered by registration self-sync", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 553 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateLocation#5a0f0539462eafe3", "family_id": "script.method.server.Game.CreateLocation", "kind": "method", "name": "CreateLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location Game.CreateLocation(hstring protoId, hstring[] map_pids)", "description": "SyncScope: creates a new location/maps in the current context; returned location is covered by registration self-sync", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 569 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "map_pids", "type": "hstring[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateLocation#c94de2fea30a1454", "family_id": "script.method.server.Game.CreateLocation", "kind": "method", "name": "CreateLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location Game.CreateLocation(hstring protoId, LocationProperty=>any props)", "description": "SyncScope: creates a new location in the current context; returned location is covered by registration self-sync", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 577 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "LocationProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.CreateNotLoggedInPlayer", "family_id": "script.method.server.Game.CreateNotLoggedInPlayer", "kind": "method", "name": "CreateNotLoggedInPlayer", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Player Game.CreateNotLoggedInPlayer()", "description": "SyncScope: no existing entity cover required; creates a disconnected not-logged-in player session", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 699 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Player", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.DbGetAllRecordIds", "family_id": "script.method.server.Game.DbGetAllRecordIds", "kind": "method", "name": "DbGetAllRecordIds", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "ident[] Game.DbGetAllRecordIds(hstring collectionName)", "description": "SyncScope: database collection scan only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1040 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "ident[]", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbGetAllRecordKeys", "family_id": "script.method.server.Game.DbGetAllRecordKeys", "kind": "method", "name": "DbGetAllRecordKeys", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "string[] Game.DbGetAllRecordKeys(hstring collectionName)", "description": "SyncScope: database collection scan only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1051 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "string[]", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbGetPlayerData", "family_id": "script.method.server.Game.DbGetPlayerData", "kind": "method", "name": "DbGetPlayerData", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "string=>string Game.DbGetPlayerData(ident playerId)", "description": "SyncScope: database lookup only; does not touch live player entity cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1071 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "string=>string", "nullable": false }, "arguments": [ { "name": "playerId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbGetRecord#86e082d9df76b104", "family_id": "script.method.server.Game.DbGetRecord", "kind": "method", "name": "DbGetRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "string=>string Game.DbGetRecord(hstring collectionName, string id)", "description": "SyncScope: database record read only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "string=>string", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbGetRecord#c524f7821136061a", "family_id": "script.method.server.Game.DbGetRecord", "kind": "method", "name": "DbGetRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "string=>string Game.DbGetRecord(hstring collectionName, ident id)", "description": "SyncScope: database record read only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1117 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "string=>string", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbHasEntity", "family_id": "script.method.server.Game.DbHasEntity", "kind": "method", "name": "DbHasEntity", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.DbHasEntity(Entity entity)", "description": "SyncScope: requires entity for type/id read; database lookup itself does not cover a live entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1062 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbHasRecord#31a3ffa964f519b8", "family_id": "script.method.server.Game.DbHasRecord", "kind": "method", "name": "DbHasRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.DbHasRecord(hstring collectionName, string id)", "description": "SyncScope: database record lookup only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1103 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbHasRecord#e13466af940b3833", "family_id": "script.method.server.Game.DbHasRecord", "kind": "method", "name": "DbHasRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.DbHasRecord(hstring collectionName, ident id)", "description": "SyncScope: database record lookup only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1089 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbInsertRecord#23ac03d711edaa50", "family_id": "script.method.server.Game.DbInsertRecord", "kind": "method", "name": "DbInsertRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbInsertRecord(hstring collectionName, ident id, string=>string keyValues)", "description": "SyncScope: database record insert only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1159 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "keyValues", "type": "string=>string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbInsertRecord#27a079e12448f9d8", "family_id": "script.method.server.Game.DbInsertRecord", "kind": "method", "name": "DbInsertRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbInsertRecord(hstring collectionName, string id, string=>string keyValues)", "description": "SyncScope: database record insert only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1196 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "keyValues", "type": "string=>string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbRemoveRecord#2039b29db1a1d593", "family_id": "script.method.server.Game.DbRemoveRecord", "kind": "method", "name": "DbRemoveRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbRemoveRecord(hstring collectionName, ident id)", "description": "SyncScope: database record remove only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbRemoveRecord#2749ed5b0c8482ba", "family_id": "script.method.server.Game.DbRemoveRecord", "kind": "method", "name": "DbRemoveRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbRemoveRecord(hstring collectionName, string id)", "description": "SyncScope: database record remove only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1353 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordBool#6b7737017a2e23dd", "family_id": "script.method.server.Game.DbUpdateRecordBool", "kind": "method", "name": "DbUpdateRecordBool", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordBool(hstring collectionName, ident id, string key, bool value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1323 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordBool#717491d844575aca", "family_id": "script.method.server.Game.DbUpdateRecordBool", "kind": "method", "name": "DbUpdateRecordBool", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordBool(hstring collectionName, string id, string key, bool value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1330 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordFloat64#0e7e221242df2792", "family_id": "script.method.server.Game.DbUpdateRecordFloat64", "kind": "method", "name": "DbUpdateRecordFloat64", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordFloat64(hstring collectionName, ident id, string key, float64 value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1309 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float64", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordFloat64#f5d0799b4804bb25", "family_id": "script.method.server.Game.DbUpdateRecordFloat64", "kind": "method", "name": "DbUpdateRecordFloat64", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordFloat64(hstring collectionName, string id, string key, float64 value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1316 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "float64", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordInt64#4b791154e44562fd", "family_id": "script.method.server.Game.DbUpdateRecordInt64", "kind": "method", "name": "DbUpdateRecordInt64", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordInt64(hstring collectionName, string id, string key, int64 value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1302 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int64", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordInt64#91d6b71d16aee463", "family_id": "script.method.server.Game.DbUpdateRecordInt64", "kind": "method", "name": "DbUpdateRecordInt64", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordInt64(hstring collectionName, ident id, string key, int64 value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1295 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "int64", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordString#76e92f4eee20fb7b", "family_id": "script.method.server.Game.DbUpdateRecordString", "kind": "method", "name": "DbUpdateRecordString", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordString(hstring collectionName, ident id, string key, string value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1281 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DbUpdateRecordString#cbc3625de444b49c", "family_id": "script.method.server.Game.DbUpdateRecordString", "kind": "method", "name": "DbUpdateRecordString", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DbUpdateRecordString(hstring collectionName, string id, string key, string value)", "description": "SyncScope: database record update only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1288 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "collectionName", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "id", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "key", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "value", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyCritter", "family_id": "script.method.server.Game.DestroyCritter", "kind": "method", "name": "DestroyCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyCritter(Critter? cr)", "description": "SyncScope: requires cr + current source map when cr is non-null and not player-controlled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 521 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyCritters", "family_id": "script.method.server.Game.DestroyCritters", "kind": "method", "name": "DestroyCritters", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyCritters(Critter[] critters)", "description": "SyncScope: requires every non-null cr + current source map when not player-controlled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 536 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "critters", "type": "Critter[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyEntities", "family_id": "script.method.server.Game.DestroyEntities", "kind": "method", "name": "DestroyEntities", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyEntities(Entity[] entities)", "description": "SyncScope: requires every non-null entity + current parent when present; destroys each subtree", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 481 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entities", "type": "Entity[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyEntity", "family_id": "script.method.server.Game.DestroyEntity", "kind": "method", "name": "DestroyEntity", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyEntity(Entity? entity)", "description": "SyncScope: requires entity + current parent when entity is non-null; destroys the entity subtree", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 469 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyItem", "family_id": "script.method.server.Game.DestroyItem", "kind": "method", "name": "DestroyItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyItem(Item? item)", "description": "SyncScope: requires item + current item parent when item is non-null; destroys the item subtree", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 495 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "item", "type": "Item?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyItems", "family_id": "script.method.server.Game.DestroyItems", "kind": "method", "name": "DestroyItems", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyItems(Item[] items)", "description": "SyncScope: requires every non-null item + current item parent; destroys each item subtree", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 507 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "items", "type": "Item[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyLocation", "family_id": "script.method.server.Game.DestroyLocation", "kind": "method", "name": "DestroyLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyLocation(Location? loc)", "description": "SyncScope: requires loc when non-null; destroy cascade self-syncs covered child maps/entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 634 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "loc", "type": "Location?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyMap", "family_id": "script.method.server.Game.DestroyMap", "kind": "method", "name": "DestroyMap", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyMap(Map? map)", "description": "SyncScope: requires map + parent location when map is non-null; destroy cascade self-syncs covered child entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 646 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.DestroyUnloadedCritter", "family_id": "script.method.server.Game.DestroyUnloadedCritter", "kind": "method", "name": "DestroyUnloadedCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.DestroyUnloadedCritter(ident crId)", "description": "SyncScope: unloaded-record operation only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 130 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "crId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetAllItems#5f63b29e3fbd4374", "family_id": "script.method.server.Game.GetAllItems", "kind": "method", "name": "GetAllItems", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item[] Game.GetAllItems(ProtoItem? proto)", "description": "SyncScope: registry scan only; returned item handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 991 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetAllItems#986ac88634199639", "family_id": "script.method.server.Game.GetAllItems", "kind": "method", "name": "GetAllItems", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item[] Game.GetAllItems(hstring pid)", "description": "SyncScope: registry scan only; returned item handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 971 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetAllNpc#568d2e4962ad093b", "family_id": "script.method.server.Game.GetAllNpc", "kind": "method", "name": "GetAllNpc", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter[] Game.GetAllNpc(hstring pid)", "description": "SyncScope: registry scan only; returned NPC critter handles are not covered for later reads/mutations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1377 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetAllNpc#d318af6f5c78cd43", "family_id": "script.method.server.Game.GetAllNpc", "kind": "method", "name": "GetAllNpc", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter[] Game.GetAllNpc(ProtoCritter proto)", "description": "SyncScope: registry scan only; returned NPC critter handles are not covered for later reads/mutations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1396 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetAllNpc#e7c595cfaf4c11a4", "family_id": "script.method.server.Game.GetAllNpc", "kind": "method", "name": "GetAllNpc", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter[] Game.GetAllNpc()", "description": "SyncScope: registry scan only; returned NPC critter handles are not covered for later reads/mutations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1369 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetAllocatorMemoryUsage", "family_id": "script.method.server.Game.GetAllocatorMemoryUsage", "kind": "method", "name": "GetAllocatorMemoryUsage", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int64 Game.GetAllocatorMemoryUsage()", "description": "SyncScope: allocator metric read only; no entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1730 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int64", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetCritter", "family_id": "script.method.server.Game.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter? Game.GetCritter(ident crId)", "description": "SyncScope: registry lookup only; returned critter handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 658 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "crId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetCritterRegistryCount", "family_id": "script.method.server.Game.GetCritterRegistryCount", "kind": "method", "name": "GetCritterRegistryCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetCritterRegistryCount()", "description": "SyncScope: registry count only; no entity cover required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1767 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetCritters", "family_id": "script.method.server.Game.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter[] Game.GetCritters(CritterFindType findType)", "description": "SyncScope: registry scan only; returned critter handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 682 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#1be05ad1508d9bdf", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Item item1, Item item2)", "description": "SyncScope: requires item1 + item2; reads same-map placement from the covered items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 158 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "item1", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "item2", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#200d823fdf545d92", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Item item, Critter cr)", "description": "SyncScope: requires item + cr; reads same-map placement from the covered entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 198 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#33a4d51ef8eece2a", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(mpos hex, Critter cr)", "description": "SyncScope: requires cr; reads critter placement from the covered critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 236 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#3dade8869ec8c0ac", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Critter cr, Item item)", "description": "SyncScope: requires cr + item; reads same-map placement from the covered entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 177 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#8298d537bb9c7c37", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Item item, mpos hex)", "description": "SyncScope: requires item; reads item placement from the covered item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 253 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#8a80a760debf852d", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Critter cr, mpos hex)", "description": "SyncScope: requires cr; reads critter placement from the covered critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 219 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#b273c01749f73e8c", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(mpos hex, Item item)", "description": "SyncScope: requires item; reads item placement from the covered item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 268 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetDistance#dacea0c00ba4c5f1", "family_id": "script.method.server.Game.GetDistance", "kind": "method", "name": "GetDistance", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetDistance(Critter cr1, Critter cr2)", "description": "SyncScope: requires cr1 + cr2; reads same-map placement from the covered critters", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 137 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr1", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "cr2", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetEntity", "family_id": "script.method.server.Game.GetEntity", "kind": "method", "name": "GetEntity", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Entity? Game.GetEntity(ident entityId)", "description": "SyncScope: registry lookup only; returned entity handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 670 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Entity?", "nullable": true }, "arguments": [ { "name": "entityId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetEntityRegistryCount", "family_id": "script.method.server.Game.GetEntityRegistryCount", "kind": "method", "name": "GetEntityRegistryCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetEntityRegistryCount()", "description": "SyncScope: registry count only; no entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1739 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetHeldSyncEntities", "family_id": "script.method.server.Game.GetHeldSyncEntities", "kind": "method", "name": "GetHeldSyncEntities", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Entity[] Game.GetHeldSyncEntities()", "description": "SyncScope: returns current held cover; does not change cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1687 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Entity[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetItem", "family_id": "script.method.server.Game.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item? Game.GetItem(ident itemId)", "description": "SyncScope: registry lookup only; returned item handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 283 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetItemRegistryCount", "family_id": "script.method.server.Game.GetItemRegistryCount", "kind": "method", "name": "GetItemRegistryCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetItemRegistryCount()", "description": "SyncScope: registry count only; no entity cover required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1774 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetItemRegistryProtoIds", "family_id": "script.method.server.Game.GetItemRegistryProtoIds", "kind": "method", "name": "GetItemRegistryProtoIds", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "hstring[] Game.GetItemRegistryProtoIds()", "description": "SyncScope: registry snapshot of proto ids only; reads the registry map without touching entity state,\nso no entity cover is required. Intended for test-harness leak diagnostics", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1782 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "hstring[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetLocation#08a98bf7bce0a9bf", "family_id": "script.method.server.Game.GetLocation", "kind": "method", "name": "GetLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location? Game.GetLocation(ident locId)", "description": "SyncScope: registry lookup only; returned location handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 850 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location?", "nullable": true }, "arguments": [ { "name": "locId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetLocation#2f5eccddea2f5dd1", "family_id": "script.method.server.Game.GetLocation", "kind": "method", "name": "GetLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location? Game.GetLocation(ProtoLocation locProto, int32 skipCount = 0)", "description": "SyncScope: registry lookup only; returned location handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 866 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location?", "nullable": true }, "arguments": [ { "name": "locProto", "type": "ProtoLocation", "nullable": false, "by_reference": false, "default": null }, { "name": "skipCount", "type": "int32", "nullable": false, "by_reference": false, "default": "0" } ] }, { "id": "script.method.server.Game.GetLocation#4b1903ede1dd2fa2", "family_id": "script.method.server.Game.GetLocation", "kind": "method", "name": "GetLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location? Game.GetLocation(hstring locPid, int32 skipCount = 0)", "description": "SyncScope: registry lookup only; returned location handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 858 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location?", "nullable": true }, "arguments": [ { "name": "locPid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "skipCount", "type": "int32", "nullable": false, "by_reference": false, "default": "0" } ] }, { "id": "script.method.server.Game.GetLocation#8d03e18599ee2a1e", "family_id": "script.method.server.Game.GetLocation", "kind": "method", "name": "GetLocation", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location? Game.GetLocation(LocationProperty property, int32 propertyValue)", "description": "SyncScope: registry scan only; returned location handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 875 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location?", "nullable": true }, "arguments": [ { "name": "property", "type": "LocationProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetLocationRegistryCount", "family_id": "script.method.server.Game.GetLocationRegistryCount", "kind": "method", "name": "GetLocationRegistryCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetLocationRegistryCount()", "description": "SyncScope: registry count only; no entity cover required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1753 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetLocations#53d313c4ee2358d8", "family_id": "script.method.server.Game.GetLocations", "kind": "method", "name": "GetLocations", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location[] Game.GetLocations()", "description": "SyncScope: registry scan only; returned location handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 891 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetLocations#7e3ec9d90972cfaf", "family_id": "script.method.server.Game.GetLocations", "kind": "method", "name": "GetLocations", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location[] Game.GetLocations(ProtoLocation? proto)", "description": "SyncScope: registry scan only; returned location handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 926 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoLocation?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetLocations#8eb7a49e747de27a", "family_id": "script.method.server.Game.GetLocations", "kind": "method", "name": "GetLocations", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location[] Game.GetLocations(hstring pid)", "description": "SyncScope: registry scan only; returned location handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 906 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetLocations#c590f9bbe1535ddd", "family_id": "script.method.server.Game.GetLocations", "kind": "method", "name": "GetLocations", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Location[] Game.GetLocations(LocationProperty property, int32 propertyValue)", "description": "SyncScope: registry scan only; returned location handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 953 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Location[]", "nullable": false }, "arguments": [ { "name": "property", "type": "LocationProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetMap#28a9744f2e2f208e", "family_id": "script.method.server.Game.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Map? Game.GetMap(hstring mapPid, int32 skipCount = 0)", "description": "SyncScope: registry lookup only; returned map handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 774 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "mapPid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "skipCount", "type": "int32", "nullable": false, "by_reference": false, "default": "0" } ] }, { "id": "script.method.server.Game.GetMap#38ce2f11f2b9397e", "family_id": "script.method.server.Game.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Map? Game.GetMap(ident mapId)", "description": "SyncScope: registry lookup only; returned map handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 766 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "mapId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetMap#b7b3d34523400d1f", "family_id": "script.method.server.Game.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Map? Game.GetMap(ProtoMap mapProto, int32 skipCount = 0)", "description": "SyncScope: registry lookup only; returned map handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 782 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "mapProto", "type": "ProtoMap", "nullable": false, "by_reference": false, "default": null }, { "name": "skipCount", "type": "int32", "nullable": false, "by_reference": false, "default": "0" } ] }, { "id": "script.method.server.Game.GetMapRegistryCount", "family_id": "script.method.server.Game.GetMapRegistryCount", "kind": "method", "name": "GetMapRegistryCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetMapRegistryCount()", "description": "SyncScope: registry count only; no entity cover required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1760 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetMaps#12174f7cc9f609d1", "family_id": "script.method.server.Game.GetMaps", "kind": "method", "name": "GetMaps", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Map[] Game.GetMaps(hstring pid)", "description": "SyncScope: registry scan only; returned map handles are not covered for later reads/mutations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 799 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Map[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetMaps#3cd2c62b701248d5", "family_id": "script.method.server.Game.GetMaps", "kind": "method", "name": "GetMaps", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Map[] Game.GetMaps()", "description": "SyncScope: registry scan only; returned map handles are not covered for later reads/mutations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 791 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Map[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetMaps#779d5c9f8b1fd466", "family_id": "script.method.server.Game.GetMaps", "kind": "method", "name": "GetMaps", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Map[] Game.GetMaps(ProtoMap? proto)", "description": "SyncScope: registry scan only; returned map handles are not covered for later reads/mutations", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 821 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Map[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoMap?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetOnlinePlayers", "family_id": "script.method.server.Game.GetOnlinePlayers", "kind": "method", "name": "GetOnlinePlayers", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Player[] Game.GetOnlinePlayers()", "description": "SyncScope: registry scan only; returned player handles are not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1018 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Player[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetPlayer", "family_id": "script.method.server.Game.GetPlayer", "kind": "method", "name": "GetPlayer", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Player? Game.GetPlayer(ident playerId)", "description": "SyncScope: registry lookup only; returned player handle is not covered for later reads/mutations", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 754 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Player?", "nullable": true }, "arguments": [ { "name": "playerId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetPlayerRegistryCount", "family_id": "script.method.server.Game.GetPlayerRegistryCount", "kind": "method", "name": "GetPlayerRegistryCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetPlayerRegistryCount()", "description": "SyncScope: registry count only; no entity cover required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1746 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetProcessMemoryUsage", "family_id": "script.method.server.Game.GetProcessMemoryUsage", "kind": "method", "name": "GetProcessMemoryUsage", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int64 Game.GetProcessMemoryUsage()", "description": "SyncScope: process metric read only; no entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1721 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int64", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetProtoCrittersForProtoMap", "family_id": "script.method.server.Game.GetProtoCrittersForProtoMap", "kind": "method", "name": "GetProtoCrittersForProtoMap", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "ProtoCritter[] Game.GetProtoCrittersForProtoMap(ProtoMap proto)", "description": "SyncScope: static proto-map read only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1450 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "ProtoCritter[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoMap", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetRegisteredPlayerIds", "family_id": "script.method.server.Game.GetRegisteredPlayerIds", "kind": "method", "name": "GetRegisteredPlayerIds", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "ident[] Game.GetRegisteredPlayerIds()", "description": "SyncScope: database registry read only; no live player cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1033 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "ident[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.GetStaticItemsForProtoMap", "family_id": "script.method.server.Game.GetStaticItemsForProtoMap", "kind": "method", "name": "GetStaticItemsForProtoMap", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "StaticItem[] Game.GetStaticItemsForProtoMap(ProtoMap proto)", "description": "SyncScope: static proto-map read only; no live entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1441 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoMap", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.GetTextCount", "family_id": "script.method.server.Game.GetTextCount", "kind": "method", "name": "GetTextCount", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.GetTextCount(TextPackKey textKey)", "description": "SyncScope: language-pack read only; no entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1475 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.IsEntityLocked", "family_id": "script.method.server.Game.IsEntityLocked", "kind": "method", "name": "IsEntityLocked", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.IsEntityLocked(Entity? entity)", "description": "SyncScope: sync-safe probe; returns whether entity is covered without emitting diagnostics", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1696 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.IsTextPresent", "family_id": "script.method.server.Game.IsTextPresent", "kind": "method", "name": "IsTextPresent", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.IsTextPresent(TextPackKey textKey)", "description": "SyncScope: language-pack read only; no entity cover is required", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1468 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "textKey", "type": "TextPackKey", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.LoadCritter", "family_id": "script.method.server.Game.LoadCritter", "kind": "method", "name": "LoadCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Critter Game.LoadCritter(ident crId, bool forPlayer)", "description": "SyncScope: database/registry load only; returned critter must be covered before cross-entity use", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 112 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "crId", "type": "ident", "nullable": false, "by_reference": false, "default": null }, { "name": "forPlayer", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.Lock", "family_id": "script.method.server.Game.Lock", "kind": "method", "name": "Lock", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.Lock()", "description": "SyncScope: locks the Game singleton bucket; do not call Game.Sync while this lock is held", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1705 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.LoginPlayerToExistentRecord", "family_id": "script.method.server.Game.LoginPlayerToExistentRecord", "kind": "method", "name": "LoginPlayerToExistentRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Player Game.LoginPlayerToExistentRecord(Player notLoggedInPlayer, ident playerId)", "description": "SyncScope: requires notLoggedInPlayer plus the prepared main-critter/map/location graph; a live reconnect\nadditionally requires the existing player. Login preserves the caller-provided cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 737 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Player", "nullable": false }, "arguments": [ { "name": "notLoggedInPlayer", "type": "Player", "nullable": false, "by_reference": false, "default": null }, { "name": "playerId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.LoginPlayerToNewRecord", "family_id": "script.method.server.Game.LoginPlayerToNewRecord", "kind": "method", "name": "LoginPlayerToNewRecord", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Player Game.LoginPlayerToNewRecord(Player notLoggedInPlayer)", "description": "SyncScope: requires notLoggedInPlayer; login mutates that player/session record", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 708 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Player", "nullable": false }, "arguments": [ { "name": "notLoggedInPlayer", "type": "Player", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.LoginPlayerToTempSession", "family_id": "script.method.server.Game.LoginPlayerToTempSession", "kind": "method", "name": "LoginPlayerToTempSession", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Player Game.LoginPlayerToTempSession(Player notLoggedInPlayer)", "description": "SyncScope: requires notLoggedInPlayer; login mutates that player/session record", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 722 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Player", "nullable": false }, "arguments": [ { "name": "notLoggedInPlayer", "type": "Player", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.MoveItem#2ed0d82a6f587a26", "family_id": "script.method.server.Game.MoveItem", "kind": "method", "name": "MoveItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item? Game.MoveItem(Item item, Item toCont, any stackId = any())", "description": "SyncScope: requires item + current item parent + destination container item", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 373 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "toCont", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "stackId", "type": "any", "nullable": false, "by_reference": false, "default": "any()" } ] }, { "id": "script.method.server.Game.MoveItem#883528ad0763e772", "family_id": "script.method.server.Game.MoveItem", "kind": "method", "name": "MoveItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item? Game.MoveItem(Item item, Map toMap, mpos toHex)", "description": "SyncScope: requires item + current item parent + destination map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 357 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "toMap", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.MoveItem#c26f82c316789816", "family_id": "script.method.server.Game.MoveItem", "kind": "method", "name": "MoveItem", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "Item? Game.MoveItem(Item item, Critter toCr)", "description": "Moves the complete item to the destination critter and returns it, or null if the move removes it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "item", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "toCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.MoveItems#5402fba4af9b29a1", "family_id": "script.method.server.Game.MoveItems", "kind": "method", "name": "MoveItems", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.MoveItems(Item[] items, Critter toCr)", "description": "SyncScope: requires destination critter + every item and its current parent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 384 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "items", "type": "Item[]", "nullable": false, "by_reference": false, "default": null }, { "name": "toCr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.MoveItems#8a09125d1c5aeacb", "family_id": "script.method.server.Game.MoveItems", "kind": "method", "name": "MoveItems", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.MoveItems(Item[] items, Item toCont, any stackId = any())", "description": "SyncScope: requires destination container item + every item and its current parent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 442 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "items", "type": "Item[]", "nullable": false, "by_reference": false, "default": null }, { "name": "toCont", "type": "Item", "nullable": false, "by_reference": false, "default": null }, { "name": "stackId", "type": "any", "nullable": false, "by_reference": false, "default": "any()" } ] }, { "id": "script.method.server.Game.MoveItems#efe80393199559d9", "family_id": "script.method.server.Game.MoveItems", "kind": "method", "name": "MoveItems", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.MoveItems(Item[] items, Map toMap, mpos toHex)", "description": "SyncScope: requires destination map + every item and its current parent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 411 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "items", "type": "Item[]", "nullable": false, "by_reference": false, "default": null }, { "name": "toMap", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.SetSynchronizedTime", "family_id": "script.method.server.Game.SetSynchronizedTime", "kind": "method", "name": "SetSynchronizedTime", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.SetSynchronizedTime(synctime time)", "description": "SyncScope: requires Game.Lock singleton; mutates global synchronized time, not a live entity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1415 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "time", "type": "synctime", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.Sync#3a28adb1be02af8c", "family_id": "script.method.server.Game.Sync", "kind": "method", "name": "Sync", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.Sync(Entity entity)", "description": "SyncScope: replaces current cover with entity plus engine auto-widen partners", "flags": [ "Async" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1567 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.Sync#8a5e8bb38f1776db", "family_id": "script.method.server.Game.Sync", "kind": "method", "name": "Sync", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.Sync(Entity entity1, Entity entity2, Entity entity3)", "description": "SyncScope: replaces current cover with all entities plus engine auto-widen partners", "flags": [ "Async", "AllowDestroyedEntityArgs" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1599 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity1", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "entity2", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "entity3", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.Sync#a0c5737d3ba111b8", "family_id": "script.method.server.Game.Sync", "kind": "method", "name": "Sync", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.Sync(Entity[] entities)", "description": "SyncScope: replaces current cover with all non-null entities plus engine auto-widen partners", "flags": [ "Async", "AllowDestroyedEntityArgs" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1621 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entities", "type": "Entity[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.Sync#b42b6f6d6b684d2a", "family_id": "script.method.server.Game.Sync", "kind": "method", "name": "Sync", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.Sync(Entity entity1, Entity entity2)", "description": "SyncScope: replaces current cover with both entities plus engine auto-widen partners", "flags": [ "Async", "AllowDestroyedEntityArgs" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1581 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entity1", "type": "Entity", "nullable": false, "by_reference": false, "default": null }, { "name": "entity2", "type": "Entity", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.SyncRelease", "family_id": "script.method.server.Game.SyncRelease", "kind": "method", "name": "SyncRelease", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.SyncRelease()", "description": "SyncScope: releases the full held set \u2014 the entity cover AND any singleton Game.Lock entries\n(SyncContext::Release drains both buckets); a Game.Lock taken before this call needs no Unlock after it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1671 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.SyncWiden", "family_id": "script.method.server.Game.SyncWiden", "kind": "method", "name": "SyncWiden", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.SyncWiden(Entity[] entities)", "description": "Widens the current synchronization cover in place to include the supplied live entities", "flags": [ "Async", "AllowDestroyedEntityArgs" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1646 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "entities", "type": "Entity[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.SyncYield", "family_id": "script.method.server.Game.SyncYield", "kind": "method", "name": "SyncYield", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.SyncYield()", "description": "Hands the current thread's whole entity cover to waiting workers and reacquires it before returning; a held Game singleton forbids this call", "flags": [ "Async" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1679 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Game.SystemCall#5f9bd54717eb40b8", "family_id": "script.method.server.Game.SystemCall", "kind": "method", "name": "SystemCall", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.SystemCall(string command, string& output)", "description": "SyncScope: external process call only; requires no entity cover but must not run under unrelated entity locks", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1534 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "command", "type": "string", "nullable": false, "by_reference": false, "default": null }, { "name": "output", "type": "string&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.server.Game.SystemCall#bc91017a887fc615", "family_id": "script.method.server.Game.SystemCall", "kind": "method", "name": "SystemCall", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "int32 Game.SystemCall(string command)", "description": "SyncScope: external process call only; requires no entity cover but must not run under unrelated entity locks", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1524 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "command", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.TrySyncEntity", "family_id": "script.method.server.Game.TrySyncEntity", "kind": "method", "name": "TrySyncEntity", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "bool Game.TrySyncEntity(ident entity_id)", "description": "Resolves an entity id, acquires synchronization cover for the live entity, and reports whether it remains usable", "flags": [ "Async" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1550 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "entity_id", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.UnloadCritter", "family_id": "script.method.server.Game.UnloadCritter", "kind": "method", "name": "UnloadCritter", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.UnloadCritter(Critter cr)", "description": "SyncScope: requires cr + current parent map; unload mutates critter simulation state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 120 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Game.Unlock", "family_id": "script.method.server.Game.Unlock", "kind": "method", "name": "Unlock", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "void Game.Unlock()", "description": "SyncScope: unlocks the Game singleton bucket; entity cover is unchanged", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerGlobalScriptMethods.cpp", "line": 1713 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Game" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Item.AddItem#bfe6263d4ff550ad", "family_id": "script.method.server.Item.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "Item Item.AddItem(ProtoItem proto, any stackId = any())", "description": "SyncScope: requires self; creates and attaches a new inner item under the container cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null }, { "name": "stackId", "type": "any", "nullable": false, "by_reference": false, "default": "any()" } ] }, { "id": "script.method.server.Item.AddItem#c6fbcb98959420b1", "family_id": "script.method.server.Item.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "Item Item.AddItem(hstring pid, any stackId = any())", "description": "SyncScope: requires self; creates and attaches a new inner item under the container cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 73 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "stackId", "type": "any", "nullable": false, "by_reference": false, "default": "any()" } ] }, { "id": "script.method.server.Item.GetCritter", "family_id": "script.method.server.Item.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "Critter? Item.GetCritter()", "description": "SyncScope: requires self; returns holder critter when item is in critter inventory, not a new cover", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 127 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Item.GetItems", "family_id": "script.method.server.Item.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "Item[] Item.GetItems(any stackId = any())", "description": "SyncScope: requires self; returns inner item handles covered by self while the cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 100 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "stackId", "type": "any", "nullable": false, "by_reference": false, "default": "any()" } ] }, { "id": "script.method.server.Item.GetMap", "family_id": "script.method.server.Item.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "Map? Item.GetMap()", "description": "SyncScope: requires self; may also read holder critter/map parent chain, returned map is not covered for later reads", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 109 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "Map?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Item.GetMapPosition", "family_id": "script.method.server.Item.GetMapPosition", "kind": "method", "name": "GetMapPosition", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "Map? Item.GetMapPosition(mpos& hex)", "description": "SyncScope: requires self; may also read holder critter/map parent chain, returned map is not covered for later reads", "flags": [ "PassOwnership" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 118 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.server.Item.RefreshVisibility", "family_id": "script.method.server.Item.RefreshVisibility", "kind": "method", "name": "RefreshVisibility", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "void Item.RefreshVisibility()", "description": "SyncScope: requires self + current map when map-owned; refreshes map visibility/blocking caches", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 136 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Item.SetupScript", "family_id": "script.method.server.Item.SetupScript", "kind": "method", "name": "SetupScript", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "void Item.SetupScript(callback(void,Item,bool) initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "callback(void,Item,bool)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Item.SetupScriptEx", "family_id": "script.method.server.Item.SetupScriptEx", "kind": "method", "name": "SetupScriptEx", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "void Item.SetupScriptEx(hstring initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerItemScriptMethods.cpp", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Item" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.AddMap#64169b002e08e159", "family_id": "script.method.server.Location.AddMap", "kind": "method", "name": "AddMap", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "Map Location.AddMap(ProtoMap mapProto)", "description": "SyncScope: requires self; creates and attaches a child map under the location cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 80 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "Map", "nullable": false }, "arguments": [ { "name": "mapProto", "type": "ProtoMap", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.AddMap#f4dae4b3925387ad", "family_id": "script.method.server.Location.AddMap", "kind": "method", "name": "AddMap", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "Map Location.AddMap(hstring mapPid)", "description": "SyncScope: requires self; creates and attaches a child map under the location cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "Map", "nullable": false }, "arguments": [ { "name": "mapPid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.GetMap#102f60993beb7009", "family_id": "script.method.server.Location.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "Map? Location.GetMap(ProtoMap mapProto)", "description": "SyncScope: requires self; returned map is covered by self while the location cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 116 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "mapProto", "type": "ProtoMap", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.GetMap#c71a7456cd1c7874", "family_id": "script.method.server.Location.GetMap", "kind": "method", "name": "GetMap", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "Map? Location.GetMap(hstring mapPid)", "description": "SyncScope: requires self; returned map is covered by self while the location cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 101 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "Map?", "nullable": true }, "arguments": [ { "name": "mapPid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.GetMapByIndex", "family_id": "script.method.server.Location.GetMapByIndex", "kind": "method", "name": "GetMapByIndex", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "Map Location.GetMapByIndex(int32 index)", "description": "SyncScope: requires self; returned map is covered by self while the location cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 132 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "Map", "nullable": false }, "arguments": [ { "name": "index", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.GetMapCount", "family_id": "script.method.server.Location.GetMapCount", "kind": "method", "name": "GetMapCount", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "int32 Location.GetMapCount()", "description": "SyncScope: requires self; counts child maps covered by the location cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 94 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Location.GetMaps", "family_id": "script.method.server.Location.GetMaps", "kind": "method", "name": "GetMaps", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "Map[] Location.GetMaps()", "description": "SyncScope: requires self; returned maps are covered by self while the location cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 141 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "Map[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Location.Regenerate", "family_id": "script.method.server.Location.Regenerate", "kind": "method", "name": "Regenerate", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "void Location.Regenerate()", "description": "SyncScope: requires self; regenerates all child maps covered by the location cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 150 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Location.SetupScript", "family_id": "script.method.server.Location.SetupScript", "kind": "method", "name": "SetupScript", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "void Location.SetupScript(callback(void,Location,bool) initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 42 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "callback(void,Location,bool)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Location.SetupScriptEx", "family_id": "script.method.server.Location.SetupScriptEx", "kind": "method", "name": "SetupScriptEx", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "void Location.SetupScriptEx(hstring initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerLocationScriptMethods.cpp", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Location" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddCritter#1e4e76b759d6c5e8", "family_id": "script.method.server.Map.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir, CritterProperty=>any props)", "description": "SyncScope: requires self; creates and attaches a new critter on the map under self cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1159 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "CritterProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddCritter#42310745cd07d9a7", "family_id": "script.method.server.Map.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir, CritterProperty=>int32 props)", "description": "SyncScope: requires self; creates and attaches a new critter on the map under self cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "CritterProperty=>int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddCritter#469abe60680fae4e", "family_id": "script.method.server.Map.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir)", "description": "SyncScope: requires self; creates and attaches a new critter on the map under self cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1054 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddCritter#4bf2d1bf57efc238", "family_id": "script.method.server.Map.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir)", "description": "SyncScope: requires self; creates and attaches a new critter on the map under self cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1069 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddCritter#8b44cc2e5aeaa303", "family_id": "script.method.server.Map.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir, CritterProperty=>int32 props)", "description": "SyncScope: requires self; creates and attaches a new critter on the map under self cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1084 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "CritterProperty=>int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddCritter#ab45ffd3c807403c", "family_id": "script.method.server.Map.AddCritter", "kind": "method", "name": "AddCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir, CritterProperty=>any props)", "description": "SyncScope: requires self; creates and attaches a new critter on the map under self cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1132 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter", "nullable": false }, "arguments": [ { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "CritterProperty=>any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddItem#3b5f3b7a0ad0569d", "family_id": "script.method.server.Map.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item Map.AddItem(mpos hex, hstring protoId, ItemProperty=>int32 props)", "description": "SyncScope: requires self; creates and attaches a new map item under the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 106 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "ItemProperty=>int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddItem#4c836c86ebb331f9", "family_id": "script.method.server.Map.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item Map.AddItem(mpos hex, ProtoItem proto)", "description": "SyncScope: requires self; creates and attaches a new map item under the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 91 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddItem#93da72a5ec69c371", "family_id": "script.method.server.Map.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item Map.AddItem(mpos hex, hstring protoId)", "description": "SyncScope: requires self; creates and attaches a new map item under the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "protoId", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.AddItem#dd69e509a0195144", "family_id": "script.method.server.Map.AddItem", "kind": "method", "name": "AddItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item Map.AddItem(mpos hex, ProtoItem proto, ItemProperty=>int32 props)", "description": "SyncScope: requires self; creates and attaches a new map item under the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 133 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null }, { "name": "props", "type": "ItemProperty=>int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.BlockHex", "family_id": "script.method.server.Map.BlockHex", "kind": "method", "name": "BlockHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.BlockHex(mpos hex, bool full)", "description": "SyncScope: requires self; mutates manual blocking for one map hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "full", "type": "bool", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.CheckPlaceForItem#7df5c41f5f61890c", "family_id": "script.method.server.Map.CheckPlaceForItem", "kind": "method", "name": "CheckPlaceForItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.CheckPlaceForItem(mpos hex, hstring pid)", "description": "SyncScope: requires self; reads map placement rules and item prototype data", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1234 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.CheckPlaceForItem#f95a6f1b9e4a1b61", "family_id": "script.method.server.Map.CheckPlaceForItem", "kind": "method", "name": "CheckPlaceForItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.CheckPlaceForItem(mpos hex, ProtoItem proto)", "description": "SyncScope: requires self; reads map placement rules and item prototype data", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1247 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.FindPathToAny#049a83ae871129e5", "family_id": "script.method.server.Map.FindPathToAny", "kind": "method", "name": "FindPathToAny", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.FindPathToAny(Critter cr, mpos[] targetHexes, int32& pathLength, mpos& targetHex, callback(bool,Critter,Item) gagCallback)", "description": "SyncScope: requires self + cr; pathing reads map blockers and cr state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1000 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "targetHexes", "type": "mpos[]", "nullable": false, "by_reference": false, "default": null }, { "name": "pathLength", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "targetHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "gagCallback", "type": "callback(bool,Critter,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.FindPathToAny#d989184e940c3179", "family_id": "script.method.server.Map.FindPathToAny", "kind": "method", "name": "FindPathToAny", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.FindPathToAny(mpos fromHex, mpos[] targetHexes, int32& pathLength, mpos& targetHex, callback(bool,Item) gagCallback)", "description": "SyncScope: requires self; pathing reads map blockers and optional gag callback items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 967 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "targetHexes", "type": "mpos[]", "nullable": false, "by_reference": false, "default": null }, { "name": "pathLength", "type": "int32&", "nullable": false, "by_reference": true, "default": null }, { "name": "targetHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "gagCallback", "type": "callback(bool,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.FindReachableHexes", "family_id": "script.method.server.Map.FindReachableHexes", "kind": "method", "name": "FindReachableHexes", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "mpos[] Map.FindReachableHexes(mpos fromHex, mpos[] targetHexes, callback(bool,Item) gagCallback)", "description": "Answers which target hexes are reachable from the start within the configured path-length limit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1032 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "mpos[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "targetHexes", "type": "mpos[]", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallback", "type": "callback(bool,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritter#beaf90ce99481bb9", "family_id": "script.method.server.Map.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter? Map.GetCritter(ident crid)", "description": "SyncScope: requires self; returned critter is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 657 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "crid", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritter#cc2efc7ac9caf8b7", "family_id": "script.method.server.Map.GetCritter", "kind": "method", "name": "GetCritter", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter? Map.GetCritter(CritterProperty property, int32 propertyValue, CritterFindType findType)", "description": "SyncScope: requires self; returned critter is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 682 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "property", "type": "CritterProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritterOnHex", "family_id": "script.method.server.Map.GetCritterOnHex", "kind": "method", "name": "GetCritterOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter? Map.GetCritterOnHex(mpos hex)", "description": "SyncScope: requires self; returned critter is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 665 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritters#81d4328569cd9426", "family_id": "script.method.server.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(CritterFindType findType)", "description": "SyncScope: requires self; returned critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 753 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritters#addc705539406d44", "family_id": "script.method.server.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(hstring pid, CritterFindType findType)", "description": "SyncScope: requires self; returned critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 772 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritters#d9bfa22ace1ec9d4", "family_id": "script.method.server.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(CritterProperty property, int32 propertyValue, CritterFindType findType)", "description": "SyncScope: requires self; returned critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 808 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "property", "type": "CritterProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCritters#e79de6b56cb9f3b3", "family_id": "script.method.server.Map.GetCritters", "kind": "method", "name": "GetCritters", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCritters(ProtoCritter proto, CritterFindType findType)", "description": "SyncScope: requires self; returned critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 790 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoCritter", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersInPath#8b046729d6d79d34", "family_id": "script.method.server.Map.GetCrittersInPath", "kind": "method", "name": "GetCrittersInPath", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType)", "description": "SyncScope: requires self; returned path critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 827 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersInPath#a2a00a1dfe4f3d7e", "family_id": "script.method.server.Map.GetCrittersInPath", "kind": "method", "name": "GetCrittersInPath", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType, mpos& preBlockHex, mpos& blockHex)", "description": "SyncScope: requires self; returned path critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 836 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null }, { "name": "preBlockHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "blockHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersInRadius", "family_id": "script.method.server.Map.GetCrittersInRadius", "kind": "method", "name": "GetCrittersInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersInRadius(mpos hex, int32 radius, CritterFindType findType)", "description": "SyncScope: requires self; returned critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 716 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersOnHex", "family_id": "script.method.server.Map.GetCrittersOnHex", "kind": "method", "name": "GetCrittersOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersOnHex(mpos hex, CritterFindType findType)", "description": "SyncScope: requires self; returned critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 697 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersWhoSeeHex#331d6938741ba331", "family_id": "script.method.server.Map.GetCrittersWhoSeeHex", "kind": "method", "name": "GetCrittersWhoSeeHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersWhoSeeHex(mpos hex, CritterFindType findType)", "description": "SyncScope: requires self; returned observer critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 847 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersWhoSeeHex#6295b4bbbc256992", "family_id": "script.method.server.Map.GetCrittersWhoSeeHex", "kind": "method", "name": "GetCrittersWhoSeeHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersWhoSeeHex(mpos hex, int32 radius, CritterFindType findType)", "description": "SyncScope: requires self; returned observer critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 862 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetCrittersWhoSeePath", "family_id": "script.method.server.Map.GetCrittersWhoSeePath", "kind": "method", "name": "GetCrittersWhoSeePath", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Critter[] Map.GetCrittersWhoSeePath(mpos fromHex, mpos toHex, CritterFindType findType)", "description": "SyncScope: requires self; returned observer critters are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 877 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Critter[]", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "findType", "type": "CritterFindType", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetHexInPath", "family_id": "script.method.server.Map.GetHexInPath", "kind": "method", "name": "GetHexInPath", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.GetHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist)", "description": "SyncScope: requires self; path trace reads static/map blockers only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 894 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItem", "family_id": "script.method.server.Map.GetItem", "kind": "method", "name": "GetItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItem(ident itemId)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 154 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "itemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemInRadius#2c45a3b349bce706", "family_id": "script.method.server.Map.GetItemInRadius", "kind": "method", "name": "GetItemInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItemInRadius(mpos hex, int32 radius, hstring pid)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemInRadius#43a0e23b140b9e9a", "family_id": "script.method.server.Map.GetItemInRadius", "kind": "method", "name": "GetItemInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItemInRadius(mpos hex, int32 radius, ProtoItem proto)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 232 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemInRadius#fe27ffaff6bf5b08", "family_id": "script.method.server.Map.GetItemInRadius", "kind": "method", "name": "GetItemInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItemInRadius(mpos hex, int32 radius, ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 254 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemOnHex#6ece718d14bda9df", "family_id": "script.method.server.Map.GetItemOnHex", "kind": "method", "name": "GetItemOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItemOnHex(mpos hex, ProtoItem proto)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemOnHex#bde72d72df216ffd", "family_id": "script.method.server.Map.GetItemOnHex", "kind": "method", "name": "GetItemOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItemOnHex(mpos hex, hstring pid)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 166 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemOnHex#fd531ae0c65b5f38", "family_id": "script.method.server.Map.GetItemOnHex", "kind": "method", "name": "GetItemOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item? Map.GetItemOnHex(mpos hex, ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned item is covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 190 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItems#83c145745774df22", "family_id": "script.method.server.Map.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItems(ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 397 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItems#986ac88634199639", "family_id": "script.method.server.Map.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItems(hstring pid)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 285 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItems#b851260ade7c353c", "family_id": "script.method.server.Map.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItems()", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 277 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Map.GetItems#ef66ddcc26718dfe", "family_id": "script.method.server.Map.GetItems", "kind": "method", "name": "GetItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItems(ProtoItem proto)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 303 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemsInRadius#1b2344cf4e6a8ad6", "family_id": "script.method.server.Map.GetItemsInRadius", "kind": "method", "name": "GetItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItemsInRadius(mpos hex, int32 radius, ProtoItem proto)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 372 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemsInRadius#2c10a43df574d95a", "family_id": "script.method.server.Map.GetItemsInRadius", "kind": "method", "name": "GetItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItemsInRadius(mpos hex, int32 radius)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 333 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemsInRadius#71e75da3d8138709", "family_id": "script.method.server.Map.GetItemsInRadius", "kind": "method", "name": "GetItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItemsInRadius(mpos hex, int32 radius, hstring pid)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemsInRadius#e5b26ab1ca51093e", "family_id": "script.method.server.Map.GetItemsInRadius", "kind": "method", "name": "GetItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItemsInRadius(mpos hex, int32 radius, ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 440 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemsOnHex#2becb51a4793de35", "family_id": "script.method.server.Map.GetItemsOnHex", "kind": "method", "name": "GetItemsOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItemsOnHex(mpos hex)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 321 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetItemsOnHex#5db3ed64fff8551d", "family_id": "script.method.server.Map.GetItemsOnHex", "kind": "method", "name": "GetItemsOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Item[] Map.GetItemsOnHex(mpos hex, ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned items are covered by self while the map cover remains", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 416 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Item[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetLocation", "family_id": "script.method.server.Map.GetLocation", "kind": "method", "name": "GetLocation", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Location Map.GetLocation()", "description": "SyncScope: requires self; returns parent location, but does not cover it for later reads", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Location", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Map.GetPathLength#aaa618b299e12baf", "family_id": "script.method.server.Map.GetPathLength", "kind": "method", "name": "GetPathLength", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "int32 Map.GetPathLength(Critter cr, mpos toHex, int32 cut, callback(bool,Critter,Item) gagCallabck)", "description": "SyncScope: requires self + cr; pathing reads map blockers and cr state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 942 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallabck", "type": "callback(bool,Critter,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetPathLength#b14b16361e6bc348", "family_id": "script.method.server.Map.GetPathLength", "kind": "method", "name": "GetPathLength", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "int32 Map.GetPathLength(mpos fromHex, mpos toHex, int32 cut, callback(bool,Item) gagCallabck)", "description": "SyncScope: requires self; pathing reads map blockers and optional gag callback items", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 916 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "cut", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "gagCallabck", "type": "callback(bool,Item)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetPlayerCritterCount", "family_id": "script.method.server.Map.GetPlayerCritterCount", "kind": "method", "name": "GetPlayerCritterCount", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "int32 Map.GetPlayerCritterCount()", "description": "SyncScope: requires self; reads the map's player-critter membership without materializing it", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 745 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Map.GetSpectatorPlayers", "family_id": "script.method.server.Map.GetSpectatorPlayers", "kind": "method", "name": "GetSpectatorPlayers", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "Player[] Map.GetSpectatorPlayers()", "description": "SyncScope: requires self; returns the map's current spectator Players. A spectator is an independent Player\nroot that neither the map nor its location cover includes, so a caller that destroys this map or its location\nmust cover every returned Player first and re-read this list to prove the membership did not change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 762 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "Player[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Map.GetStaticItem", "family_id": "script.method.server.Map.GetStaticItem", "kind": "method", "name": "GetStaticItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem? Map.GetStaticItem(ident id)", "description": "SyncScope: requires self; returned static item is map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 491 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem?", "nullable": true }, "arguments": [ { "name": "id", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItemOnHex#2ff535bb81b4c46e", "family_id": "script.method.server.Map.GetStaticItemOnHex", "kind": "method", "name": "GetStaticItemOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem? Map.GetStaticItemOnHex(mpos hex, ProtoItem proto)", "description": "SyncScope: requires self; returned static item is map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 511 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItemOnHex#8f12443105465e0c", "family_id": "script.method.server.Map.GetStaticItemOnHex", "kind": "method", "name": "GetStaticItemOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem? Map.GetStaticItemOnHex(mpos hex, hstring pid)", "description": "SyncScope: requires self; returned static item is map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 499 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem?", "nullable": true }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItems#05085759f098a103", "family_id": "script.method.server.Map.GetStaticItems", "kind": "method", "name": "GetStaticItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItems(ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 630 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItems#3d6e192e1648eca6", "family_id": "script.method.server.Map.GetStaticItems", "kind": "method", "name": "GetStaticItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItems(ProtoItem proto)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 622 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItems#ba60a4d88539cc01", "family_id": "script.method.server.Map.GetStaticItems", "kind": "method", "name": "GetStaticItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItems(hstring pid)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 614 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItems#e35ab59d1c820445", "family_id": "script.method.server.Map.GetStaticItems", "kind": "method", "name": "GetStaticItems", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItems()", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 649 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Map.GetStaticItemsInRadius#9fcecfdd954f2f40", "family_id": "script.method.server.Map.GetStaticItemsInRadius", "kind": "method", "name": "GetStaticItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, ProtoItem proto)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 550 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "proto", "type": "ProtoItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItemsInRadius#b716f83c2f22af43", "family_id": "script.method.server.Map.GetStaticItemsInRadius", "kind": "method", "name": "GetStaticItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, hstring pid)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 535 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "pid", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItemsInRadius#f3c9729ff42f4ae8", "family_id": "script.method.server.Map.GetStaticItemsInRadius", "kind": "method", "name": "GetStaticItemsInRadius", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 588 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null }, { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItemsOnHex#4a9a56826105ef2b", "family_id": "script.method.server.Map.GetStaticItemsOnHex", "kind": "method", "name": "GetStaticItemsOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItemsOnHex(mpos hex)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 523 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetStaticItemsOnHex#5d15ee5943a3edd0", "family_id": "script.method.server.Map.GetStaticItemsOnHex", "kind": "method", "name": "GetStaticItemsOnHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "StaticItem[] Map.GetStaticItemsOnHex(mpos hex, ItemProperty property, int32 propertyValue)", "description": "SyncScope: requires self; returned static items are map-static data covered by the map cover", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 565 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "StaticItem[]", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "property", "type": "ItemProperty", "nullable": false, "by_reference": false, "default": null }, { "name": "propertyValue", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.GetWallHexInPath", "family_id": "script.method.server.Map.GetWallHexInPath", "kind": "method", "name": "GetWallHexInPath", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.GetWallHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist)", "description": "SyncScope: requires self; path trace reads wall blockers only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 902 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "fromHex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "toHex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "angle", "type": "float32", "nullable": false, "by_reference": false, "default": null }, { "name": "dist", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.IsHexMovable", "family_id": "script.method.server.Map.IsHexMovable", "kind": "method", "name": "IsHexMovable", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.IsHexMovable(mpos hex)", "description": "SyncScope: requires self; reads map blocking state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1187 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.IsHexShootable", "family_id": "script.method.server.Map.IsHexShootable", "kind": "method", "name": "IsHexShootable", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.IsHexShootable(mpos hex)", "description": "SyncScope: requires self; reads map shoot-blocking state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.IsHexValid", "family_id": "script.method.server.Map.IsHexValid", "kind": "method", "name": "IsHexValid", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.IsHexValid(mpos hex)", "description": "SyncScope: requires self; reads map size only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1180 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.IsHexesMovable", "family_id": "script.method.server.Map.IsHexesMovable", "kind": "method", "name": "IsHexesMovable", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.IsHexesMovable(mpos hex, int32 radius)", "description": "SyncScope: requires self; reads map blocking state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1198 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "radius", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.IsOutsideArea", "family_id": "script.method.server.Map.IsOutsideArea", "kind": "method", "name": "IsOutsideArea", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.IsOutsideArea(mpos hex)", "description": "SyncScope: requires self; reads map outdoor/indoor area state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1223 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.MoveHexByDir#62392271e1b42030", "family_id": "script.method.server.Map.MoveHexByDir", "kind": "method", "name": "MoveHexByDir", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.MoveHexByDir(mpos& hex, mdir dir)", "description": "SyncScope: requires self; uses map size for a pure coordinate step", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1289 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.MoveHexByDir#b39016610645244b", "family_id": "script.method.server.Map.MoveHexByDir", "kind": "method", "name": "MoveHexByDir", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "int32 Map.MoveHexByDir(mpos& hex, mdir dir, int32 steps)", "description": "SyncScope: requires self; uses map size for pure coordinate steps", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1301 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "int32", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos&", "nullable": false, "by_reference": true, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null }, { "name": "steps", "type": "int32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.Regenerate", "family_id": "script.method.server.Map.Regenerate", "kind": "method", "name": "Regenerate", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.Regenerate()", "description": "SyncScope: requires self; regenerates map content and placement caches", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Map.RemoveStaticItem#7b30d7a907ece580", "family_id": "script.method.server.Map.RemoveStaticItem", "kind": "method", "name": "RemoveStaticItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.RemoveStaticItem(ident staticItemId)", "description": "Removal is one-way for the life of the map instance: clients already on the map are only ever told to drop\na static item, so taking an id back out of the list is rejected rather than silently ignored", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 469 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "staticItemId", "type": "ident", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.RemoveStaticItem#a89f4bb2ef62c35a", "family_id": "script.method.server.Map.RemoveStaticItem", "kind": "method", "name": "RemoveStaticItem", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "bool Map.RemoveStaticItem(StaticItem staticItem)", "description": "SyncScope: requires self; mutates the map's own removal list, which the property sync fans out to clients", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 480 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "bool", "nullable": false }, "arguments": [ { "name": "staticItem", "type": "StaticItem", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.SetupScript", "family_id": "script.method.server.Map.SetupScript", "kind": "method", "name": "SetupScript", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.SetupScript(callback(void,Map,bool) initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 43 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "callback(void,Map,bool)", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.SetupScriptEx", "family_id": "script.method.server.Map.SetupScriptEx", "kind": "method", "name": "SetupScriptEx", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.SetupScriptEx(hstring initFunc)", "description": "SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "initFunc", "type": "hstring", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.UnblockHex", "family_id": "script.method.server.Map.UnblockHex", "kind": "method", "name": "UnblockHex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.UnblockHex(mpos hex)", "description": "SyncScope: requires self; mutates manual blocking for one map hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1268 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Map.VerifyTrigger", "family_id": "script.method.server.Map.VerifyTrigger", "kind": "method", "name": "VerifyTrigger", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "void Map.VerifyTrigger(Critter cr, mpos hex, mdir dir)", "description": "SyncScope: requires self + cr; trigger verification may inspect/mutate critter-facing map state", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerMapScriptMethods.cpp", "line": 1319 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Map" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "dir", "type": "mdir", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Player.Disconnect", "family_id": "script.method.server.Player.Disconnect", "kind": "method", "name": "Disconnect", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.Disconnect()", "description": "SyncScope: requires self; closes this player's connection", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 55 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.GetControlledCritter", "family_id": "script.method.server.Player.GetControlledCritter", "kind": "method", "name": "GetControlledCritter", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "Critter? Player.GetControlledCritter()", "description": "SyncScope: requires self; returns the controlled critter handle, auto-widened when self is Sync'd", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 102 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "Critter?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Player.GetDisconnectReason", "family_id": "script.method.server.Player.GetDisconnectReason", "kind": "method", "name": "GetDisconnectReason", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "DisconnectReason Player.GetDisconnectReason()", "description": "SyncScope: requires self; reads connection state only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "DisconnectReason", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.GetHost", "family_id": "script.method.server.Player.GetHost", "kind": "method", "name": "GetHost", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "string Player.GetHost()", "description": "SyncScope: requires self; reads connection endpoint only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 41 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "string", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.GetPort", "family_id": "script.method.server.Player.GetPort", "kind": "method", "name": "GetPort", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "int32 Player.GetPort()", "description": "SyncScope: requires self; reads connection endpoint only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 48 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "int32", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.GetViewMapTarget", "family_id": "script.method.server.Player.GetViewMapTarget", "kind": "method", "name": "GetViewMapTarget", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "Map? Player.GetViewMapTarget()", "description": "SyncScope: requires self; returns the map self currently spectates, but does not cover it for later reads.\nThe view target is an independent Map root that self's cover does not include, so a caller that reads or\nmutates it covers the returned map first and re-reads this handle to prove the view did not change", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "Map?", "nullable": true }, "arguments": [] }, { "id": "script.method.server.Player.HardDisconnect", "family_id": "script.method.server.Player.HardDisconnect", "kind": "method", "name": "HardDisconnect", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.HardDisconnect()", "description": "SyncScope: requires self; forcibly closes this player's connection", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.RefreshCritterMoving", "family_id": "script.method.server.Player.RefreshCritterMoving", "kind": "method", "name": "RefreshCritterMoving", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.RefreshCritterMoving(Critter cr)", "description": "SyncScope: requires self + cr; sends movement state for a critter visible on player's current map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 110 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Player.ResetViewMap", "family_id": "script.method.server.Player.ResetViewMap", "kind": "method", "name": "ResetViewMap", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.ResetViewMap()", "description": "SyncScope: requires self; clears view-map state, no entity reparent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 173 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.SetName", "family_id": "script.method.server.Player.SetName", "kind": "method", "name": "SetName", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.SetName(string name)", "description": "SyncScope: requires self; mutates player name only", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "name", "type": "string", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Player.SwitchCritter", "family_id": "script.method.server.Player.SwitchCritter", "kind": "method", "name": "SwitchCritter", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.SwitchCritter(Critter? cr)", "description": "SyncScope: requires self + cr when cr is non-null; before linkage callers must explicitly cover both", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "cr", "type": "Critter?", "nullable": true, "by_reference": false, "default": null } ] }, { "id": "script.method.server.Player.UnloadMap", "family_id": "script.method.server.Player.UnloadMap", "kind": "method", "name": "UnloadMap", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.UnloadMap()", "description": "SyncScope: requires self; clears view-map state and sends unload, no entity reparent", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 180 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.method.server.Player.ViewMap", "family_id": "script.method.server.Player.ViewMap", "kind": "method", "name": "ViewMap", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "void Player.ViewMap(Map map, mpos hex)", "description": "SyncScope: requires self + map + map location; sends load-map data and opens a map view for self", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Scripting/ServerPlayerScriptMethods.cpp", "line": 145 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "receivers": [ "Player" ], "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "map", "type": "Map", "nullable": false, "by_reference": false, "default": null }, { "name": "hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.property.Critter.AttachMaster", "family_id": "script.property.Critter.AttachMaster", "kind": "property", "name": "AttachMaster", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "ident Critter.AttachMaster", "description": "Identifier of the attachment master; zero when the critter is not attached", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 363 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.Condition", "family_id": "script.property.Critter.Condition", "kind": "property", "name": "Condition", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "CritterCondition Critter.Condition", "description": "Current life-state condition used by animation, filtering, and gameplay queries", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 377 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "CritterCondition", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.ControlledByPlayer", "family_id": "script.property.Critter.ControlledByPlayer", "kind": "property", "name": "ControlledByPlayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.ControlledByPlayer", "description": "Classifies the critter as player-controllable independently of its current online state", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 351 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.CustomHolderEntry", "family_id": "script.property.Critter.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "hstring Critter.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.CustomHolderId", "family_id": "script.property.Critter.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "ident Critter.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.DeadDrawNoFlatten", "family_id": "script.property.Critter.DeadDrawNoFlatten", "kind": "property", "name": "DeadDrawNoFlatten", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.DeadDrawNoFlatten", "description": "Keeps a dead critter in the normal critter draw order instead of the flattened dead-critter order", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 388 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.Dir", "family_id": "script.property.Critter.Dir", "kind": "property", "name": "Dir", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "mdir Critter.Dir", "description": "Current facing direction on the map grid", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 322 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "mdir", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.Elevation", "family_id": "script.property.Critter.Elevation", "kind": "property", "name": "Elevation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "int16 Critter.Elevation", "description": "Vertical rendering elevation of the critter", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 319 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int16", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.ExplicitlyPersistent", "family_id": "script.property.Critter.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.GlobalMapTripId", "family_id": "script.property.Critter.GlobalMapTripId", "kind": "property", "name": "GlobalMapTripId", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "uint32 Critter.GlobalMapTripId", "description": "Server-assigned identifier shared by members of the same current global-map trip", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 310 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "uint32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.Hex", "family_id": "script.property.Critter.Hex", "kind": "property", "name": "Hex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "mpos Critter.Hex", "description": "Origin hex currently occupied by the critter on its map", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 313 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "mpos", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.HexOffset", "family_id": "script.property.Critter.HexOffset", "kind": "property", "name": "HexOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "ipos16 Critter.HexOffset", "description": "Sub-hex map-space offset used by movement interpolation and rendering", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 316 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ipos16", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.HideSprite", "family_id": "script.property.Critter.HideSprite", "kind": "property", "name": "HideSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.HideSprite", "description": "Hides the current client map sprite without removing the critter's map presence", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 366 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.InitScript", "family_id": "script.property.Critter.InitScript", "kind": "property", "name": "InitScript", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "hstring Critter.InitScript", "description": "Server initialization function called after the critter-init event for a newly created or restored critter", "flags": [ "Mutable", "Persistent", "ScriptFuncType", "=", "CritterInit", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 304 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.IsAttached", "family_id": "script.property.Critter.IsAttached", "kind": "property", "name": "IsAttached", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsAttached", "description": "Reports that this critter currently follows another critter as an attachment", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 360 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.IsChosen", "family_id": "script.property.Critter.IsChosen", "kind": "property", "name": "IsChosen", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsChosen", "description": "Reports that this critter is the locally chosen critter on the current client", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 354 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.IsPlayerOffline", "family_id": "script.property.Critter.IsPlayerOffline", "kind": "property", "name": "IsPlayerOffline", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.IsPlayerOffline", "description": "Client-side connection state reported for a player-controlled critter", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 357 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.ItemIds", "family_id": "script.property.Critter.ItemIds", "kind": "property", "name": "ItemIds", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "ident[] Critter.ItemIds", "description": "Persistent identifiers of the items directly held in the critter's inventory", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.LightColor", "family_id": "script.property.Critter.LightColor", "kind": "property", "name": "LightColor", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "ucolor Critter.LightColor", "description": "RGBA color emitted by the critter's client-side light source", "flags": [ "Mutable", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 403 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "ucolor", "nullable": false, "mutability": "mutable", "persistent": false }, { "id": "script.property.Critter.LightDistance", "family_id": "script.property.Critter.LightDistance", "kind": "property", "name": "LightDistance", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "int16 Critter.LightDistance", "description": "Radius in hexes reached by the critter's client-side light source", "flags": [ "Mutable", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 397 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "int16", "nullable": false, "mutability": "mutable", "persistent": false }, { "id": "script.property.Critter.LightFlags", "family_id": "script.property.Critter.LightFlags", "kind": "property", "name": "LightFlags", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "uint16 Critter.LightFlags", "description": "Bit mask controlling global, inverse, and direction-blocking behavior of the light source", "flags": [ "Mutable", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 400 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "uint16", "nullable": false, "mutability": "mutable", "persistent": false }, { "id": "script.property.Critter.LightIntensity", "family_id": "script.property.Critter.LightIntensity", "kind": "property", "name": "LightIntensity", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "int8 Critter.LightIntensity", "description": "Signed percentage intensity of the critter's client-side light source", "flags": [ "Mutable", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 394 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "int8", "nullable": false, "mutability": "mutable", "persistent": false }, { "id": "script.property.Critter.LightSource", "family_id": "script.property.Critter.LightSource", "kind": "property", "name": "LightSource", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "bool Critter.LightSource", "description": "Enables a client-side map light source centered on this critter", "flags": [ "Mutable", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 391 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": false }, { "id": "script.property.Critter.LookDistance", "family_id": "script.property.Critter.LookDistance", "kind": "property", "name": "LookDistance", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "int32 Critter.LookDistance", "description": "Maximum map-view distance in hexes used by server visibility processing", "flags": [ "Mutable", "OwnerSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 383 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.MapId", "family_id": "script.property.Critter.MapId", "kind": "property", "name": "MapId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "ident Critter.MapId", "description": "Identifier of the map currently containing the critter; zero while it is on the global map", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 307 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.ModelLayers", "family_id": "script.property.Critter.ModelLayers", "kind": "property", "name": "ModelLayers", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "int32[] Critter.ModelLayers", "description": "Fixed-size client values passed to the 3D model layer and animation resolver", "flags": [ "Mutable", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 346 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "int32[]", "nullable": false, "mutability": "mutable", "persistent": false }, { "id": "script.property.Critter.ModelName", "family_id": "script.property.Critter.ModelName", "kind": "property", "name": "ModelName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "hstring Critter.ModelName", "description": "Sprite or 3D model resource used to present the critter", "flags": [ "Mutable", "PublicSync", "Persistent", "Resource", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 328 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.MovingSpeed", "family_id": "script.property.Critter.MovingSpeed", "kind": "property", "name": "MovingSpeed", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "int32 Critter.MovingSpeed", "description": "Current server movement speed published for active movement", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 369 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "int32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Critter.Multihex", "family_id": "script.property.Critter.Multihex", "kind": "property", "name": "Multihex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "int32 Critter.Multihex", "description": "Radius in hexes occupied by the critter in movement, pathfinding, and distance checks", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 331 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Critter.NameOffset", "family_id": "script.property.Critter.NameOffset", "kind": "property", "name": "NameOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "int16 Critter.NameOffset", "description": "Vertical pixel adjustment applied to the critter name label", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 380 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int16", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.ScaleFactor", "family_id": "script.property.Critter.ScaleFactor", "kind": "property", "name": "ScaleFactor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Critter", "signature": "int32 Critter.ScaleFactor", "description": "3D model scale in thousandths; zero selects the default scale of 1000", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 334 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.ShowCritterDist1", "family_id": "script.property.Critter.ShowCritterDist1", "kind": "property", "name": "ShowCritterDist1", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "int32 Critter.ShowCritterDist1", "description": "Optional first visibility-event distance in hexes; zero disables this distance group", "flags": [ "Mutable", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.ShowCritterDist2", "family_id": "script.property.Critter.ShowCritterDist2", "kind": "property", "name": "ShowCritterDist2", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "int32 Critter.ShowCritterDist2", "description": "Optional second visibility-event distance in hexes; zero disables this distance group", "flags": [ "Mutable", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 340 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.ShowCritterDist3", "family_id": "script.property.Critter.ShowCritterDist3", "kind": "property", "name": "ShowCritterDist3", "runtime_sides": [ "server" ], "receiver": "Critter", "signature": "int32 Critter.ShowCritterDist3", "description": "Optional third visibility-event distance in hexes; zero disables this distance group", "flags": [ "Mutable", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 343 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Critter.VisibilityMode", "family_id": "script.property.Critter.VisibilityMode", "kind": "property", "name": "VisibilityMode", "runtime_sides": [ "client", "mapper" ], "receiver": "Critter", "signature": "CritterVisibilityMode Critter.VisibilityMode", "description": "Visibility detail mode assigned to this critter from the current client's viewpoint", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 372 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "CritterVisibilityMode", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Game.CustomHolderEntry", "family_id": "script.property.Game.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "hstring Game.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Game.CustomHolderId", "family_id": "script.property.Game.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "ident Game.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Game.ExplicitlyPersistent", "family_id": "script.property.Game.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "bool Game.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Game.FrameDeltaTime", "family_id": "script.property.Game.FrameDeltaTime", "kind": "property", "name": "FrameDeltaTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "timespan Game.FrameDeltaTime", "description": "Elapsed monotonic time between the current and previous frame advances", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 66 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "timespan", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Game.FrameTime", "family_id": "script.property.Game.FrameTime", "kind": "property", "name": "FrameTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "nanotime Game.FrameTime", "description": "Monotonic engine time captured for the current frame", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 63 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "nanotime", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Game.FramesPerSecond", "family_id": "script.property.Game.FramesPerSecond", "kind": "property", "name": "FramesPerSecond", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.FramesPerSecond", "description": "Frame count measured during the most recently completed one-second sampling interval", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 69 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Game.GlobalDayTime", "family_id": "script.property.Game.GlobalDayTime", "kind": "property", "name": "GlobalDayTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "int32 Game.GlobalDayTime", "description": "Current position of the global day-light cycle, measured in minutes and controlled by game scripts", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 75 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Game.HistoryRecordsId", "family_id": "script.property.Game.HistoryRecordsId", "kind": "property", "name": "HistoryRecordsId", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "ident Game.HistoryRecordsId", "description": "Persistent high-water mark used to allocate server history-record identifiers", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Game.LastEntityId", "family_id": "script.property.Game.LastEntityId", "kind": "property", "name": "LastEntityId", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "ident Game.LastEntityId", "description": "Persistent high-water mark used to allocate durable entity identifiers", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Game.LastGlobalMapTripId", "family_id": "script.property.Game.LastGlobalMapTripId", "kind": "property", "name": "LastGlobalMapTripId", "runtime_sides": [ "server" ], "receiver": "Game", "signature": "uint32 Game.LastGlobalMapTripId", "description": "Last server-assigned identifier for a global-map trip", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 72 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "uint32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Game.SynchronizedTime", "family_id": "script.property.Game.SynchronizedTime", "kind": "property", "name": "SynchronizedTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Game", "signature": "synctime Game.SynchronizedTime", "description": "Current synchronized game time shared by the server and clients and persisted by the server", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 54 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "synctime", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.ImGui.CustomHolderEntry", "family_id": "script.property.ImGui.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "hstring ImGui.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.ImGui.CustomHolderId", "family_id": "script.property.ImGui.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "ident ImGui.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.ImGui.ExplicitlyPersistent", "family_id": "script.property.ImGui.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ImGui", "signature": "bool ImGui.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.AlwaysHideSprite", "family_id": "script.property.Item.AlwaysHideSprite", "kind": "property", "name": "AlwaysHideSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.AlwaysHideSprite", "description": "Prevents the item sprite from being drawn at runtime and hides it by default in Mapper", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.Colorize", "family_id": "script.property.Item.Colorize", "kind": "property", "name": "Colorize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.Colorize", "description": "Enables ColorizeColor tinting for the item's map sprite", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 287 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.ColorizeColor", "family_id": "script.property.Item.ColorizeColor", "kind": "property", "name": "ColorizeColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ucolor Item.ColorizeColor", "description": "RGBA tint applied when Colorize is enabled; alpha also supplies the default sprite opacity", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 232 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ucolor", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.ContainerId", "family_id": "script.property.Item.ContainerId", "kind": "property", "name": "ContainerId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ident Item.ContainerId", "description": "Identifier of the parent item while Ownership is ItemContainer; zero otherwise", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 147 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.ContainerStack", "family_id": "script.property.Item.ContainerStack", "kind": "property", "name": "ContainerStack", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "any Item.ContainerStack", "description": "Project-defined grouping key used to select and merge items inside a container", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 150 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "any", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.Corner", "family_id": "script.property.Item.Corner", "kind": "property", "name": "Corner", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "CornerType Item.Corner", "description": "Wall-corner orientation used by map lighting and transparent-foreground behavior", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 164 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "CornerType", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.CritterId", "family_id": "script.property.Item.CritterId", "kind": "property", "name": "CritterId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ident Item.CritterId", "description": "Identifier of the owning critter while Ownership is CritterInventory; zero otherwise", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 137 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.CritterSlot", "family_id": "script.property.Item.CritterSlot", "kind": "property", "name": "CritterSlot", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "CritterItemSlot Item.CritterSlot", "description": "Inventory or equipment slot occupied while the item belongs to a critter", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 144 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "CritterItemSlot", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.CustomHolderEntry", "family_id": "script.property.Item.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "hstring Item.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.CustomHolderId", "family_id": "script.property.Item.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ident Item.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.DisableEgg", "family_id": "script.property.Item.DisableEgg", "kind": "property", "name": "DisableEgg", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.DisableEgg", "description": "Disables transparent-foreground egg processing for the item's map sprite", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 167 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.DrawFlatten", "family_id": "script.property.Item.DrawFlatten", "kind": "property", "name": "DrawFlatten", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.DrawFlatten", "description": "Renders the item in a flat map pass instead of the normal depth-sorted item pass", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 266 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.DrawMultihexLines", "family_id": "script.property.Item.DrawMultihexLines", "kind": "property", "name": "DrawMultihexLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.DrawMultihexLines", "description": "Draws repeated item sprites on footprint hexes generated by MultihexLines", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 181 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.DrawMultihexMesh", "family_id": "script.property.Item.DrawMultihexMesh", "kind": "property", "name": "DrawMultihexMesh", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.DrawMultihexMesh", "description": "Draws repeated item sprites on the explicit MultihexMesh hexes", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 184 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.DrawOrderSubLayer", "family_id": "script.property.Item.DrawOrderSubLayer", "kind": "property", "name": "DrawOrderSubLayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "int8 Item.DrawOrderSubLayer", "description": "Fine ordering inside the item's primary draw-order layer; synchronized when changed at runtime", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 269 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int8", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.Elevation", "family_id": "script.property.Item.Elevation", "kind": "property", "name": "Elevation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "int16 Item.Elevation", "description": "Vertical rendering elevation of the map item", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 132 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int16", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.ExplicitlyPersistent", "family_id": "script.property.Item.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.Hex", "family_id": "script.property.Item.Hex", "kind": "property", "name": "Hex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "mpos Item.Hex", "description": "Origin map hex used while the item is placed on a map", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 129 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "mpos", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.Hidden", "family_id": "script.property.Item.Hidden", "kind": "property", "name": "Hidden", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "bool Item.Hidden", "description": "Server visibility flag that suppresses a dynamic item from client views while set", "flags": [ "Mutable", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 189 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.HideSprite", "family_id": "script.property.Item.HideSprite", "kind": "property", "name": "HideSprite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.HideSprite", "description": "Hides the current client map sprite without removing the item's map presence", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 192 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.InitScript", "family_id": "script.property.Item.InitScript", "kind": "property", "name": "InitScript", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "hstring Item.InitScript", "description": "Server initialization function called after the item-init event for a newly created or restored item", "flags": [ "Mutable", "Persistent", "ScriptFuncType", "=", "ItemInit", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.InnerItemIds", "family_id": "script.property.Item.InnerItemIds", "kind": "property", "name": "InnerItemIds", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "ident[] Item.InnerItemIds", "description": "Persistent identifiers of the items directly contained by this item", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 155 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.IsGag", "family_id": "script.property.Item.IsGag", "kind": "property", "name": "IsGag", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsGag", "description": "Marks a blocking item as conditionally passable through the map gag callback", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 282 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.IsRoofTile", "family_id": "script.property.Item.IsRoofTile", "kind": "property", "name": "IsRoofTile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsRoofTile", "description": "Selects roof rendering instead of ground-tile rendering when IsTile is enabled", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 258 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.IsScenery", "family_id": "script.property.Item.IsScenery", "kind": "property", "name": "IsScenery", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsScenery", "description": "Classifies the item as scenery for Mapper filtering and flat-render lighting rules", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 249 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.IsTile", "family_id": "script.property.Item.IsTile", "kind": "property", "name": "IsTile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsTile", "description": "Classifies the item as a ground or roof tile rendered in a tile layer", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 255 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.IsTrigger", "family_id": "script.property.Item.IsTrigger", "kind": "property", "name": "IsTrigger", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsTrigger", "description": "Includes the item in map trigger lookup and movement-trigger processing", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 243 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.IsWall", "family_id": "script.property.Item.IsWall", "kind": "property", "name": "IsWall", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.IsWall", "description": "Classifies the item as a wall for Mapper filtering and map presentation", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 252 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.LightColor", "family_id": "script.property.Item.LightColor", "kind": "property", "name": "LightColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ucolor Item.LightColor", "description": "RGBA color emitted by the item's light source", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 229 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ucolor", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.LightDistance", "family_id": "script.property.Item.LightDistance", "kind": "property", "name": "LightDistance", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "int16 Item.LightDistance", "description": "Radius in hexes reached by the item's light source", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 223 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int16", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.LightFlags", "family_id": "script.property.Item.LightFlags", "kind": "property", "name": "LightFlags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "uint16 Item.LightFlags", "description": "Bit mask controlling global, inverse, and direction-blocking behavior of the light source", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 226 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "uint16", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.LightIntensity", "family_id": "script.property.Item.LightIntensity", "kind": "property", "name": "LightIntensity", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "int8 Item.LightIntensity", "description": "Signed percentage intensity of the item's light source", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 220 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int8", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.LightSource", "family_id": "script.property.Item.LightSource", "kind": "property", "name": "LightSource", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.LightSource", "description": "Enables a map light source centered on this item", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 217 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.LightThru", "family_id": "script.property.Item.LightThru", "kind": "property", "name": "LightThru", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.LightThru", "description": "Allows map light propagation through every hex occupied by the item", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 212 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.MapId", "family_id": "script.property.Item.MapId", "kind": "property", "name": "MapId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ident Item.MapId", "description": "Identifier of the owning map while Ownership is MapHex; zero otherwise", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 126 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.MultihexGeneration", "family_id": "script.property.Item.MultihexGeneration", "kind": "property", "name": "MultihexGeneration", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "MultihexGenerationType Item.MultihexGeneration", "description": "Mapper coalescing strategy used to build MultihexMesh from compatible item placements", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "MultihexGenerationType", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.MultihexLines", "family_id": "script.property.Item.MultihexLines", "kind": "property", "name": "MultihexLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "uint8[] Item.MultihexLines", "description": "Direction and step-count pairs that trace additional footprint hexes from each mesh origin", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 172 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "uint8[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.MultihexMesh", "family_id": "script.property.Item.MultihexMesh", "kind": "property", "name": "MultihexMesh", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "mpos[] Item.MultihexMesh", "description": "Explicit map hexes that share this item's footprint and optional repeated sprite", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 175 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "mpos[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.NoBlock", "family_id": "script.property.Item.NoBlock", "kind": "property", "name": "NoBlock", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.NoBlock", "description": "Allows movement through every hex occupied by the item", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 202 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.NoHighlight", "family_id": "script.property.Item.NoHighlight", "kind": "property", "name": "NoHighlight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.NoHighlight", "description": "Prevents the client from applying normal item highlight presentation", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 274 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.NoLightInfluence", "family_id": "script.property.Item.NoLightInfluence", "kind": "property", "name": "NoLightInfluence", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.NoLightInfluence", "description": "Prevents ambient map lighting from tinting the item's sprite", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 279 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.Offset", "family_id": "script.property.Item.Offset", "kind": "property", "name": "Offset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ipos16 Item.Offset", "description": "Pixel offset applied to the item's map sprite from its origin hex", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 161 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ipos16", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.Ownership", "family_id": "script.property.Item.Ownership", "kind": "property", "name": "Ownership", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "ItemOwnership Item.Ownership", "description": "Current placement category: map hex, critter inventory, item container, or nowhere", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 123 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ItemOwnership", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.PicInv", "family_id": "script.property.Item.PicInv", "kind": "property", "name": "PicInv", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "hstring Item.PicInv", "description": "Sprite resource used to present the item in inventory interfaces", "flags": [ "Mutable", "PublicSync", "Persistent", "Resource", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 246 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.PicMap", "family_id": "script.property.Item.PicMap", "kind": "property", "name": "PicMap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "hstring Item.PicMap", "description": "Sprite resource used to render the item on a map", "flags": [ "Mutable", "PublicSync", "Persistent", "Resource", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 158 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.ShootThru", "family_id": "script.property.Item.ShootThru", "kind": "property", "name": "ShootThru", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.ShootThru", "description": "Allows projectile traces through every hex occupied by the item", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 207 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.Static", "family_id": "script.property.Item.Static", "kind": "property", "name": "Static", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "bool Item.Static", "description": "Marks map-authored item data as static scenery rather than a dynamic item entity", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 118 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.StaticScript", "family_id": "script.property.Item.StaticScript", "kind": "property", "name": "StaticScript", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "hstring Item.StaticScript", "description": "Server callback invoked when a critter interacts with this static item", "flags": [ "Mutable", "Persistent", "ScriptFuncType", "=", "ItemStatic", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 237 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Item.TileLayer", "family_id": "script.property.Item.TileLayer", "kind": "property", "name": "TileLayer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Item", "signature": "uint8 Item.TileLayer", "description": "Zero-based ground- or roof-tile draw layer selected for a tile item", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 261 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "uint8", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Item.TriggerScript", "family_id": "script.property.Item.TriggerScript", "kind": "property", "name": "TriggerScript", "runtime_sides": [ "server" ], "receiver": "Item", "signature": "hstring Item.TriggerScript", "description": "Server callback invoked when a critter enters or leaves this trigger item", "flags": [ "Mutable", "Persistent", "ScriptFuncType", "=", "ItemTrigger", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 240 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Location.CustomHolderEntry", "family_id": "script.property.Location.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Location", "signature": "hstring Location.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Location.CustomHolderId", "family_id": "script.property.Location.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Location", "signature": "ident Location.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Location.ExplicitlyPersistent", "family_id": "script.property.Location.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Location", "signature": "bool Location.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Location.InitScript", "family_id": "script.property.Location.InitScript", "kind": "property", "name": "InitScript", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "hstring Location.InitScript", "description": "Server initialization function called after the location-init event for a newly created or restored location", "flags": [ "Mutable", "Persistent", "ScriptFuncType", "=", "LocationInit", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 495 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Location.MapIds", "family_id": "script.property.Location.MapIds", "kind": "property", "name": "MapIds", "runtime_sides": [ "server" ], "receiver": "Location", "signature": "ident[] Location.MapIds", "description": "Persistent identifiers of the maps owned by this location, in location-map order", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 498 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.CritterIds", "family_id": "script.property.Map.CritterIds", "kind": "property", "name": "CritterIds", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "ident[] Map.CritterIds", "description": "Persistent identifiers of the non-player critters owned by this map", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 429 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.CustomHolderEntry", "family_id": "script.property.Map.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "hstring Map.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.CustomHolderId", "family_id": "script.property.Map.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "ident Map.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.DayColor", "family_id": "script.property.Map.DayColor", "kind": "property", "name": "DayColor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "uint8[] Map.DayColor", "description": "Channel-major RGB values for the map's corresponding daylight color keyframes", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 466 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "uint8[]", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Map.DayColorTime", "family_id": "script.property.Map.DayColorTime", "kind": "property", "name": "DayColorTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "int32[] Map.DayColorTime", "description": "Map-specific daylight color keyframe times expressed in minutes of the day cycle", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 463 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32[]", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Map.ExplicitlyPersistent", "family_id": "script.property.Map.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "bool Map.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.FixedDayTime", "family_id": "script.property.Map.FixedDayTime", "kind": "property", "name": "FixedDayTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.FixedDayTime", "description": "Map-local day-time override value, conventionally expressed in minutes and interpreted by game scripts", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 458 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "int32", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Map.GlobalDayColor", "family_id": "script.property.Map.GlobalDayColor", "kind": "property", "name": "GlobalDayColor", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "ucolor Map.GlobalDayColor", "description": "Current client-side global daylight color supplied through SetDayColors for scripts and effects", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 472 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "ucolor", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.GlobalDayLightCapacity", "family_id": "script.property.Map.GlobalDayLightCapacity", "kind": "property", "name": "GlobalDayLightCapacity", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.GlobalDayLightCapacity", "description": "Current daylight capacity percentage for light sources flagged as global, clamped to 0 through 100", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 478 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "int32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.InitScript", "family_id": "script.property.Map.InitScript", "kind": "property", "name": "InitScript", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "hstring Map.InitScript", "description": "Server initialization function called after the map-init event for a newly created or restored map", "flags": [ "Mutable", "Persistent", "ScriptFuncType", "=", "MapInit", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 420 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "hstring", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Map.ItemIds", "family_id": "script.property.Map.ItemIds", "kind": "property", "name": "ItemIds", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "ident[] Map.ItemIds", "description": "Persistent identifiers of the dynamic items placed directly on this map", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 432 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident[]", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.LocId", "family_id": "script.property.Map.LocId", "kind": "property", "name": "LocId", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "ident Map.LocId", "description": "Identifier of the location that owns this map", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 423 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.LocMapIndex", "family_id": "script.property.Map.LocMapIndex", "kind": "property", "name": "LocMapIndex", "runtime_sides": [ "server" ], "receiver": "Map", "signature": "int32 Map.LocMapIndex", "description": "Zero-based position of this map in its owning location's map list", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 426 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "int32", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.MapDayColor", "family_id": "script.property.Map.MapDayColor", "kind": "property", "name": "MapDayColor", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "ucolor Map.MapDayColor", "description": "Current client-side map tint supplied through SetDayColors and consumed by map rendering", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 469 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "ucolor", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.MapDayLightCapacity", "family_id": "script.property.Map.MapDayLightCapacity", "kind": "property", "name": "MapDayLightCapacity", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "int32 Map.MapDayLightCapacity", "description": "Current daylight capacity percentage for ordinary map light sources, clamped to 0 through 100", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 475 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "int32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.RemovedStaticItemIds", "family_id": "script.property.Map.RemovedStaticItemIds", "kind": "property", "name": "RemovedStaticItemIds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "ident[] Map.RemovedStaticItemIds", "description": "Identifiers of the baked static items this map instance has dropped; removal is one-way for the life of the instance", "flags": [ "Mutable", "PublicSync", "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 435 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident[]", "nullable": false, "mutability": "mutable", "persistent": true }, { "id": "script.property.Map.ScrollAxialArea", "family_id": "script.property.Map.ScrollAxialArea", "kind": "property", "name": "ScrollAxialArea", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "irect Map.ScrollAxialArea", "description": "Axial-coordinate rectangle that bounds map scrolling; a zero rectangle leaves the full map available", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 447 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "irect", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.ScrollOffset", "family_id": "script.property.Map.ScrollOffset", "kind": "property", "name": "ScrollOffset", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "ipos Map.ScrollOffset", "description": "Rounded client viewport offset in map-space pixels", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 444 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "ipos", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.Size", "family_id": "script.property.Map.Size", "kind": "property", "name": "Size", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "msize Map.Size", "description": "Width and height of the map grid in hexes", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 438 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "msize", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Map.SpritesZoom", "family_id": "script.property.Map.SpritesZoom", "kind": "property", "name": "SpritesZoom", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "float32 Map.SpritesZoom", "description": "Current client map-sprite zoom factor", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 450 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "float32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.SpritesZoomTarget", "family_id": "script.property.Map.SpritesZoomTarget", "kind": "property", "name": "SpritesZoomTarget", "runtime_sides": [ "client", "mapper" ], "receiver": "Map", "signature": "float32 Map.SpritesZoomTarget", "description": "Target zoom factor toward which the client map view is interpolating", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 453 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "client", "type": "float32", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Map.WorkHex", "family_id": "script.property.Map.WorkHex", "kind": "property", "name": "WorkHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Map", "signature": "mpos Map.WorkHex", "description": "Authoring work hex used as the initial Mapper view center", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 441 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "mpos", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Player.ControlledCritterId", "family_id": "script.property.Player.ControlledCritterId", "kind": "property", "name": "ControlledCritterId", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "ident Player.ControlledCritterId", "description": "Identifier of the critter currently controlled by this player; zero when none is attached", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 93 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.property.Player.CustomHolderEntry", "family_id": "script.property.Player.CustomHolderEntry", "kind": "property", "name": "CustomHolderEntry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Player", "signature": "hstring Player.CustomHolderEntry", "description": "For a custom entity, names the holder entry through which it is attached", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 89 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "hstring", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Player.CustomHolderId", "family_id": "script.property.Player.CustomHolderId", "kind": "property", "name": "CustomHolderId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Player", "signature": "ident Player.CustomHolderId", "description": "For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 86 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Player.ExplicitlyPersistent", "family_id": "script.property.Player.ExplicitlyPersistent", "kind": "property", "name": "ExplicitlyPersistent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "Player", "signature": "bool Player.ExplicitlyPersistent", "description": "Marks an entity as independently persistent rather than persistent only through containment by another entity", "flags": [ "Persistent", "CoreProperty", "SharedProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Entity.h", "line": 92 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "common", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Player.LastControlledCritterId", "family_id": "script.property.Player.LastControlledCritterId", "kind": "property", "name": "LastControlledCritterId", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "ident Player.LastControlledCritterId", "description": "Persistent identifier of the most recently controlled critter, retained after detachment for restoration", "flags": [ "Persistent", "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 96 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "ident", "nullable": false, "mutability": "read-only", "persistent": true }, { "id": "script.property.Player.LoggedIn", "family_id": "script.property.Player.LoggedIn", "kind": "property", "name": "LoggedIn", "runtime_sides": [ "server" ], "receiver": "Player", "signature": "bool Player.LoggedIn", "description": "Reports whether this player connection has completed server login", "flags": [ "CoreProperty" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/EntityProperties.h", "line": 90 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "access": "server", "type": "bool", "nullable": false, "mutability": "read-only", "persistent": false }, { "id": "script.ref-field.client.FogLayer.CenterColor", "family_id": "script.ref-field.client.FogLayer.CenterColor", "kind": "ref-field", "name": "CenterColor", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "ucolor FogLayer.CenterColor", "description": "Traced-overlay center color", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "ucolor", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.CheckShootBlocks", "family_id": "script.ref-field.client.FogLayer.CheckShootBlocks", "kind": "ref-field", "name": "CheckShootBlocks", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "bool FogLayer.CheckShootBlocks", "description": "Includes shoot-blocking map geometry when tracing the fog boundary", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.ClearRadius", "family_id": "script.ref-field.client.FogLayer.ClearRadius", "kind": "ref-field", "name": "ClearRadius", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "float32 FogLayer.ClearRadius", "description": "Fraction kept crisp before the edge fade (lower = wider border)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "float32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.Depth", "family_id": "script.ref-field.client.FogLayer.Depth", "kind": "ref-field", "name": "Depth", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "float32 FogLayer.Depth", "description": "Extra darkening with distance past the edge", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "float32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.Disposed", "family_id": "script.ref-field.client.FogLayer.Disposed", "kind": "ref-field", "name": "Disposed", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "bool FogLayer.Disposed", "description": "Script-readable status: true once Dispose() ran or the owning map was destroyed (recreate then)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.Distance", "family_id": "script.ref-field.client.FogLayer.Distance", "kind": "ref-field", "name": "Distance", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "int32 FogLayer.Distance", "description": "Zone reach in hexes (traced overlay); 0 = derive from the look distance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "int32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.EdgeNoise", "family_id": "script.ref-field.client.FogLayer.EdgeNoise", "kind": "ref-field", "name": "EdgeNoise", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "float32 FogLayer.EdgeNoise", "description": "Drifting-mist rim ripple strength", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "float32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.Enabled", "family_id": "script.ref-field.client.FogLayer.Enabled", "kind": "ref-field", "name": "Enabled", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "bool FogLayer.Enabled", "description": "Enables shape generation while preserving transition state when toggled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.ExtraLength", "family_id": "script.ref-field.client.FogLayer.ExtraLength", "kind": "ref-field", "name": "ExtraLength", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "int32 FogLayer.ExtraLength", "description": "Extra look length added to the derived radius", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "int32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.OriginHex", "family_id": "script.ref-field.client.FogLayer.OriginHex", "kind": "ref-field", "name": "OriginHex", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "mpos FogLayer.OriginHex", "description": "Origin for a hex-anchored fog (ignored when following a critter)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "mpos", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.OvalRoundness", "family_id": "script.ref-field.client.FogLayer.OvalRoundness", "kind": "ref-field", "name": "OvalRoundness", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "float32 FogLayer.OvalRoundness", "description": "0 = raw hexagon, 1 = full smooth oval", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "float32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.OverlayColor", "family_id": "script.ref-field.client.FogLayer.OverlayColor", "kind": "ref-field", "name": "OverlayColor", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "ucolor FogLayer.OverlayColor", "description": "Traced-overlay (zone) color", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "ucolor", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.Radius", "family_id": "script.ref-field.client.FogLayer.Radius", "kind": "ref-field", "name": "Radius", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "int32 FogLayer.Radius", "description": "Look radius in hexes; 0 = use the origin critter's look distance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "int32", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.TintColor", "family_id": "script.ref-field.client.FogLayer.TintColor", "kind": "ref-field", "name": "TintColor", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "ucolor FogLayer.TintColor", "description": "Cold dim tint of the unseen area (rgb used; a ignored)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "ucolor", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.Traced", "family_id": "script.ref-field.client.FogLayer.Traced", "kind": "ref-field", "name": "Traced", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "bool FogLayer.Traced", "description": "Positive traced overlay (attack/observation zone) vs inverse look fog", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.FogLayer.TransitionDuration", "family_id": "script.ref-field.client.FogLayer.TransitionDuration", "kind": "ref-field", "name": "TransitionDuration", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "int32 FogLayer.TransitionDuration", "description": "Grow/move/shrink morph duration in ms", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "type": "int32", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.Angle", "family_id": "script.ref-field.client.MapSpriteHolder.Angle", "kind": "ref-field", "name": "Angle", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "int16 MapSpriteHolder.Angle", "description": "Initial sprite angle in degrees applied when nonzero", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "int16", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.Color", "family_id": "script.ref-field.client.MapSpriteHolder.Color", "kind": "ref-field", "name": "Color", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "ucolor MapSpriteHolder.Color", "description": "Optional packed color and fixed alpha applied at attachment; clear leaves the sprite color unchanged", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "ucolor", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.Corner", "family_id": "script.ref-field.client.MapSpriteHolder.Corner", "kind": "ref-field", "name": "Corner", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "CornerType MapSpriteHolder.Corner", "description": "Manual corner classification used for lighting and egg appearance when ProtoId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "CornerType", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.DisableEgg", "family_id": "script.ref-field.client.MapSpriteHolder.DisableEgg", "kind": "ref-field", "name": "DisableEgg", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.DisableEgg", "description": "Manual switch that suppresses egg appearance when ProtoId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.DrawOrder", "family_id": "script.ref-field.client.MapSpriteHolder.DrawOrder", "kind": "ref-field", "name": "DrawOrder", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "DrawOrderType MapSpriteHolder.DrawOrder", "description": "Manual draw-order slot used when ProtoId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "DrawOrderType", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.DrawOrderSubLayer", "family_id": "script.ref-field.client.MapSpriteHolder.DrawOrderSubLayer", "kind": "ref-field", "name": "DrawOrderSubLayer", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "int8 MapSpriteHolder.DrawOrderSubLayer", "description": "Fine ordering within DrawOrder used when ProtoId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "int8", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.Hex", "family_id": "script.ref-field.client.MapSpriteHolder.Hex", "kind": "ref-field", "name": "Hex", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "mpos MapSpriteHolder.Hex", "description": "Map hex used as the sprite anchor and visibility test", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "mpos", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.IsFlat", "family_id": "script.ref-field.client.MapSpriteHolder.IsFlat", "kind": "ref-field", "name": "IsFlat", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.IsFlat", "description": "Manual flat-sprite selection used when ProtoId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.IsTweakAlpha", "family_id": "script.ref-field.client.MapSpriteHolder.IsTweakAlpha", "kind": "ref-field", "name": "IsTweakAlpha", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.IsTweakAlpha", "description": "Enables live alpha tracking through TweakAlpha after attachment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.IsTweakOffs", "family_id": "script.ref-field.client.MapSpriteHolder.IsTweakOffs", "kind": "ref-field", "name": "IsTweakOffs", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.IsTweakOffs", "description": "Enables live offset tracking through TweakOffset after attachment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.MapProjected", "family_id": "script.ref-field.client.MapSpriteHolder.MapProjected", "kind": "ref-field", "name": "MapProjected", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.MapProjected", "description": "Requests map-projected rendering when the sprite is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.NoLight", "family_id": "script.ref-field.client.MapSpriteHolder.NoLight", "kind": "ref-field", "name": "NoLight", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.NoLight", "description": "Manual lighting bypass used when ProtoId is empty", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.Offset", "family_id": "script.ref-field.client.MapSpriteHolder.Offset", "kind": "ref-field", "name": "Offset", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "ipos MapSpriteHolder.Offset", "description": "Base map-pixel offset applied when the sprite is attached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "ipos", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.ProtoId", "family_id": "script.ref-field.client.MapSpriteHolder.ProtoId", "kind": "ref-field", "name": "ProtoId", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "hstring MapSpriteHolder.ProtoId", "description": "Optional item prototype whose color, flattening, lighting, draw order, corner, and egg settings override the corresponding holder fields", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "hstring", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.SprId", "family_id": "script.ref-field.client.MapSpriteHolder.SprId", "kind": "ref-field", "name": "SprId", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "uint32 MapSpriteHolder.SprId", "description": "Sprite resource handle resolved when Map.DrawMapSprite attaches the holder", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "uint32", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.TweakAlpha", "family_id": "script.ref-field.client.MapSpriteHolder.TweakAlpha", "kind": "ref-field", "name": "TweakAlpha", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "uint8 MapSpriteHolder.TweakAlpha", "description": "Mutable alpha read by the attached sprite while IsTweakAlpha was enabled at attachment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "uint8", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.TweakOffset", "family_id": "script.ref-field.client.MapSpriteHolder.TweakOffset", "kind": "ref-field", "name": "TweakOffset", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "ipos MapSpriteHolder.TweakOffset", "description": "Mutable map-pixel offset read by the attached sprite while IsTweakOffs was enabled at attachment", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "ipos", "mutability": "mutable" }, { "id": "script.ref-field.client.MapSpriteHolder.Valid", "family_id": "script.ref-field.client.MapSpriteHolder.Valid", "kind": "ref-field", "name": "Valid", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "bool MapSpriteHolder.Valid", "description": "Reports whether the attached map sprite remains valid; the sprite writes false when invalidated", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.SpritePattern.CheckTileProperty", "family_id": "script.ref-field.client.SpritePattern.CheckTileProperty", "kind": "ref-field", "name": "CheckTileProperty", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "bool SpritePattern.CheckTileProperty", "description": "Enables the required ground-tile property filter; false currently suppresses all pattern placement", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.SpritePattern.EveryHex", "family_id": "script.ref-field.client.SpritePattern.EveryHex", "kind": "ref-field", "name": "EveryHex", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "ipos SpritePattern.EveryHex", "description": "Positive nonzero X/Y hex intervals used as modulo divisors when selecting placement cells", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "type": "ipos", "mutability": "mutable" }, { "id": "script.ref-field.client.SpritePattern.ExpectedTilePropertyValue", "family_id": "script.ref-field.client.SpritePattern.ExpectedTilePropertyValue", "kind": "ref-field", "name": "ExpectedTilePropertyValue", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "int32 SpritePattern.ExpectedTilePropertyValue", "description": "Integer value that the selected ground-tile property must equal for sprite placement", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "type": "int32", "mutability": "mutable" }, { "id": "script.ref-field.client.SpritePattern.Finished", "family_id": "script.ref-field.client.SpritePattern.Finished", "kind": "ref-field", "name": "Finished", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "bool SpritePattern.Finished", "description": "Reports whether Finish has stopped this pattern and released its sprite instances", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.SpritePattern.InteractWithRoof", "family_id": "script.ref-field.client.SpritePattern.InteractWithRoof", "kind": "ref-field", "name": "InteractWithRoof", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "bool SpritePattern.InteractWithRoof", "description": "Makes hidden roofs suppress the pattern and places matching roof sprites in the roof-particle draw order", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-field.client.SpritePattern.TileProperty", "family_id": "script.ref-field.client.SpritePattern.TileProperty", "kind": "ref-field", "name": "TileProperty", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "ItemProperty SpritePattern.TileProperty", "description": "Ground-tile item property read when CheckTileProperty is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "type": "ItemProperty", "mutability": "mutable" }, { "id": "script.ref-field.client.VideoPlayback.Stopped", "family_id": "script.ref-field.client.VideoPlayback.Stopped", "kind": "ref-field", "name": "Stopped", "runtime_sides": [ "client", "mapper" ], "receiver": "VideoPlayback", "signature": "bool VideoPlayback.Stopped", "description": "Becomes true after DrawVideoPlayback observes that the underlying clip has stopped and releases its playback resources", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.VideoPlayback", "type": "bool", "mutability": "mutable" }, { "id": "script.ref-method.client.FogLayer.Dispose", "family_id": "script.ref-method.client.FogLayer.Dispose", "kind": "ref-method", "name": "Dispose", "runtime_sides": [ "client", "mapper" ], "receiver": "FogLayer", "signature": "void FogLayer.Dispose()", "description": "Marks this layer for removal during the map's next fog preparation pass; repeated calls are harmless", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.FogLayer", "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.client.MapSpriteHolder.StopDraw", "family_id": "script.ref-method.client.MapSpriteHolder.StopDraw", "kind": "ref-method", "name": "StopDraw", "runtime_sides": [ "client", "mapper" ], "receiver": "MapSpriteHolder", "signature": "void MapSpriteHolder.StopDraw()", "description": "Invalidates the attached map sprite, sets Valid to false through its callback, and detaches this holder; repeated calls are harmless", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.MapSpriteHolder", "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.client.SpritePattern.Finish", "family_id": "script.ref-method.client.SpritePattern.Finish", "kind": "ref-method", "name": "Finish", "runtime_sides": [ "client", "mapper" ], "receiver": "SpritePattern", "signature": "void SpritePattern.Finish()", "description": "Clears the pattern sprites and marks the controller finished; repeated calls are harmless", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.client.SpritePattern", "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.EvaluateNearestPathHex", "family_id": "script.ref-method.common.MovingContext.EvaluateNearestPathHex", "kind": "ref-method", "name": "EvaluateNearestPathHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos MovingContext.EvaluateNearestPathHex(mpos current_hex, mpos from_hex, mpos fallback_hex)", "description": "Returns the route hex at or after current_hex nearest to from_hex, falling back to fallback_hex when no closer path point exists", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos", "nullable": false }, "arguments": [ { "name": "current_hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "from_hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null }, { "name": "fallback_hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.ref-method.common.MovingContext.EvaluatePathHexes", "family_id": "script.ref-method.common.MovingContext.EvaluatePathHexes", "kind": "ref-method", "name": "EvaluatePathHexes", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos[] MovingContext.EvaluatePathHexes(mpos current_hex)", "description": "Returns route hexes from current_hex through the available path end, or a current/end pair for a route without stored steps", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos[]", "nullable": false }, "arguments": [ { "name": "current_hex", "type": "mpos", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.ref-method.common.MovingContext.EvaluateProjectedHex", "family_id": "script.ref-method.common.MovingContext.EvaluateProjectedHex", "kind": "ref-method", "name": "EvaluateProjectedHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos MovingContext.EvaluateProjectedHex(float32 look_ahead_ms)", "description": "Evaluates the route hex at the stored elapsed time plus a nonnegative look-ahead interval in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos", "nullable": false }, "arguments": [ { "name": "look_ahead_ms", "type": "float32", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.ref-method.common.MovingContext.GetBlockHex", "family_id": "script.ref-method.common.MovingContext.GetBlockHex", "kind": "ref-method", "name": "GetBlockHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos MovingContext.GetBlockHex()", "description": "Returns the blocking hex recorded for the route", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetCompleteReason", "family_id": "script.ref-method.common.MovingContext.GetCompleteReason", "kind": "ref-method", "name": "GetCompleteReason", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "MovingState MovingContext.GetCompleteReason()", "description": "Returns the reason supplied when the movement was completed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "MovingState", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetElapsedTime", "family_id": "script.ref-method.common.MovingContext.GetElapsedTime", "kind": "ref-method", "name": "GetElapsedTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "float32 MovingContext.GetElapsedTime()", "description": "Returns the stored elapsed movement time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetEndHex", "family_id": "script.ref-method.common.MovingContext.GetEndHex", "kind": "ref-method", "name": "GetEndHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos MovingContext.GetEndHex()", "description": "Returns the final map hex obtained from the stored route steps", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetEndHexOffset", "family_id": "script.ref-method.common.MovingContext.GetEndHexOffset", "kind": "ref-method", "name": "GetEndHexOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "ipos16 MovingContext.GetEndHexOffset()", "description": "Returns the map-pixel offset applied at the route's final hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "ipos16", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetPreBlockHex", "family_id": "script.ref-method.common.MovingContext.GetPreBlockHex", "kind": "ref-method", "name": "GetPreBlockHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos MovingContext.GetPreBlockHex()", "description": "Returns the last reachable hex recorded immediately before a blocking hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetSpeed", "family_id": "script.ref-method.common.MovingContext.GetSpeed", "kind": "ref-method", "name": "GetSpeed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "uint16 MovingContext.GetSpeed()", "description": "Returns the movement speed used to derive route timing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "uint16", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetStartHex", "family_id": "script.ref-method.common.MovingContext.GetStartHex", "kind": "ref-method", "name": "GetStartHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "mpos MovingContext.GetStartHex()", "description": "Returns the first map hex of the stored route", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "mpos", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetStartHexOffset", "family_id": "script.ref-method.common.MovingContext.GetStartHexOffset", "kind": "ref-method", "name": "GetStartHexOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "ipos16 MovingContext.GetStartHexOffset()", "description": "Returns the map-pixel offset applied at the route's starting hex", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "ipos16", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetWholeDist", "family_id": "script.ref-method.common.MovingContext.GetWholeDist", "kind": "ref-method", "name": "GetWholeDist", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "float32 MovingContext.GetWholeDist()", "description": "Returns the total projected map-pixel distance across all control-step segments", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.GetWholeTime", "family_id": "script.ref-method.common.MovingContext.GetWholeTime", "kind": "ref-method", "name": "GetWholeTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "float32 MovingContext.GetWholeTime()", "description": "Returns the total route duration in milliseconds after speed and endpoint offsets are applied", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "float32", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.MovingContext.IsCompleted", "family_id": "script.ref-method.common.MovingContext.IsCompleted", "kind": "ref-method", "name": "IsCompleted", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "MovingContext", "signature": "bool MovingContext.IsCompleted()", "description": "Returns whether the movement has been explicitly completed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.MovingContext", "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.GetData", "family_id": "script.ref-method.common.TimeEventContext.GetData", "kind": "ref-method", "name": "GetData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "any TimeEventContext.GetData()", "description": "Returns the first payload value, or an empty any value when the event has no payload", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "any", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.GetDataArray", "family_id": "script.ref-method.common.TimeEventContext.GetDataArray", "kind": "ref-method", "name": "GetDataArray", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "any[] TimeEventContext.GetDataArray()", "description": "Returns a copy of the complete payload array visible to this callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "any[]", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.GetId", "family_id": "script.ref-method.common.TimeEventContext.GetId", "kind": "ref-method", "name": "GetId", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "uint32 TimeEventContext.GetId()", "description": "Returns the unique identifier of the event currently invoking the callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "uint32", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.GetRepeat", "family_id": "script.ref-method.common.TimeEventContext.GetRepeat", "kind": "ref-method", "name": "GetRepeat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "timespan TimeEventContext.GetRepeat()", "description": "Returns the current repeat interval, including a value assigned by Repeat during this callback", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "timespan", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.HasData", "family_id": "script.ref-method.common.TimeEventContext.HasData", "kind": "ref-method", "name": "HasData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "bool TimeEventContext.HasData()", "description": "Returns whether the callback context currently contains at least one payload value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.IsStopped", "family_id": "script.ref-method.common.TimeEventContext.IsStopped", "kind": "ref-method", "name": "IsStopped", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "bool TimeEventContext.IsStopped()", "description": "Returns whether Stop has been requested through this callback context", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "bool", "nullable": false }, "arguments": [] }, { "id": "script.ref-method.common.TimeEventContext.Repeat", "family_id": "script.ref-method.common.TimeEventContext.Repeat", "kind": "ref-method", "name": "Repeat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "void TimeEventContext.Repeat(timespan repeat)", "description": "Replaces the repeat interval and schedules the next firing from callback completion, clamped to the Engine minimum interval", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "repeat", "type": "timespan", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.ref-method.common.TimeEventContext.SetData", "family_id": "script.ref-method.common.TimeEventContext.SetData", "kind": "ref-method", "name": "SetData", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "void TimeEventContext.SetData(any data)", "description": "Replaces the event payload with one value after the callback returns", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "data", "type": "any", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.ref-method.common.TimeEventContext.SetDataArray", "family_id": "script.ref-method.common.TimeEventContext.SetDataArray", "kind": "ref-method", "name": "SetDataArray", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "void TimeEventContext.SetDataArray(any[] data)", "description": "Replaces the complete event payload with a copy of the supplied array after the callback returns", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "void", "nullable": false }, "arguments": [ { "name": "data", "type": "any[]", "nullable": false, "by_reference": false, "default": null } ] }, { "id": "script.ref-method.common.TimeEventContext.Stop", "family_id": "script.ref-method.common.TimeEventContext.Stop", "kind": "ref-method", "name": "Stop", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TimeEventContext", "signature": "void TimeEventContext.Stop()", "description": "Marks the current event for removal after the callback returns", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.ref-type.common.TimeEventContext", "return": { "type": "void", "nullable": false }, "arguments": [] }, { "id": "script.ref-type.client.FogLayer", "family_id": "script.ref-type.client.FogLayer", "kind": "ref-type", "name": "FogLayer", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "ref type FogLayer", "description": "Map-owned fog or traced-zone layer whose shape and compositing parameters are rebuilt from mutable script fields each frame", "flags": [ "RefCounted", "Export", "=", "Enabled", ",", "Distance", ",", "Radius", ",", "ExtraLength", ",", "TransitionDuration", ",", "OvalRoundness", ",", "EdgeNoise", ",", "Depth", ",", "ClearRadius", ",", "TintColor", ",", "OverlayColor", ",", "CenterColor", ",", "Traced", ",", "CheckShootBlocks", ",", "OriginHex", ",", "Disposed", ",", "Dispose" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 99 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client" }, { "id": "script.ref-type.client.MapSpriteHolder", "family_id": "script.ref-type.client.MapSpriteHolder", "kind": "ref-type", "name": "MapSpriteHolder", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "ref type MapSpriteHolder", "description": "Script-configured holder for a client-local map sprite added by Map.DrawMapSprite and kept alive until invalidated or stopped", "flags": [ "RefCounted", "HasFactory", "Export", "=", "Valid", ",", "SprId", ",", "Hex", ",", "ProtoId", ",", "Offset", ",", "IsFlat", ",", "NoLight", ",", "DrawOrder", ",", "DrawOrderSubLayer", ",", "Corner", ",", "DisableEgg", ",", "Color", ",", "IsTweakOffs", ",", "TweakOffset", ",", "IsTweakAlpha", ",", "TweakAlpha", ",", "Angle", ",", "MapProjected", ",", "StopDraw" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapSprite.h", "line": 230 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client" }, { "id": "script.ref-type.client.SpritePattern", "family_id": "script.ref-type.client.SpritePattern", "kind": "ref-type", "name": "SpritePattern", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "ref type SpritePattern", "description": "Map-owned controller that places copies of a named sprite on matching visible hexes until finished or the map is destroyed", "flags": [ "RefCounted", "Export", "=", "Finished", ",", "EveryHex", ",", "InteractWithRoof", ",", "CheckTileProperty", ",", "TileProperty", ",", "ExpectedTilePropertyValue", ",", "Finish" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/MapView.h", "line": 76 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client" }, { "id": "script.ref-type.client.VideoPlayback", "family_id": "script.ref-type.client.VideoPlayback", "kind": "ref-type", "name": "VideoPlayback", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "ref type VideoPlayback", "description": "Script-owned controller for a video clip and render texture created by Game.CreateVideoPlayback and advanced by Game.DrawVideoPlayback", "flags": [ "RefCounted", "Export", "=", "Stopped" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/Client.h", "line": 77 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client" }, { "id": "script.ref-type.common.MovingContext", "family_id": "script.ref-type.common.MovingContext", "kind": "ref-type", "name": "MovingContext", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "ref type MovingContext", "description": "Shared movement-path state containing route geometry, timing, offsets, blocking information, and current completion progress", "flags": [ "RefCounted", "Export", "=", "GetSpeed", ",", "GetStartHex", ",", "GetEndHex", ",", "GetStartHexOffset", ",", "GetEndHexOffset", ",", "GetPreBlockHex", ",", "GetBlockHex", ",", "GetWholeTime", ",", "GetWholeDist", ",", "GetElapsedTime", ",", "IsCompleted", ",", "GetCompleteReason", ",", "EvaluateProjectedHex", ",", "EvaluateNearestPathHex", ",", "EvaluatePathHexes" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Movement.h", "line": 88 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common" }, { "id": "script.ref-type.common.TimeEventContext", "family_id": "script.ref-type.common.TimeEventContext", "kind": "ref-type", "name": "TimeEventContext", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "ref type TimeEventContext", "description": "Transient callback context for inspecting and changing the time event that is currently firing; requested changes are applied after the callback returns", "flags": [ "RefCounted", "Export", "=", "GetId", ",", "GetData", ",", "GetDataArray", ",", "HasData", ",", "IsStopped", ",", "GetRepeat", ",", "Stop", ",", "Repeat", ",", "SetData", ",", "SetDataArray" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TimeEvents.h", "line": 47 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common" }, { "id": "script.value-field.GamepadState.Available", "family_id": "script.value-field.GamepadState.Available", "kind": "value-field", "name": "Available", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.Available", "description": "Reports whether the application currently has an opened gamepad", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 183 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.Back", "family_id": "script.value-field.GamepadState.Back", "kind": "value-field", "name": "Back", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.Back", "description": "Reports whether the back button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 188 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.DpadDown", "family_id": "script.value-field.GamepadState.DpadDown", "kind": "value-field", "name": "DpadDown", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.DpadDown", "description": "Reports whether the D-pad down button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 195 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.DpadLeft", "family_id": "script.value-field.GamepadState.DpadLeft", "kind": "value-field", "name": "DpadLeft", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.DpadLeft", "description": "Reports whether the D-pad left button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 196 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.DpadRight", "family_id": "script.value-field.GamepadState.DpadRight", "kind": "value-field", "name": "DpadRight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.DpadRight", "description": "Reports whether the D-pad right button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 197 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.DpadUp", "family_id": "script.value-field.GamepadState.DpadUp", "kind": "value-field", "name": "DpadUp", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.DpadUp", "description": "Reports whether the D-pad up button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 194 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.East", "family_id": "script.value-field.GamepadState.East", "kind": "value-field", "name": "East", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.East", "description": "Reports whether the east face button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 185 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.LeftShoulder", "family_id": "script.value-field.GamepadState.LeftShoulder", "kind": "value-field", "name": "LeftShoulder", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.LeftShoulder", "description": "Reports whether the left shoulder button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 192 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.LeftStickButton", "family_id": "script.value-field.GamepadState.LeftStickButton", "kind": "value-field", "name": "LeftStickButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.LeftStickButton", "description": "Reports whether the left-stick button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 190 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.LeftStickX", "family_id": "script.value-field.GamepadState.LeftStickX", "kind": "value-field", "name": "LeftStickX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "float32 GamepadState.LeftStickX", "description": "Left-stick horizontal axis normalized to -1 through 1 after the dead zone", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 177 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "float32", "mutability": "value" }, { "id": "script.value-field.GamepadState.LeftStickY", "family_id": "script.value-field.GamepadState.LeftStickY", "kind": "value-field", "name": "LeftStickY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "float32 GamepadState.LeftStickY", "description": "Left-stick vertical axis normalized to -1 through 1 after the dead zone", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "float32", "mutability": "value" }, { "id": "script.value-field.GamepadState.LeftTrigger", "family_id": "script.value-field.GamepadState.LeftTrigger", "kind": "value-field", "name": "LeftTrigger", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "float32 GamepadState.LeftTrigger", "description": "Left-trigger pressure normalized to 0 through 1 after the dead zone", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 181 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "float32", "mutability": "value" }, { "id": "script.value-field.GamepadState.North", "family_id": "script.value-field.GamepadState.North", "kind": "value-field", "name": "North", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.North", "description": "Reports whether the north face button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 187 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.Reserved", "family_id": "script.value-field.GamepadState.Reserved", "kind": "value-field", "name": "Reserved", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.Reserved", "description": "Reserved compatibility field; the current input backend leaves it false", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 198 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.RightShoulder", "family_id": "script.value-field.GamepadState.RightShoulder", "kind": "value-field", "name": "RightShoulder", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.RightShoulder", "description": "Reports whether the right shoulder button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 193 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.RightStickButton", "family_id": "script.value-field.GamepadState.RightStickButton", "kind": "value-field", "name": "RightStickButton", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.RightStickButton", "description": "Reports whether the right-stick button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 191 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.RightStickX", "family_id": "script.value-field.GamepadState.RightStickX", "kind": "value-field", "name": "RightStickX", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "float32 GamepadState.RightStickX", "description": "Right-stick horizontal axis normalized to -1 through 1 after the dead zone", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 179 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "float32", "mutability": "value" }, { "id": "script.value-field.GamepadState.RightStickY", "family_id": "script.value-field.GamepadState.RightStickY", "kind": "value-field", "name": "RightStickY", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "float32 GamepadState.RightStickY", "description": "Right-stick vertical axis normalized to -1 through 1 after the dead zone", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 180 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "float32", "mutability": "value" }, { "id": "script.value-field.GamepadState.RightTrigger", "family_id": "script.value-field.GamepadState.RightTrigger", "kind": "value-field", "name": "RightTrigger", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "float32 GamepadState.RightTrigger", "description": "Right-trigger pressure normalized to 0 through 1 after the dead zone", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 182 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "float32", "mutability": "value" }, { "id": "script.value-field.GamepadState.South", "family_id": "script.value-field.GamepadState.South", "kind": "value-field", "name": "South", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.South", "description": "Reports whether the south face button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 184 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.Start", "family_id": "script.value-field.GamepadState.Start", "kind": "value-field", "name": "Start", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.Start", "description": "Reports whether the start button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 189 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.GamepadState.West", "family_id": "script.value-field.GamepadState.West", "kind": "value-field", "name": "West", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "GamepadState", "signature": "bool GamepadState.West", "description": "Reports whether the west face button is pressed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 186 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.GamepadState", "type": "bool", "mutability": "value" }, { "id": "script.value-field.LanguageName.Name", "family_id": "script.value-field.LanguageName.Name", "kind": "value-field", "name": "Name", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "LanguageName", "signature": "hstring LanguageName.Name", "description": "Hashed language identifier used to select localized text resources", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 56 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.LanguageName", "type": "hstring", "mutability": "value" }, { "id": "script.value-field.TextFormat.Flags", "family_id": "script.value-field.TextFormat.Flags", "kind": "value-field", "name": "Flags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextFormat", "signature": "FontFlag TextFormat.Flags", "description": "FontFlag bitmask controlling alignment, wrapping, clipping, color tags, and glyph presentation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 83 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextFormat", "type": "FontFlag", "mutability": "value" }, { "id": "script.value-field.TextFormat.Font", "family_id": "script.value-field.TextFormat.Font", "kind": "value-field", "name": "Font", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextFormat", "signature": "FontType TextFormat.Font", "description": "Font slot selected for text measurement and rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 82 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextFormat", "type": "FontType", "mutability": "value" }, { "id": "script.value-field.TextFormat.SkipLines", "family_id": "script.value-field.TextFormat.SkipLines", "kind": "value-field", "name": "SkipLines", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextFormat", "signature": "int32 TextFormat.SkipLines", "description": "Line-skip count taken from the top by default or from the bottom when AlignBottom is set", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 84 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextFormat", "type": "int32", "mutability": "value" }, { "id": "script.value-field.TextPackKey.Collection", "family_id": "script.value-field.TextPackKey.Collection", "kind": "value-field", "name": "Collection", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextPackKey", "signature": "TextPackName TextPackKey.Collection", "description": "Text-pack collection in which the key is resolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextPackKey", "type": "TextPackName", "mutability": "value" }, { "id": "script.value-field.TextPackKey.Key1", "family_id": "script.value-field.TextPackKey.Key1", "kind": "value-field", "name": "Key1", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextPackKey", "signature": "hstring TextPackKey.Key1", "description": "Primary hashed lookup-key component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 62 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextPackKey", "type": "hstring", "mutability": "value" }, { "id": "script.value-field.TextPackKey.Key2", "family_id": "script.value-field.TextPackKey.Key2", "kind": "value-field", "name": "Key2", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextPackKey", "signature": "hstring TextPackKey.Key2", "description": "Optional second hashed lookup-key component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 63 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextPackKey", "type": "hstring", "mutability": "value" }, { "id": "script.value-field.TextPackKey.Key3", "family_id": "script.value-field.TextPackKey.Key3", "kind": "value-field", "name": "Key3", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextPackKey", "signature": "hstring TextPackKey.Key3", "description": "Optional third hashed lookup-key component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 64 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextPackKey", "type": "hstring", "mutability": "value" }, { "id": "script.value-field.TextPackName.Name", "family_id": "script.value-field.TextPackName.Name", "kind": "value-field", "name": "Name", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "TextPackName", "signature": "hstring TextPackName.Name", "description": "Hashed text-pack collection name", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.TextPackName", "type": "hstring", "mutability": "value" }, { "id": "script.value-field.fpos.x", "family_id": "script.value-field.fpos.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "fpos", "signature": "float32 fpos.x", "description": "32-bit floating-point X position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 661 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.fpos", "type": "float32", "mutability": "value" }, { "id": "script.value-field.fpos.y", "family_id": "script.value-field.fpos.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "fpos", "signature": "float32 fpos.y", "description": "32-bit floating-point Y position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 662 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.fpos", "type": "float32", "mutability": "value" }, { "id": "script.value-field.frect.height", "family_id": "script.value-field.frect.height", "kind": "value-field", "name": "height", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "frect", "signature": "float32 frect.height", "description": "32-bit floating-point rectangle height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 682 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.frect", "type": "float32", "mutability": "value" }, { "id": "script.value-field.frect.width", "family_id": "script.value-field.frect.width", "kind": "value-field", "name": "width", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "frect", "signature": "float32 frect.width", "description": "32-bit floating-point rectangle width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 681 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.frect", "type": "float32", "mutability": "value" }, { "id": "script.value-field.frect.x", "family_id": "script.value-field.frect.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "frect", "signature": "float32 frect.x", "description": "32-bit floating-point X coordinate of the rectangle origin", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 679 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.frect", "type": "float32", "mutability": "value" }, { "id": "script.value-field.frect.y", "family_id": "script.value-field.frect.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "frect", "signature": "float32 frect.y", "description": "32-bit floating-point Y coordinate of the rectangle origin", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 680 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.frect", "type": "float32", "mutability": "value" }, { "id": "script.value-field.fsize.height", "family_id": "script.value-field.fsize.height", "kind": "value-field", "name": "height", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "fsize", "signature": "float32 fsize.height", "description": "32-bit floating-point height component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 671 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.fsize", "type": "float32", "mutability": "value" }, { "id": "script.value-field.fsize.width", "family_id": "script.value-field.fsize.width", "kind": "value-field", "name": "width", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "fsize", "signature": "float32 fsize.width", "description": "32-bit floating-point width component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 670 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.fsize", "type": "float32", "mutability": "value" }, { "id": "script.value-field.hdir.value", "family_id": "script.value-field.hdir.value", "kind": "value-field", "name": "value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "hdir", "signature": "int8 hdir.value", "description": "Direction index normalized to 0 through the configured six- or eight-direction count minus one", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 112 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.hdir", "type": "int8", "mutability": "value" }, { "id": "script.value-field.ident.value", "family_id": "script.value-field.ident.value", "kind": "value-field", "name": "value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ident", "signature": "int64 ident.value", "description": "Signed 64-bit identity payload; zero represents an empty identity", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 84 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ident", "type": "int64", "mutability": "value" }, { "id": "script.value-field.ipos.x", "family_id": "script.value-field.ipos.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ipos", "signature": "int32 ipos.x", "description": "Signed 32-bit X position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 629 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ipos", "type": "int32", "mutability": "value" }, { "id": "script.value-field.ipos.y", "family_id": "script.value-field.ipos.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ipos", "signature": "int32 ipos.y", "description": "Signed 32-bit Y position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 630 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ipos", "type": "int32", "mutability": "value" }, { "id": "script.value-field.ipos16.x", "family_id": "script.value-field.ipos16.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ipos16", "signature": "int16 ipos16.x", "description": "Signed 16-bit X position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 620 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ipos16", "type": "int16", "mutability": "value" }, { "id": "script.value-field.ipos16.y", "family_id": "script.value-field.ipos16.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ipos16", "signature": "int16 ipos16.y", "description": "Signed 16-bit Y position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 621 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ipos16", "type": "int16", "mutability": "value" }, { "id": "script.value-field.ipos8.x", "family_id": "script.value-field.ipos8.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ipos8", "signature": "int8 ipos8.x", "description": "Signed 8-bit X position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 611 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ipos8", "type": "int8", "mutability": "value" }, { "id": "script.value-field.ipos8.y", "family_id": "script.value-field.ipos8.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ipos8", "signature": "int8 ipos8.y", "description": "Signed 8-bit Y position component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 612 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ipos8", "type": "int8", "mutability": "value" }, { "id": "script.value-field.irect.height", "family_id": "script.value-field.irect.height", "kind": "value-field", "name": "height", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "irect", "signature": "int32 irect.height", "description": "Signed 32-bit rectangle height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 652 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.irect", "type": "int32", "mutability": "value" }, { "id": "script.value-field.irect.width", "family_id": "script.value-field.irect.width", "kind": "value-field", "name": "width", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "irect", "signature": "int32 irect.width", "description": "Signed 32-bit rectangle width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 651 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.irect", "type": "int32", "mutability": "value" }, { "id": "script.value-field.irect.x", "family_id": "script.value-field.irect.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "irect", "signature": "int32 irect.x", "description": "Signed 32-bit X coordinate of the rectangle origin", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 649 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.irect", "type": "int32", "mutability": "value" }, { "id": "script.value-field.irect.y", "family_id": "script.value-field.irect.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "irect", "signature": "int32 irect.y", "description": "Signed 32-bit Y coordinate of the rectangle origin", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 650 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.irect", "type": "int32", "mutability": "value" }, { "id": "script.value-field.isize.height", "family_id": "script.value-field.isize.height", "kind": "value-field", "name": "height", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "isize", "signature": "int32 isize.height", "description": "Signed 32-bit height component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 640 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.isize", "type": "int32", "mutability": "value" }, { "id": "script.value-field.isize.width", "family_id": "script.value-field.isize.width", "kind": "value-field", "name": "width", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "isize", "signature": "int32 isize.width", "description": "Signed 32-bit width component", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 639 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.isize", "type": "int32", "mutability": "value" }, { "id": "script.value-field.mdir.angle", "family_id": "script.value-field.mdir.angle", "kind": "value-field", "name": "angle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "mdir", "signature": "int16 mdir.angle", "description": "Direction angle in degrees normalized to the inclusive range 0 through 359", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 165 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.mdir", "type": "int16", "mutability": "value" }, { "id": "script.value-field.mpos.x", "family_id": "script.value-field.mpos.x", "kind": "value-field", "name": "x", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "mpos", "signature": "int16 mpos.x", "description": "Signed X component of the map-cell coordinate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 41 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.mpos", "type": "int16", "mutability": "value" }, { "id": "script.value-field.mpos.y", "family_id": "script.value-field.mpos.y", "kind": "value-field", "name": "y", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "mpos", "signature": "int16 mpos.y", "description": "Signed Y component of the map-cell coordinate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 42 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.mpos", "type": "int16", "mutability": "value" }, { "id": "script.value-field.msize.height", "family_id": "script.value-field.msize.height", "kind": "value-field", "name": "height", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "msize", "signature": "int16 msize.height", "description": "Map height in addressable cells", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 59 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.msize", "type": "int16", "mutability": "value" }, { "id": "script.value-field.msize.width", "family_id": "script.value-field.msize.width", "kind": "value-field", "name": "width", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "msize", "signature": "int16 msize.width", "description": "Map width in addressable cells", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 58 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.msize", "type": "int16", "mutability": "value" }, { "id": "script.value-field.nanotime.value", "family_id": "script.value-field.nanotime.value", "kind": "value-field", "name": "value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "nanotime", "signature": "int64 nanotime.value", "description": "Nanoseconds from the process-local monotonic steady-clock epoch; this is not civil wall-clock time", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/TimeRelated.h", "line": 138 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.nanotime", "type": "int64", "mutability": "value" }, { "id": "script.value-field.synctime.value", "family_id": "script.value-field.synctime.value", "kind": "value-field", "name": "value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "synctime", "signature": "int64 synctime.value", "description": "Milliseconds in the Engine-synchronized game-time domain", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/TimeRelated.h", "line": 210 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.synctime", "type": "int64", "mutability": "value" }, { "id": "script.value-field.timespan.value", "family_id": "script.value-field.timespan.value", "kind": "value-field", "name": "value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "timespan", "signature": "int64 timespan.value", "description": "Signed duration count in nanoseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/TimeRelated.h", "line": 48 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.timespan", "type": "int64", "mutability": "value" }, { "id": "script.value-field.ucolor.value", "family_id": "script.value-field.ucolor.value", "kind": "value-field", "name": "value", "runtime_sides": [ "server", "client", "mapper" ], "receiver": "ucolor", "signature": "uint32 ucolor.value", "description": "Packed 32-bit RGBA storage used for equality, ordering, hashing, and script transfer", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 67 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "parent_id": "script.value-type.ucolor", "type": "uint32", "mutability": "value" }, { "id": "script.value-type.GamepadState", "family_id": "script.value-type.GamepadState", "kind": "value-type", "name": "GamepadState", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type GamepadState", "description": "Per-frame gamepad snapshot containing availability, stick and trigger values, face buttons, shoulders, sticks, and D-pad state", "flags": [ "Layout", "=", "float32", "-", "LeftStickX", "+", "float32", "-", "LeftStickY", "+", "float32", "-", "RightStickX", "+", "float32", "-", "RightStickY", "+", "float32", "-", "LeftTrigger", "+", "float32", "-", "RightTrigger", "+", "bool", "-", "Available", "+", "bool", "-", "South", "+", "bool", "-", "East", "+", "bool", "-", "West", "+", "bool", "-", "North", "+", "bool", "-", "Back", "+", "bool", "-", "Start", "+", "bool", "-", "LeftStickButton", "+", "bool", "-", "RightStickButton", "+", "bool", "-", "LeftShoulder", "+", "bool", "-", "RightShoulder", "+", "bool", "-", "DpadUp", "+", "bool", "-", "DpadDown", "+", "bool", "-", "DpadLeft", "+", "bool", "-", "DpadRight", "+", "bool", "-", "Reserved" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Frontend/Application.h", "line": 199 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "GamepadState" }, { "id": "script.value-type.LanguageName", "family_id": "script.value-type.LanguageName", "kind": "value-type", "name": "LanguageName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type LanguageName", "description": "Hashed name that identifies a language in localized text resources", "flags": [ "Layout", "=", "hstring", "-", "Name" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 57 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "LanguageName" }, { "id": "script.value-type.TextFormat", "family_id": "script.value-type.TextFormat", "kind": "value-type", "name": "TextFormat", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type TextFormat", "description": "Bundled text formatting parameters: font slot, FontFlag bitmask, and skip-lines counter.\n`SkipLines` is \"skip from top\" by default; with FontFlag::AlignBottom set it becomes \"skip from bottom\" (trailing lines)", "flags": [ "Layout", "=", "FontType", "-", "Font", "+", "FontFlag", "-", "Flags", "+", "int32", "-", "SkipLines" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Client/FontManager.h", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "TextFormat" }, { "id": "script.value-type.TextPackKey", "family_id": "script.value-type.TextPackKey", "kind": "value-type", "name": "TextPackKey", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type TextPackKey", "description": "Text lookup key composed of a collection name and up to three hashed key components", "flags": [ "Layout", "=", "TextPackName", "-", "Collection", "+", "hstring", "-", "Key1", "+", "hstring", "-", "Key2", "+", "hstring", "-", "Key3" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 65 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "TextPackKey" }, { "id": "script.value-type.TextPackName", "family_id": "script.value-type.TextPackName", "kind": "value-type", "name": "TextPackName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type TextPackName", "description": "Hashed name that identifies a text-pack collection", "flags": [ "Layout", "=", "hstring", "-", "Name" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/TextPack.h", "line": 52 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "TextPackName" }, { "id": "script.value-type.fpos", "family_id": "script.value-type.fpos", "kind": "value-type", "name": "fpos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type fpos", "description": "Two-dimensional 32-bit floating-point position exposed to scripts as mutable x and y components", "flags": [ "Layout", "=", "float32", "-", "x", "+", "float32", "-", "y" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 663 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "fpos32" }, { "id": "script.value-type.frect", "family_id": "script.value-type.frect", "kind": "value-type", "name": "frect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type frect", "description": "32-bit floating-point rectangle exposed to scripts as mutable origin and size components", "flags": [ "Layout", "=", "float32", "-", "x", "+", "float32", "-", "y", "+", "float32", "-", "width", "+", "float32", "-", "height" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 683 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "frect32" }, { "id": "script.value-type.fsize", "family_id": "script.value-type.fsize", "kind": "value-type", "name": "fsize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type fsize", "description": "Two-dimensional 32-bit floating-point size exposed to scripts as mutable width and height components", "flags": [ "Layout", "=", "float32", "-", "width", "+", "float32", "-", "height" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 672 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "fsize32" }, { "id": "script.value-type.hdir", "family_id": "script.value-type.hdir", "kind": "value-type", "name": "hdir", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type hdir", "description": "Discrete map direction normalized modulo the configured six-direction hex or eight-direction square geometry", "flags": [ "Layout", "=", "int8", "-", "value" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 113 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "hdir" }, { "id": "script.value-type.ident", "family_id": "script.value-type.ident", "kind": "value-type", "name": "ident", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type ident", "description": "Strong signed 64-bit identity token whose zero value is false and whose ordering compares the stored value", "flags": [ "Layout", "=", "int64", "-", "value" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Common.h", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "ident_t" }, { "id": "script.value-type.ipos", "family_id": "script.value-type.ipos", "kind": "value-type", "name": "ipos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type ipos", "description": "Standard two-dimensional signed 32-bit integer position exposed to scripts as mutable x and y components", "flags": [ "Layout", "=", "int32", "-", "x", "+", "int32", "-", "y" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 631 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "ipos32" }, { "id": "script.value-type.ipos16", "family_id": "script.value-type.ipos16", "kind": "value-type", "name": "ipos16", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type ipos16", "description": "Two-dimensional signed 16-bit integer position exposed to scripts as mutable x and y components", "flags": [ "Layout", "=", "int16", "-", "x", "+", "int16", "-", "y" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 622 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "ipos16" }, { "id": "script.value-type.ipos8", "family_id": "script.value-type.ipos8", "kind": "value-type", "name": "ipos8", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type ipos8", "description": "Two-dimensional signed 8-bit integer position exposed to scripts as mutable x and y components", "flags": [ "Layout", "=", "int8", "-", "x", "+", "int8", "-", "y" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 613 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "ipos8" }, { "id": "script.value-type.irect", "family_id": "script.value-type.irect", "kind": "value-type", "name": "irect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type irect", "description": "Signed 32-bit integer rectangle exposed to scripts as mutable origin and size components", "flags": [ "Layout", "=", "int32", "-", "x", "+", "int32", "-", "y", "+", "int32", "-", "width", "+", "int32", "-", "height" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 653 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "irect32" }, { "id": "script.value-type.isize", "family_id": "script.value-type.isize", "kind": "value-type", "name": "isize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type isize", "description": "Two-dimensional signed 32-bit integer size exposed to scripts as mutable width and height components", "flags": [ "Layout", "=", "int32", "-", "width", "+", "int32", "-", "height" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 641 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "isize32" }, { "id": "script.value-type.mdir", "family_id": "script.value-type.mdir", "kind": "value-type", "name": "mdir", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type mdir", "description": "Map direction angle stored as a signed 16-bit value with conversion and rotation operations for discrete map directions", "flags": [ "Layout", "=", "int16", "-", "angle" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 166 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "mdir" }, { "id": "script.value-type.mpos", "family_id": "script.value-type.mpos", "kind": "value-type", "name": "mpos", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type mpos", "description": "Signed 16-bit map-coordinate position exposed to scripts as mutable x and y components", "flags": [ "Layout", "=", "int16", "-", "x", "+", "int16", "-", "y" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 43 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "mpos" }, { "id": "script.value-type.msize", "family_id": "script.value-type.msize", "kind": "value-type", "name": "msize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type msize", "description": "Signed 16-bit map size exposed to scripts as mutable width and height components", "flags": [ "Layout", "=", "int16", "-", "width", "+", "int16", "-", "height" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Geometry.h", "line": 60 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "msize" }, { "id": "script.value-type.nanotime", "family_id": "script.value-type.nanotime", "kind": "value-type", "name": "nanotime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type nanotime", "description": "Monotonic steady-clock time point stored as a signed 64-bit nanosecond count; it is not civil wall-clock time", "flags": [ "Layout", "=", "int64", "-", "value" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/TimeRelated.h", "line": 139 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "nanotime" }, { "id": "script.value-type.synctime", "family_id": "script.value-type.synctime", "kind": "value-type", "name": "synctime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type synctime", "description": "Engine-synchronized time point stored as a signed 64-bit millisecond count for shared game-time state", "flags": [ "Layout", "=", "int64", "-", "value" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/TimeRelated.h", "line": 211 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "synctime" }, { "id": "script.value-type.timespan", "family_id": "script.value-type.timespan", "kind": "value-type", "name": "timespan", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type timespan", "description": "Signed nanosecond-resolution duration stored as a 64-bit count", "flags": [ "Layout", "=", "int64", "-", "value" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/TimeRelated.h", "line": 49 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "timespan" }, { "id": "script.value-type.ucolor", "family_id": "script.value-type.ucolor", "kind": "value-type", "name": "ucolor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "value type ucolor", "description": "Color type", "flags": [ "Layout", "=", "uint32", "-", "value" ], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Essentials/ExtendedTypes.h", "line": 68 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "native_type": "ucolor" }, { "id": "setting.client.Audio.DisableAudio", "family_id": "setting.client.Audio.DisableAudio", "kind": "setting", "name": "Audio.DisableAudio", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Audio.DisableAudio = false", "description": "If true, audio is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Audio", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Audio.MixRate", "family_id": "setting.client.Audio.MixRate", "kind": "setting", "name": "Audio.MixRate", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Audio.MixRate = 44100", "description": "Sample rate the engine mixes at before handing the stream to the device, which resamples if it runs at another one", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Audio", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "44100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Audio.MusicVolume", "family_id": "setting.client.Audio.MusicVolume", "kind": "setting", "name": "Audio.MusicVolume", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Audio.MusicVolume = 100", "description": "Music volume percentage", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Audio", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Audio.SoundFileExtensions", "family_id": "setting.client.Audio.SoundFileExtensions", "kind": "setting", "name": "Audio.SoundFileExtensions", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string[] Audio.SoundFileExtensions = wav, ogg", "description": "Source extensions the sound-name index accepts; every baked payload is Ogg Vorbis whatever the extension says", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Audio", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "wav", "ogg" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Audio.SoundVolume", "family_id": "setting.client.Audio.SoundVolume", "kind": "setting", "name": "Audio.SoundVolume", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Audio.SoundVolume = 100", "description": "Sound volume percentage", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 151 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Audio", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.ClientPropertiesPackData", "family_id": "setting.client.Client.ClientPropertiesPackData", "kind": "setting", "name": "Client.ClientPropertiesPackData", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Client.ClientPropertiesPackData = true", "description": "If true, client entities with prototypes use overlay property storage", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.DefaultSplash", "family_id": "setting.client.Client.DefaultSplash", "kind": "setting", "name": "Client.DefaultSplash", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Client.DefaultSplash", "description": "Default splash screen", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.DefaultSplashPack", "family_id": "setting.client.Client.DefaultSplashPack", "kind": "setting", "name": "Client.DefaultSplashPack", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Client.DefaultSplashPack", "description": "Default splash pack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.ForceEmbeddedRuntime", "family_id": "setting.client.Client.ForceEmbeddedRuntime", "kind": "setting", "name": "Client.ForceEmbeddedRuntime", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Client.ForceEmbeddedRuntime = false", "description": "If true, the client host runs the embedded engine instead of loading the bundled runtime DLL first (an explicit --ClientLibPath still loads a DLL); read from the command line at host startup, before settings are otherwise resolved", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.Language", "family_id": "setting.client.Client.Language", "kind": "setting", "name": "Client.Language", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Client.Language = engl", "description": "Language setting", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "engl" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.UpdaterInfoDelay", "family_id": "setting.client.Client.UpdaterInfoDelay", "kind": "setting", "name": "Client.UpdaterInfoDelay", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Client.UpdaterInfoDelay = 1000", "description": "Updater info delay in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Client.UpdaterInfoPos", "family_id": "setting.client.Client.UpdaterInfoPos", "kind": "setting", "name": "Client.UpdaterInfoPos", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Client.UpdaterInfoPos = 0", "description": "Updater info position (<1 - top, 0 - center, >1 - bottom)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 376 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Client", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ChannelServerKeys", "family_id": "setting.client.ClientNetwork.ChannelServerKeys", "kind": "setting", "name": "ClientNetwork.ChannelServerKeys", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string[] ClientNetwork.ChannelServerKeys", "description": "Pinned secure channel server public keys, 64 hex digits each; all are offered at once, so the next key can be pinned ahead of a rotation", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.DebugNet", "family_id": "setting.client.ClientNetwork.DebugNet", "kind": "setting", "name": "ClientNetwork.DebugNet", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool ClientNetwork.DebugNet = false", "description": "If true, network debugging is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.PingPeriod", "family_id": "setting.client.ClientNetwork.PingPeriod", "kind": "setting", "name": "ClientNetwork.PingPeriod", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 ClientNetwork.PingPeriod = 2000", "description": "Ping period in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "2000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.PingTimeout", "family_id": "setting.client.ClientNetwork.PingTimeout", "kind": "setting", "name": "ClientNetwork.PingTimeout", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 ClientNetwork.PingTimeout = 30000", "description": "Time in milliseconds the secure channel handshake or a ping may stay unanswered while nothing at all arrives from the server before the connection counts as lost (0 = wait for ever)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "30000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ProxyHost", "family_id": "setting.client.ClientNetwork.ProxyHost", "kind": "setting", "name": "ClientNetwork.ProxyHost", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string ClientNetwork.ProxyHost = ", "description": "Proxy host address", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ProxyPass", "family_id": "setting.client.ClientNetwork.ProxyPass", "kind": "setting", "name": "ClientNetwork.ProxyPass", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string ClientNetwork.ProxyPass = ", "description": "Proxy password", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ProxyPort", "family_id": "setting.client.ClientNetwork.ProxyPort", "kind": "setting", "name": "ClientNetwork.ProxyPort", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 ClientNetwork.ProxyPort = 8080", "description": "Proxy port number", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "8080" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ProxyType", "family_id": "setting.client.ClientNetwork.ProxyType", "kind": "setting", "name": "ClientNetwork.ProxyType", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 ClientNetwork.ProxyType = 0", "description": "Proxy type", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ProxyUser", "family_id": "setting.client.ClientNetwork.ProxyUser", "kind": "setting", "name": "ClientNetwork.ProxyUser", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string ClientNetwork.ProxyUser = ", "description": "Proxy username", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.ServerHost", "family_id": "setting.client.ClientNetwork.ServerHost", "kind": "setting", "name": "ClientNetwork.ServerHost", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string ClientNetwork.ServerHost = 127.0.0.1", "description": "Server host address", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "127.0.0.1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.UseUdp", "family_id": "setting.client.ClientNetwork.UseUdp", "kind": "setting", "name": "ClientNetwork.UseUdp", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool ClientNetwork.UseUdp = false", "description": "If true, UDP native transport is used instead of TCP", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.ClientNetwork.WebSocketHost", "family_id": "setting.client.ClientNetwork.WebSocketHost", "kind": "setting", "name": "ClientNetwork.WebSocketHost", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string ClientNetwork.WebSocketHost = localhost", "description": "WebSockets server host for client connect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 135 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "ClientNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "localhost" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.CritterView.NameOffset", "family_id": "setting.client.CritterView.NameOffset", "kind": "setting", "name": "CritterView.NameOffset", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 CritterView.NameOffset = 0", "description": "Name offset value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 332 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "CritterView", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Hex.FullscreenMouseScroll", "family_id": "setting.client.Hex.FullscreenMouseScroll", "kind": "setting", "name": "Hex.FullscreenMouseScroll", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Hex.FullscreenMouseScroll = true", "description": "If true, fullscreen mouse scroll is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Hex", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Hex.ScrollBlockSize", "family_id": "setting.client.Hex.ScrollBlockSize", "kind": "setting", "name": "Hex.ScrollBlockSize", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Hex.ScrollBlockSize = 1", "description": "Blocked hexes around scroll block line", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Hex", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Hex.ScrollFixedDt", "family_id": "setting.client.Hex.ScrollFixedDt", "kind": "setting", "name": "Hex.ScrollFixedDt", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Hex.ScrollFixedDt = 10", "description": "Scroll fixed delta time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Hex", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "10" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Hex.ScrollSpeed", "family_id": "setting.client.Hex.ScrollSpeed", "kind": "setting", "name": "Hex.ScrollSpeed", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Hex.ScrollSpeed = 1200", "description": "Scroll speed in pixels per second", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Hex", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1200" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Hex.WindowedMouseScroll", "family_id": "setting.client.Hex.WindowedMouseScroll", "kind": "setting", "name": "Hex.WindowedMouseScroll", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Hex.WindowedMouseScroll = false", "description": "If true, windowed mouse scroll is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Hex", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Hex.ZoomSpeed", "family_id": "setting.client.Hex.ZoomSpeed", "kind": "setting", "name": "Hex.ZoomSpeed", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Hex.ZoomSpeed = 100", "description": "Speed of zooming", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 337 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Hex", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Input.ConsoleHistorySize", "family_id": "setting.client.Input.ConsoleHistorySize", "kind": "setting", "name": "Input.ConsoleHistorySize", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Input.ConsoleHistorySize = 100", "description": "Console history size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 359 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Input", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Input.DisableGamepad", "family_id": "setting.client.Input.DisableGamepad", "kind": "setting", "name": "Input.DisableGamepad", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Input.DisableGamepad = false", "description": "If true, gamepad support is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 359 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Input", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.ParticlePreviewEffect", "family_id": "setting.client.Mapper.ParticlePreviewEffect", "kind": "setting", "name": "Mapper.ParticlePreviewEffect", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Mapper.ParticlePreviewEffect = ", "description": "Particle resource to preview after opening the start map", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.ParticlePreviewPrewarm", "family_id": "setting.client.Mapper.ParticlePreviewPrewarm", "kind": "setting", "name": "Mapper.ParticlePreviewPrewarm", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Mapper.ParticlePreviewPrewarm = false", "description": "If true, prewarm the startup particle preview", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.ParticlePreviewScale", "family_id": "setting.client.Mapper.ParticlePreviewScale", "kind": "setting", "name": "Mapper.ParticlePreviewScale", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "float32 Mapper.ParticlePreviewScale = 1.0f", "description": "Scale for the startup particle preview", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1.0f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.ParticlePreviewSeed", "family_id": "setting.client.Mapper.ParticlePreviewSeed", "kind": "setting", "name": "Mapper.ParticlePreviewSeed", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Mapper.ParticlePreviewSeed = 0", "description": "Seed used when the selected runtime supports seeded startup preview", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.StartHexX", "family_id": "setting.client.Mapper.StartHexX", "kind": "setting", "name": "Mapper.StartHexX", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Mapper.StartHexX = -1", "description": "Start hex X coordinate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "-1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.StartHexY", "family_id": "setting.client.Mapper.StartHexY", "kind": "setting", "name": "Mapper.StartHexY", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Mapper.StartHexY = -1", "description": "Start hex Y coordinate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "-1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Mapper.StartMap", "family_id": "setting.client.Mapper.StartMap", "kind": "setting", "name": "Mapper.StartMap", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Mapper.StartMap = ", "description": "Start map name", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 365 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Mapper", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.DisableFog", "family_id": "setting.client.View.DisableFog", "kind": "setting", "name": "View.DisableFog", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool View.DisableFog", "description": "Disables fog for more performance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.DisableIndoorMask", "family_id": "setting.client.View.DisableIndoorMask", "kind": "setting", "name": "View.DisableIndoorMask", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool View.DisableIndoorMask = false", "description": "If true, MapView skips the _rtIndoorMask render pass (saves a sprite-draw + RT swap per frame). Use for projects without weather, or to debug-see weather through hidden roofs.", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.DisableLighting", "family_id": "setting.client.View.DisableLighting", "kind": "setting", "name": "View.DisableLighting", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool View.DisableLighting", "description": "Disables lighting for more performance", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.FadingDuration", "family_id": "setting.client.View.FadingDuration", "kind": "setting", "name": "View.FadingDuration", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 View.FadingDuration = 1000", "description": "Fading duration in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.GlobalDayColor", "family_id": "setting.client.View.GlobalDayColor", "kind": "setting", "name": "View.GlobalDayColor", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "uint8[] View.GlobalDayColor = 18, 128, 103, 51, 18, 128, 95, 40, 53, 128, 86, 29", "description": "Project-wide default DayColor (12 bytes, channel-major: R0..R3 G0..G3 B0..B3); maps may override per-map via Map.DayColor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "uint8[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "18", "128", "103", "51", "18", "128", "95", "40", "53", "128", "86", "29" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.GlobalDayColorTime", "family_id": "setting.client.View.GlobalDayColorTime", "kind": "setting", "name": "View.GlobalDayColorTime", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32[] View.GlobalDayColorTime = 300, 600, 1140, 1380", "description": "Project-wide default DayColorTime in minutes (4 keys); maps may override per-map via Map.DayColorTime", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "int32[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "300", "600", "1140", "1380" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.HideNativeCursor", "family_id": "setting.client.View.HideNativeCursor", "kind": "setting", "name": "View.HideNativeCursor", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool View.HideNativeCursor = false", "description": "If true, native cursor is hidden", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.MapDirectDraw", "family_id": "setting.client.View.MapDirectDraw", "kind": "setting", "name": "View.MapDirectDraw", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool View.MapDirectDraw", "description": "Draw map directly to main framebuffer (speed up rendering but disables zooming and make scrolling jumpy)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.MapRenderTargetScale", "family_id": "setting.client.View.MapRenderTargetScale", "kind": "setting", "name": "View.MapRenderTargetScale", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "float32 View.MapRenderTargetScale = 1.0f", "description": "Fixed map/light/indoor-mask render-target scale relative to the logical screen; clamped to the device texture limit", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1.0f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.MapZoomEnabled", "family_id": "setting.client.View.MapZoomEnabled", "kind": "setting", "name": "View.MapZoomEnabled", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool View.MapZoomEnabled", "description": "Map view zooming", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.MonitorHeight", "family_id": "setting.client.View.MonitorHeight", "kind": "setting", "name": "View.MonitorHeight", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 View.MonitorHeight", "description": "Monitor height (read only)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.MonitorWidth", "family_id": "setting.client.View.MonitorWidth", "kind": "setting", "name": "View.MonitorWidth", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 View.MonitorWidth", "description": "Monitor width (read only)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.ScreenHeight", "family_id": "setting.client.View.ScreenHeight", "kind": "setting", "name": "View.ScreenHeight", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 View.ScreenHeight = 768", "description": "Screen height in pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "768" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.View.ScreenWidth", "family_id": "setting.client.View.ScreenWidth", "kind": "setting", "name": "View.ScreenWidth", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 View.ScreenWidth = 1024", "description": "Screen width in pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 160 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "View", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1024" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.AspectFactor", "family_id": "setting.client.Web.AspectFactor", "kind": "setting", "name": "Web.AspectFactor", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "float32 Web.AspectFactor = 0.75f", "description": "Web canvas height-to-width factor, width = height / factor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.75f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.AutoResize", "family_id": "setting.client.Web.AutoResize", "kind": "setting", "name": "Web.AutoResize", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "bool Web.AutoResize = true", "description": "If true, web screen resolution is recalculated on browser window resize", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.BackgroundColor", "family_id": "setting.client.Web.BackgroundColor", "kind": "setting", "name": "Web.BackgroundColor", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Web.BackgroundColor = rgb(0, 0, 0", "description": "Background color for the web page around the game screen", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "rgb(0", "0", "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.HorizontalPosFactor", "family_id": "setting.client.Web.HorizontalPosFactor", "kind": "setting", "name": "Web.HorizontalPosFactor", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "float32 Web.HorizontalPosFactor = 0.5f", "description": "Horizontal position factor in free page width, 0 = left, 0.5 = center, 1 = right", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.5f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.LoadingImage", "family_id": "setting.client.Web.LoadingImage", "kind": "setting", "name": "Web.LoadingImage", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "string Web.LoadingImage = ", "description": "Loading image path for web page, relative to main fomain file", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.MaxHeight", "family_id": "setting.client.Web.MaxHeight", "kind": "setting", "name": "Web.MaxHeight", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Web.MaxHeight = 1080", "description": "Maximum adaptive web height in pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1080" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.MaxWidth", "family_id": "setting.client.Web.MaxWidth", "kind": "setting", "name": "Web.MaxWidth", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Web.MaxWidth = 1920", "description": "Maximum adaptive web width in pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1920" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.MinHeight", "family_id": "setting.client.Web.MinHeight", "kind": "setting", "name": "Web.MinHeight", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Web.MinHeight = 768", "description": "Minimum adaptive web height in pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "768" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.MinWidth", "family_id": "setting.client.Web.MinWidth", "kind": "setting", "name": "Web.MinWidth", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Web.MinWidth = 1024", "description": "Minimum adaptive web width in pixels", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1024" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.ScreenHeightPercent", "family_id": "setting.client.Web.ScreenHeightPercent", "kind": "setting", "name": "Web.ScreenHeightPercent", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "int32 Web.ScreenHeightPercent = 75", "description": "Web canvas height as a percentage of page height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "75" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.client.Web.VerticalPosFactor", "family_id": "setting.client.Web.VerticalPosFactor", "kind": "setting", "name": "Web.VerticalPosFactor", "runtime_sides": [ "client", "mapper" ], "receiver": null, "signature": "float32 Web.VerticalPosFactor = 0.25f", "description": "Vertical position factor in free page height, 0 = top, 0.5 = center, 1 = bottom", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 256 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "client", "group": "Web", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.25f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.AngelScript.AttributedFunctionDirectCallAllowedNamespaces", "family_id": "setting.common.AngelScript.AttributedFunctionDirectCallAllowedNamespaces", "kind": "setting", "name": "AngelScript.AttributedFunctionDirectCallAllowedNamespaces", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] AngelScript.AttributedFunctionDirectCallAllowedNamespaces", "description": "AngelScript namespaces (matched as prefixes) whose functions may call attributed functions ([[Event]], [[TimeEvent]], etc.) directly instead of going through the runtime dispatcher", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "AngelScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.AngelScript.DebuggerBindHost", "family_id": "setting.common.AngelScript.DebuggerBindHost", "kind": "setting", "name": "AngelScript.DebuggerBindHost", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string AngelScript.DebuggerBindHost = 127.0.0.1", "description": "AngelScript debugger TCP bind host", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "AngelScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "127.0.0.1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.AngelScript.DebuggerEnabled", "family_id": "setting.common.AngelScript.DebuggerEnabled", "kind": "setting", "name": "AngelScript.DebuggerEnabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool AngelScript.DebuggerEnabled = false", "description": "If true, AngelScript debugger endpoint is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "AngelScript", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.AngelScript.ExtraDirectCallBlockingAttributes", "family_id": "setting.common.AngelScript.ExtraDirectCallBlockingAttributes", "kind": "setting", "name": "AngelScript.ExtraDirectCallBlockingAttributes", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] AngelScript.ExtraDirectCallBlockingAttributes", "description": "Project-defined attribute names that should also block direct AngelScript-to-AngelScript calls in addition to the engine's built-in dispatcher-bound list", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "AngelScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.AngelScript.MutableGlobalsAllowedNamespaces", "family_id": "setting.common.AngelScript.MutableGlobalsAllowedNamespaces", "kind": "setting", "name": "AngelScript.MutableGlobalsAllowedNamespaces", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] AngelScript.MutableGlobalsAllowedNamespaces", "description": "AngelScript namespaces (matched as prefixes) whose module-level globals may be mutable (everywhere else const-only)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "AngelScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.AngelScript.OverrunReportTime", "family_id": "setting.common.AngelScript.OverrunReportTime", "kind": "setting", "name": "AngelScript.OverrunReportTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 AngelScript.OverrunReportTime", "description": "Time in milliseconds to report AngelScript execution or entity-lock wait overrun, 0 to disable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 51 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "AngelScript", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.AllowRepeatedProtoParents", "family_id": "setting.common.Baking.AllowRepeatedProtoParents", "kind": "setting", "name": "Baking.AllowRepeatedProtoParents", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.AllowRepeatedProtoParents = true", "description": "If false, a prototype reaching one ancestor through several $Parent entries fails baking; when allowed, a repeated ancestor contributes its fields only where it is first reached", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.AudioVorbisQuality", "family_id": "setting.common.Baking.AudioVorbisQuality", "kind": "setting", "name": "Baking.AudioVorbisQuality", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Baking.AudioVorbisQuality = 0.5f", "description": "Vorbis VBR quality audio baking encodes with, from -0.1 (smallest) to 1.0 (largest)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.5f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.BakeLanguages", "family_id": "setting.common.Baking.BakeLanguages", "kind": "setting", "name": "Baking.BakeLanguages", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Baking.BakeLanguages = engl", "description": "Bake languages", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "engl" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.BakeOutput", "family_id": "setting.common.Baking.BakeOutput", "kind": "setting", "name": "Baking.BakeOutput", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Baking.BakeOutput = Baking", "description": "Bake output directory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Baking" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.BootstrapGameSettings", "family_id": "setting.common.Baking.BootstrapGameSettings", "kind": "setting", "name": "Baking.BootstrapGameSettings", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Baking.BootstrapGameSettings", "description": "Game settings an embedding project consumes before metadata is available (ApplicationInitHook and earlier); written to the binary config in full instead of as a sub-config delta", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.BundleCompressLevel", "family_id": "setting.common.Baking.BundleCompressLevel", "kind": "setting", "name": "Baking.BundleCompressLevel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Baking.BundleCompressLevel = 1", "description": "Compression level of the distribution bundles and the executable's Embedded resource pack, on the zlib scale whatever the codec: 0 stores, 9 is the strongest", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.CacheResources", "family_id": "setting.common.Baking.CacheResources", "kind": "setting", "name": "Baking.CacheResources", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Baking.CacheResources = Cache", "description": "Cache resources directory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Cache" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ClientResources", "family_id": "setting.common.Baking.ClientResources", "kind": "setting", "name": "Baking.ClientResources", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Baking.ClientResources = Resources", "description": "Client resources directory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Resources" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.Direct3DLevel9Shaders", "family_id": "setting.common.Baking.Direct3DLevel9Shaders", "kind": "setting", "name": "Baking.Direct3DLevel9Shaders", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.Direct3DLevel9Shaders = false", "description": "If true, Direct3D effects other than model ones also carry level 9.3 code and a build without 3D accepts feature level 9.3 devices; an effect that does not fit level 9.3 fails the bake", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ForceBaking", "family_id": "setting.common.Baking.ForceBaking", "kind": "setting", "name": "Baking.ForceBaking", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.ForceBaking = false", "description": "If true, baking of all packs are forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.IgnoreInputDirs", "family_id": "setting.common.Baking.IgnoreInputDirs", "kind": "setting", "name": "Baking.IgnoreInputDirs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Baking.IgnoreInputDirs", "description": "Resource pack input directories left out of every pack, relative to the config declaring the pack; each must be an input of some pack", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.IgnoreMissingBakerWarning", "family_id": "setting.common.Baking.IgnoreMissingBakerWarning", "kind": "setting", "name": "Baking.IgnoreMissingBakerWarning", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.IgnoreMissingBakerWarning = false", "description": "If true, missing baker warning is suppressed when stale baked resources already exist", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ModelAttachmentMaxExtent", "family_id": "setting.common.Baking.ModelAttachmentMaxExtent", "kind": "setting", "name": "Baking.ModelAttachmentMaxExtent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Baking.ModelAttachmentMaxExtent = 50.0f", "description": "Largest world extent a directly attached model may reach; above it the export sits in a larger unit space and the client cannot build its sprite frame", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "50.0f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ModelAttachmentMinExtent", "family_id": "setting.common.Baking.ModelAttachmentMinExtent", "kind": "setting", "name": "Baking.ModelAttachmentMinExtent", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Baking.ModelAttachmentMinExtent = 0.01f", "description": "Smallest world extent a directly attached model may reach; below it the export sits in a smaller unit space than the engine", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.01f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.PlatformBinaries", "family_id": "setting.common.Baking.PlatformBinaries", "kind": "setting", "name": "Baking.PlatformBinaries", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Baking.PlatformBinaries = PlatformBinaries", "description": "Per-platform client runtime binaries directory served by the updater", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "PlatformBinaries" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.PrebakeOnStartup", "family_id": "setting.common.Baking.PrebakeOnStartup", "kind": "setting", "name": "Baking.PrebakeOnStartup", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.PrebakeOnStartup = true", "description": "If false, an unpackaged application starts on the resources already baked instead of running the baker first; for launching several processes from one freshly baked checkout", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.PreciseModelBounds", "family_id": "setting.common.Baking.PreciseModelBounds", "kind": "setting", "name": "Baking.PreciseModelBounds", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.PreciseModelBounds = false", "description": "If true, model bounds measure every skinned vertex; if false, per-bone envelope boxes produce a conservative superset far faster", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ProtoFileExtensions", "family_id": "setting.common.Baking.ProtoFileExtensions", "kind": "setting", "name": "Baking.ProtoFileExtensions", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Baking.ProtoFileExtensions = fopro", "description": "Authored proto container extensions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "fopro" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.RawCopyFileExtensions", "family_id": "setting.common.Baking.RawCopyFileExtensions", "kind": "setting", "name": "Baking.RawCopyFileExtensions", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Baking.RawCopyFileExtensions = fofnt, bmfc, fnt, ogv, json, ini", "description": "Raw copy file extensions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "fofnt", "bmfc", "fnt", "ogv", "json", "ini" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ResourcePackCompressLevel", "family_id": "setting.common.Baking.ResourcePackCompressLevel", "kind": "setting", "name": "Baking.ResourcePackCompressLevel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Baking.ResourcePackCompressLevel = 1", "description": "Compression level of the resource packs, on the zlib scale whatever the codec: 0 stores, 9 is the strongest", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ResourcePackMinCompressGain", "family_id": "setting.common.Baking.ResourcePackMinCompressGain", "kind": "setting", "name": "Baking.ResourcePackMinCompressGain", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Baking.ResourcePackMinCompressGain = 5", "description": "Percent a blob must give back before it is deflated rather than stored as it is", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "5" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.ServerResources", "family_id": "setting.common.Baking.ServerResources", "kind": "setting", "name": "Baking.ServerResources", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Baking.ServerResources = ServerResources", "description": "Server resources directory", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "ServerResources" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Baking.SingleThreadBaking", "family_id": "setting.common.Baking.SingleThreadBaking", "kind": "setting", "name": "Baking.SingleThreadBaking", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Baking.SingleThreadBaking = false", "description": "If true, single-threaded baking is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 298 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Baking", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.AsyncLogWrite", "family_id": "setting.common.Common.AsyncLogWrite", "kind": "setting", "name": "Common.AsyncLogWrite", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Common.AsyncLogWrite = false", "description": "If true, log messages are written to file and console from a dedicated background thread", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.GameName", "family_id": "setting.common.Common.GameName", "kind": "setting", "name": "Common.GameName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Common.GameName = FOnline", "description": "Game name, used in logs and window title", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "FOnline" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.GameVersion", "family_id": "setting.common.Common.GameVersion", "kind": "setting", "name": "Common.GameVersion", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Common.GameVersion = 0.0.0", "description": "Game version, used in logs and window title", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.0.0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.Packaged", "family_id": "setting.common.Common.Packaged", "kind": "setting", "name": "Common.Packaged", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Common.Packaged", "description": "If yes, then the packaging was done (read only)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.SecretSettingTokens", "family_id": "setting.common.Common.SecretSettingTokens", "kind": "setting", "name": "Common.SecretSettingTokens", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Common.SecretSettingTokens = secret, token, password, apikey", "description": "Case-insensitive substrings that mark a setting name as a credential whose value is masked as \"***\" in command-line override logs", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "secret", "token", "password", "apikey" ], "command_line_redacted_by_default": true, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.UnpackagedSubConfig", "family_id": "setting.common.Common.UnpackagedSubConfig", "kind": "setting", "name": "Common.UnpackagedSubConfig", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Common.UnpackagedSubConfig", "description": "Config applied in unpackaged builds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Common.UserWritablePath", "family_id": "setting.common.Common.UserWritablePath", "kind": "setting", "name": "Common.UserWritablePath", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Common.UserWritablePath", "description": "Read only. Writable data root for everything written at runtime - log, cache, resource overlay, self-updated binaries, server database. Resolved at startup before anything is read from disk and therefore NOT settable from a config file: the command line names it, otherwise an INSTALLED marker beside the executable selects the per-OS user data dir plus the project name (Windows %LOCALAPPDATA% else %APPDATA%; macOS/iOS ~/Library/Application Support; Linux/Android $XDG_DATA_HOME else ~/.local/share), and without a marker everything stays relative to the working directory. Read-only base resources stay where they are with this dir layered on top", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 40 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Common", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.CritterBlockHex", "family_id": "setting.common.Geometry.CritterBlockHex", "kind": "setting", "name": "Geometry.CritterBlockHex", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Geometry.CritterBlockHex = false", "description": "If true, critters block hexes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapCameraAngle", "family_id": "setting.common.Geometry.MapCameraAngle", "kind": "setting", "name": "Geometry.MapCameraAngle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Geometry.MapCameraAngle = 25.6589f", "description": "Angle for critters moving/rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "25.6589f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapDataPrefix", "family_id": "setting.common.Geometry.MapDataPrefix", "kind": "setting", "name": "Geometry.MapDataPrefix", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Geometry.MapDataPrefix = Geometry", "description": "Path and prefix for names used for geometry sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Geometry" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapFreeMovement", "family_id": "setting.common.Geometry.MapFreeMovement", "kind": "setting", "name": "Geometry.MapFreeMovement", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Geometry.MapFreeMovement = false", "description": "If true, free movement on the map is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapHexHeight", "family_id": "setting.common.Geometry.MapHexHeight", "kind": "setting", "name": "Geometry.MapHexHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.MapHexHeight = 16", "description": "Hex/square height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "16" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapHexLineHeight", "family_id": "setting.common.Geometry.MapHexLineHeight", "kind": "setting", "name": "Geometry.MapHexLineHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.MapHexLineHeight = 12", "description": "Hex/square line height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "12" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapHexWidth", "family_id": "setting.common.Geometry.MapHexWidth", "kind": "setting", "name": "Geometry.MapHexWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.MapHexWidth = 32", "description": "Hex/square width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "32" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapRoofElevation", "family_id": "setting.common.Geometry.MapRoofElevation", "kind": "setting", "name": "Geometry.MapRoofElevation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.MapRoofElevation = 98", "description": "Roof tile 3D elevation, applied to every roof tile (a roof is just a tile lifted in 3D so it draws above the walls). Replaces the old 2D MapRoofOffs* raise; the flat tile/roof XY offset now lives on the BaseTile prototype Offset", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "98" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapSmoothPath", "family_id": "setting.common.Geometry.MapSmoothPath", "kind": "setting", "name": "Geometry.MapSmoothPath", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Geometry.MapSmoothPath = true", "description": "Enable pathfinding path smoothing", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MapTileStep", "family_id": "setting.common.Geometry.MapTileStep", "kind": "setting", "name": "Geometry.MapTileStep", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.MapTileStep = 2", "description": "Tile step value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "2" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.MaxPathFindLength", "family_id": "setting.common.Geometry.MaxPathFindLength", "kind": "setting", "name": "Geometry.MaxPathFindLength", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.MaxPathFindLength = 400", "description": "Maximum pathfinding length", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "400" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.PathFindCritterDetour", "family_id": "setting.common.Geometry.PathFindCritterDetour", "kind": "setting", "name": "Geometry.PathFindCritterDetour", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.PathFindCritterDetour = 12", "description": "Hexes of detour a path search trades for walking through one living critter", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "12" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Geometry.PathFindEnclosureProbe", "family_id": "setting.common.Geometry.PathFindEnclosureProbe", "kind": "setting", "name": "Geometry.PathFindEnclosureProbe", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Geometry.PathFindEnclosureProbe = 1024", "description": "Hexes a path search may flood back from its target to prove it walled off, 0 to disable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 178 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Geometry", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1024" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.AdditionalFiles", "family_id": "setting.common.ManagedScript.AdditionalFiles", "kind": "setting", "name": "ManagedScript.AdditionalFiles", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.AdditionalFiles", "description": "Analyzer configuration file paths passed to the script compilation as AdditionalFiles", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.AnalysisLevel", "family_id": "setting.common.ManagedScript.AnalysisLevel", "kind": "setting", "name": "ManagedScript.AnalysisLevel", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.AnalysisLevel", "description": "Analysis level of the generated managed project, empty keeps the SDK default", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.AnalysisMode", "family_id": "setting.common.ManagedScript.AnalysisMode", "kind": "setting", "name": "ManagedScript.AnalysisMode", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.AnalysisMode", "description": "Analysis mode of the generated managed project, empty keeps the SDK default", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.AnalyzerPackages", "family_id": "setting.common.ManagedScript.AnalyzerPackages", "kind": "setting", "name": "ManagedScript.AnalyzerPackages", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.AnalyzerPackages", "description": "Roslyn analyzer NuGet packages as 'name,version' entries, version is mandatory and must be exact", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.Analyzers", "family_id": "setting.common.ManagedScript.Analyzers", "kind": "setting", "name": "ManagedScript.Analyzers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.Analyzers", "description": "Roslyn analyzer project paths referenced by the generated managed project, so their diagnostics run in the script build", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.Assemblies", "family_id": "setting.common.ManagedScript.Assemblies", "kind": "setting", "name": "ManagedScript.Assemblies", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.Assemblies = FOnline", "description": "Managed script assemblies to build", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "FOnline" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.BakerDryRun", "family_id": "setting.common.ManagedScript.BakerDryRun", "kind": "setting", "name": "ManagedScript.BakerDryRun", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool ManagedScript.BakerDryRun = false", "description": "If true, managed baker writes stub markers instead of compiling assemblies", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.ClientPatchesEnabled", "family_id": "setting.common.ManagedScript.ClientPatchesEnabled", "kind": "setting", "name": "ManagedScript.ClientPatchesEnabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool ManagedScript.ClientPatchesEnabled = false", "description": "If true, a client applies the script patches its server sends; each client reads its own config", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.DeepTrackEntityWrappers", "family_id": "setting.common.ManagedScript.DeepTrackEntityWrappers", "kind": "setting", "name": "ManagedScript.DeepTrackEntityWrappers", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool ManagedScript.DeepTrackEntityWrappers = false", "description": "If true, every managed entity wrapper is also tracked weakly so shutdown can name the wrappers that still hold a native entity reference; costs a dictionary write per wrapper, while the live wrapper count shutdown reports is always kept", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.Dirs", "family_id": "setting.common.ManagedScript.Dirs", "kind": "setting", "name": "ManagedScript.Dirs", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.Dirs = Engine/Source/Scripting/Managed/CoreScripts, Scripts", "description": "Managed script source directories, top-level .cs files of each are compiled in place", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Engine/Source/Scripting/Managed/CoreScripts", "Scripts" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.ExtraReferences", "family_id": "setting.common.ManagedScript.ExtraReferences", "kind": "setting", "name": "ManagedScript.ExtraReferences", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.ExtraReferences", "description": "Extra managed assembly references as 'assembly,target,reference' entries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.ExtraSources", "family_id": "setting.common.ManagedScript.ExtraSources", "kind": "setting", "name": "ManagedScript.ExtraSources", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] ManagedScript.ExtraSources", "description": "Extra managed source files as 'assembly,target,path' entries", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.GeneratedDir", "family_id": "setting.common.ManagedScript.GeneratedDir", "kind": "setting", "name": "ManagedScript.GeneratedDir", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.GeneratedDir", "description": "Directory for generated managed scripts and project files (empty targets the build GeneratedSource/Managed directory)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.InteropProbeOnStart", "family_id": "setting.common.ManagedScript.InteropProbeOnStart", "kind": "setting", "name": "ManagedScript.InteropProbeOnStart", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool ManagedScript.InteropProbeOnStart = false", "description": "If true, every native-to-managed transport the runtime can use is checked once scripts start, one INTEROP-TRANSPORT log line per check; qualifies a client no test suite runs on, such as a browser or a device", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.MsBuild", "family_id": "setting.common.ManagedScript.MsBuild", "kind": "setting", "name": "ManagedScript.MsBuild", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.MsBuild = dotnet msbuild", "description": "Managed msbuild command", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "dotnet msbuild" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.OverrunReportTime", "family_id": "setting.common.ManagedScript.OverrunReportTime", "kind": "setting", "name": "ManagedScript.OverrunReportTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 ManagedScript.OverrunReportTime", "description": "Time in milliseconds to report managed script execution or entity-lock wait overrun, 0 to disable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.PatchPointWeaver", "family_id": "setting.common.ManagedScript.PatchPointWeaver", "kind": "setting", "name": "ManagedScript.PatchPointWeaver", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.PatchPointWeaver", "description": "Patch point weaver project path; when set, the script build gives every eligible script method a patch point, so a running process can replace its body (ScriptPatches)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.ProjectName", "family_id": "setting.common.ManagedScript.ProjectName", "kind": "setting", "name": "ManagedScript.ProjectName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.ProjectName = FOnline", "description": "Managed project base name", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "FOnline" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.ServerPatchesEnabled", "family_id": "setting.common.ManagedScript.ServerPatchesEnabled", "kind": "setting", "name": "ManagedScript.ServerPatchesEnabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool ManagedScript.ServerPatchesEnabled = false", "description": "If true, the server applies script patches (ScriptPatches.Apply); the woven patch points cost the same either way", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.ManagedScript.TargetFramework", "family_id": "setting.common.ManagedScript.TargetFramework", "kind": "setting", "name": "ManagedScript.TargetFramework", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string ManagedScript.TargetFramework = net10.0", "description": "Managed project target framework", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 61 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "ManagedScript", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "net10.0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.ArtificalLags", "family_id": "setting.common.Network.ArtificalLags", "kind": "setting", "name": "Network.ArtificalLags", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.ArtificalLags = 0", "description": "Artificial lags in milliseconds, applied to both directions", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.ArtificalLagsJitter", "family_id": "setting.common.Network.ArtificalLagsJitter", "kind": "setting", "name": "Network.ArtificalLagsJitter", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.ArtificalLagsJitter = 0", "description": "Extra per-batch random delay in milliseconds on top of the artificial lag, emulating stalls", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.CompatibilityVersion", "family_id": "setting.common.Network.CompatibilityVersion", "kind": "setting", "name": "Network.CompatibilityVersion", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Network.CompatibilityVersion", "description": "Compatibility version (read only)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.DisableInterthreadCommunication", "family_id": "setting.common.Network.DisableInterthreadCommunication", "kind": "setting", "name": "Network.DisableInterthreadCommunication", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Network.DisableInterthreadCommunication = false", "description": "If true, server does not register the in-process interthread listener; clients in the same process fall through to TCP/UDP", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.DisableTcpNagle", "family_id": "setting.common.Network.DisableTcpNagle", "kind": "setting", "name": "Network.DisableTcpNagle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Network.DisableTcpNagle = true", "description": "If true, TCP Nagle algorithm is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.DisableZlibCompression", "family_id": "setting.common.Network.DisableZlibCompression", "kind": "setting", "name": "Network.DisableZlibCompression", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Network.DisableZlibCompression = false", "description": "If true, Zlib compression is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.ForceCompatibilityVersion", "family_id": "setting.common.Network.ForceCompatibilityVersion", "kind": "setting", "name": "Network.ForceCompatibilityVersion", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Network.ForceCompatibilityVersion = ", "description": "Custom compatability version", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.ForceMetadataVersion", "family_id": "setting.common.Network.ForceMetadataVersion", "kind": "setting", "name": "Network.ForceMetadataVersion", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Network.ForceMetadataVersion = ", "description": "Custom metadata version, for simulating a client baked apart from the server", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.MoveSyncTrace", "family_id": "setting.common.Network.MoveSyncTrace", "kind": "setting", "name": "Network.MoveSyncTrace", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Network.MoveSyncTrace = false", "description": "If true, server and client write one MOVESYNC log line per movement synchronization event, as stable key=value fields for offline analysis; too verbose for production", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.NetBufferSize", "family_id": "setting.common.Network.NetBufferSize", "kind": "setting", "name": "Network.NetBufferSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.NetBufferSize = 4096", "description": "Network buffer size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4096" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.SecuredWebSockets", "family_id": "setting.common.Network.SecuredWebSockets", "kind": "setting", "name": "Network.SecuredWebSockets", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Network.SecuredWebSockets = false", "description": "If true, secured WebSockets are enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.ServerPort", "family_id": "setting.common.Network.ServerPort", "kind": "setting", "name": "Network.ServerPort", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.ServerPort = 4000", "description": "Server port number", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpConnectRetry", "family_id": "setting.common.Network.UdpConnectRetry", "kind": "setting", "name": "Network.UdpConnectRetry", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpConnectRetry = 500", "description": "UDP connect retry timeout in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "500" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpConnectTimeout", "family_id": "setting.common.Network.UdpConnectTimeout", "kind": "setting", "name": "Network.UdpConnectTimeout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpConnectTimeout = 4000", "description": "UDP connect timeout in milliseconds before failing transport bootstrap", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpPacketSize", "family_id": "setting.common.Network.UdpPacketSize", "kind": "setting", "name": "Network.UdpPacketSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpPacketSize = 1200", "description": "Target UDP payload budget in bytes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1200" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpPortOffset", "family_id": "setting.common.Network.UdpPortOffset", "kind": "setting", "name": "Network.UdpPortOffset", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpPortOffset = 0", "description": "UDP port offset relative to ServerPort", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpRedundancy", "family_id": "setting.common.Network.UdpRedundancy", "kind": "setting", "name": "Network.UdpRedundancy", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpRedundancy = 1", "description": "Number of previous UDP packets redundantly resent with new data", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpResendTimeout", "family_id": "setting.common.Network.UdpResendTimeout", "kind": "setting", "name": "Network.UdpResendTimeout", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpResendTimeout = 150", "description": "UDP packet resend timeout in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "150" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpSendUpdateInterval", "family_id": "setting.common.Network.UdpSendUpdateInterval", "kind": "setting", "name": "Network.UdpSendUpdateInterval", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpSendUpdateInterval = 16", "description": "UDP send tick interval in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "16" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UdpWindowSize", "family_id": "setting.common.Network.UdpWindowSize", "kind": "setting", "name": "Network.UdpWindowSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UdpWindowSize = 65536", "description": "Reliable UDP send window size in bytes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "65536" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.UpdateFileMaxPortionSize", "family_id": "setting.common.Network.UpdateFileMaxPortionSize", "kind": "setting", "name": "Network.UpdateFileMaxPortionSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.UpdateFileMaxPortionSize = 1000000", "description": "Maximum update file portion size in bytes", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1000000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Network.WebSocketPort", "family_id": "setting.common.Network.WebSocketPort", "kind": "setting", "name": "Network.WebSocketPort", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Network.WebSocketPort = 4001", "description": "WebSockets port for server listen and client connect", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 85 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Network", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4001" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.AllowSoftwareRenderer", "family_id": "setting.common.Render.AllowSoftwareRenderer", "kind": "setting", "name": "Render.AllowSoftwareRenderer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.AllowSoftwareRenderer = false", "description": "If true, a software rasterizer may stand in when no hardware device is available", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.AlwaysOnTop", "family_id": "setting.common.Render.AlwaysOnTop", "kind": "setting", "name": "Render.AlwaysOnTop", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.AlwaysOnTop = false", "description": "If true, window is always on top", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.Animation3dFPS", "family_id": "setting.common.Render.Animation3dFPS", "kind": "setting", "name": "Render.Animation3dFPS", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.Animation3dFPS = 30", "description": "3D animation frames per second", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "30" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.Animation3dSmoothTime", "family_id": "setting.common.Render.Animation3dSmoothTime", "kind": "setting", "name": "Render.Animation3dSmoothTime", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.Animation3dSmoothTime = 150", "description": "3D animation smooth time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "150" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.AtlasLinearFiltration", "family_id": "setting.common.Render.AtlasLinearFiltration", "kind": "setting", "name": "Render.AtlasLinearFiltration", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.AtlasLinearFiltration = false", "description": "If true, atlas linear filtration is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.Brightness", "family_id": "setting.common.Render.Brightness", "kind": "setting", "name": "Render.Brightness", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.Brightness = 0", "description": "Brightness value", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.CritterBodyTurnFactor", "family_id": "setting.common.Render.CritterBodyTurnFactor", "kind": "setting", "name": "Render.CritterBodyTurnFactor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Render.CritterBodyTurnFactor = 0.6f", "description": "Critter body turn factor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.6f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.CritterHeadTurnFactor", "family_id": "setting.common.Render.CritterHeadTurnFactor", "kind": "setting", "name": "Render.CritterHeadTurnFactor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Render.CritterHeadTurnFactor = 0.4f", "description": "Critter head turn factor", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.4f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.CritterStubSpriteName", "family_id": "setting.common.Render.CritterStubSpriteName", "kind": "setting", "name": "Render.CritterStubSpriteName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Render.CritterStubSpriteName = ", "description": "Fallback critter sprite, empty value uses built-in runtime dummy sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.CritterTurnAngle", "family_id": "setting.common.Render.CritterTurnAngle", "kind": "setting", "name": "Render.CritterTurnAngle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Render.CritterTurnAngle = 100.0f", "description": "Critter turn angle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100.0f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.DefaultParticleDrawHeight", "family_id": "setting.common.Render.DefaultParticleDrawHeight", "kind": "setting", "name": "Render.DefaultParticleDrawHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.DefaultParticleDrawHeight = 128", "description": "Default particle draw height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "128" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.DefaultParticleDrawWidth", "family_id": "setting.common.Render.DefaultParticleDrawWidth", "kind": "setting", "name": "Render.DefaultParticleDrawWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.DefaultParticleDrawWidth = 128", "description": "Default particle draw width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "128" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.DrawWireframe", "family_id": "setting.common.Render.DrawWireframe", "kind": "setting", "name": "Render.DrawWireframe", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.DrawWireframe = false", "description": "If true, rendered sprite and particle triangle edges are overlaid for geometry debugging", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.EggEllipseHeightExt", "family_id": "setting.common.Render.EggEllipseHeightExt", "kind": "setting", "name": "Render.EggEllipseHeightExt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.EggEllipseHeightExt = 0", "description": "Transparency egg ellipse extra height in pixels added to logical sprite/view height", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.EggEllipseWidthExt", "family_id": "setting.common.Render.EggEllipseWidthExt", "kind": "setting", "name": "Render.EggEllipseWidthExt", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.EggEllipseWidthExt = 0", "description": "Transparency egg ellipse extra width in pixels added to logical sprite/view width", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.EggTransparencyTransitionFactor", "family_id": "setting.common.Render.EggTransparencyTransitionFactor", "kind": "setting", "name": "Render.EggTransparencyTransitionFactor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Render.EggTransparencyTransitionFactor = 0.9f", "description": "Fraction of egg mask kept fully transparent before linear fade to opaque", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0.9f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.FixedFPS", "family_id": "setting.common.Render.FixedFPS", "kind": "setting", "name": "Render.FixedFPS", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.FixedFPS = 100", "description": "Frame rate cap, takes precedence over Sleep (0 to disable)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ForceDirect3D", "family_id": "setting.common.Render.ForceDirect3D", "kind": "setting", "name": "Render.ForceDirect3D", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ForceDirect3D = false", "description": "If true, Direct3D is forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ForceGlslEsProfile", "family_id": "setting.common.Render.ForceGlslEsProfile", "kind": "setting", "name": "Render.ForceGlslEsProfile", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ForceGlslEsProfile = false", "description": "If true, GLSL ES profile is forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ForceMetal", "family_id": "setting.common.Render.ForceMetal", "kind": "setting", "name": "Render.ForceMetal", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ForceMetal = false", "description": "If true, Metal is forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ForceOpenGL", "family_id": "setting.common.Render.ForceOpenGL", "kind": "setting", "name": "Render.ForceOpenGL", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ForceOpenGL = false", "description": "If true, OpenGL is forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ForceSDLGpu", "family_id": "setting.common.Render.ForceSDLGpu", "kind": "setting", "name": "Render.ForceSDLGpu", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ForceSDLGpu = false", "description": "If true, SDL_GPU backend is forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ForceVulkan", "family_id": "setting.common.Render.ForceVulkan", "kind": "setting", "name": "Render.ForceVulkan", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ForceVulkan = false", "description": "If true, Vulkan is forced", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.Fullscreen", "family_id": "setting.common.Render.Fullscreen", "kind": "setting", "name": "Render.Fullscreen", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.Fullscreen = false", "description": "If true, fullscreen mode is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.HeadBone", "family_id": "setting.common.Render.HeadBone", "kind": "setting", "name": "Render.HeadBone", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Render.HeadBone", "description": "Head bone name (Todo: move HeadBone to fo3d settings)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.HeadlessWindow", "family_id": "setting.common.Render.HeadlessWindow", "kind": "setting", "name": "Render.HeadlessWindow", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.HeadlessWindow = false", "description": "If true, window is created hidden for off-screen rendering", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ImGuiColorStyle", "family_id": "setting.common.Render.ImGuiColorStyle", "kind": "setting", "name": "Render.ImGuiColorStyle", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Render.ImGuiColorStyle", "description": "ImGui theme: Light, Classic, Dark", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ImGuiDefaultEffect", "family_id": "setting.common.Render.ImGuiDefaultEffect", "kind": "setting", "name": "Render.ImGuiDefaultEffect", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Render.ImGuiDefaultEffect = Effects/ImGui_Default.fofx", "description": "Shader effect for ImGui", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Effects/ImGui_Default.fofx" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ImGuiFontTextureSize", "family_id": "setting.common.Render.ImGuiFontTextureSize", "kind": "setting", "name": "Render.ImGuiFontTextureSize", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.ImGuiFontTextureSize = 256", "description": "Minimum ImGui texture size", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "256" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ItemStubSpriteName", "family_id": "setting.common.Render.ItemStubSpriteName", "kind": "setting", "name": "Render.ItemStubSpriteName", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Render.ItemStubSpriteName = ", "description": "Fallback item sprite, empty value uses built-in runtime dummy sprite", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.LegBones", "family_id": "setting.common.Render.LegBones", "kind": "setting", "name": "Render.LegBones", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Render.LegBones", "description": "Leg bone names (Todo: move LegBones to fo3d settings)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.MapMaxElevation", "family_id": "setting.common.Render.MapMaxElevation", "kind": "setting", "name": "Render.MapMaxElevation", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.MapMaxElevation = 4096", "description": "Max abs sprite elevation (px) used to size the per-map scene depth range; smaller = more depth-buffer precision (less z-fighting), but sprites beyond it would be depth-clipped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4096" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ModelDirectDraw", "family_id": "setting.common.Render.ModelDirectDraw", "kind": "setting", "name": "Render.ModelDirectDraw", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.ModelDirectDraw = false", "description": "If true, map 3D models render directly into the scene depth buffer; otherwise they render as cached atlas sprites", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ModelLayerProperties", "family_id": "setting.common.Render.ModelLayerProperties", "kind": "setting", "name": "Render.ModelLayerProperties", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string[] Render.ModelLayerProperties", "description": "Critter properties feeding model layers, as \"=\" pairs; tools use them to dress a prototype the way the game does", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ModelProjFactor", "family_id": "setting.common.Render.ModelProjFactor", "kind": "setting", "name": "Render.ModelProjFactor", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 Render.ModelProjFactor = 40.0f", "description": "Screen px per 3D world unit (1 unit = 1 hex = 1 m); scales 3D models and in-scene particles", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "40.0f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ModelSpriteMaxTextureHeight", "family_id": "setting.common.Render.ModelSpriteMaxTextureHeight", "kind": "setting", "name": "Render.ModelSpriteMaxTextureHeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.ModelSpriteMaxTextureHeight = 2048", "description": "Max GPU scratch-texture height a 3D model sprite may allocate; larger envelopes clamp and draw cropped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "2048" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.ModelSpriteMaxTextureWidth", "family_id": "setting.common.Render.ModelSpriteMaxTextureWidth", "kind": "setting", "name": "Render.ModelSpriteMaxTextureWidth", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.ModelSpriteMaxTextureWidth = 2048", "description": "Max GPU scratch-texture width a 3D model sprite may allocate; larger envelopes clamp and draw cropped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "2048" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.NullRenderer", "family_id": "setting.common.Render.NullRenderer", "kind": "setting", "name": "Render.NullRenderer", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.NullRenderer = false", "description": "If true, null renderer is used", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.RecreateClientOnError", "family_id": "setting.common.Render.RecreateClientOnError", "kind": "setting", "name": "Render.RecreateClientOnError", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.RecreateClientOnError = false", "description": "If true, client is recreated on error", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.RenderDebug", "family_id": "setting.common.Render.RenderDebug", "kind": "setting", "name": "Render.RenderDebug", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.RenderDebug = false", "description": "If true, render debugging is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.RunAnimBaseSpeed", "family_id": "setting.common.Render.RunAnimBaseSpeed", "kind": "setting", "name": "Render.RunAnimBaseSpeed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.RunAnimBaseSpeed = 120", "description": "Run animation base speed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "120" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.RunAnimStartSpeed", "family_id": "setting.common.Render.RunAnimStartSpeed", "kind": "setting", "name": "Render.RunAnimStartSpeed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.RunAnimStartSpeed = 80", "description": "Run animation start speed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "80" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.SDLGpuDriver", "family_id": "setting.common.Render.SDLGpuDriver", "kind": "setting", "name": "Render.SDLGpuDriver", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "string Render.SDLGpuDriver = ", "description": "Preferred SDL_GPU driver name (vulkan / metal / direct3d12), empty lets SDL pick", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.Sleep", "family_id": "setting.common.Render.Sleep", "kind": "setting", "name": "Render.Sleep", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.Sleep = -1", "description": "Per-frame sleep in milliseconds when FixedFPS is 0 (0 yields, -1 to disable)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "-1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.SpriteHitValue", "family_id": "setting.common.Render.SpriteHitValue", "kind": "setting", "name": "Render.SpriteHitValue", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.SpriteHitValue = 127", "description": "If alpha is greather then hit test is passed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "127" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.VSync", "family_id": "setting.common.Render.VSync", "kind": "setting", "name": "Render.VSync", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.VSync = false", "description": "If true, vertical synchronization is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.WalkAnimBaseSpeed", "family_id": "setting.common.Render.WalkAnimBaseSpeed", "kind": "setting", "name": "Render.WalkAnimBaseSpeed", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Render.WalkAnimBaseSpeed = 60", "description": "Walk animation base speed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "60" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.WindowCentered", "family_id": "setting.common.Render.WindowCentered", "kind": "setting", "name": "Render.WindowCentered", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.WindowCentered = true", "description": "If true, window is centered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Render.WindowResizable", "family_id": "setting.common.Render.WindowResizable", "kind": "setting", "name": "Render.WindowResizable", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool Render.WindowResizable = false", "description": "If true, window is resizable", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 203 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Render", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.SpriteMesh.AlphaThreshold", "family_id": "setting.common.SpriteMesh.AlphaThreshold", "kind": "setting", "name": "SpriteMesh.AlphaThreshold", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 SpriteMesh.AlphaThreshold = 0", "description": "Minimum alpha excluded from sprite mesh geometry (0-254)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 195 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "SpriteMesh", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.SpriteMesh.AreaSavingsWeight", "family_id": "setting.common.SpriteMesh.AreaSavingsWeight", "kind": "setting", "name": "SpriteMesh.AreaSavingsWeight", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "float32 SpriteMesh.AreaSavingsWeight = 32.0f", "description": "Score awarded for removing a full frame area; one point offsets one submitted triangle", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 195 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "SpriteMesh", "type": "float32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "32.0f" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.SpriteMesh.Enabled", "family_id": "setting.common.SpriteMesh.Enabled", "kind": "setting", "name": "SpriteMesh.Enabled", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "bool SpriteMesh.Enabled = false", "description": "If true, polygonal sprite meshes are generated during image baking", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 195 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "SpriteMesh", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.SpriteMesh.MaxTriangles", "family_id": "setting.common.SpriteMesh.MaxTriangles", "kind": "setting", "name": "SpriteMesh.MaxTriangles", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 SpriteMesh.MaxTriangles = 4096", "description": "Maximum triangle budget searched across whole-sprite, per-component, and detailed mesh candidates", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 195 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "SpriteMesh", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4096" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.common.Timer.DeltaTimeCap", "family_id": "setting.common.Timer.DeltaTimeCap", "kind": "setting", "name": "Timer.DeltaTimeCap", "runtime_sides": [ "server", "client", "mapper" ], "receiver": null, "signature": "int32 Timer.DeltaTimeCap = 100", "description": "Frame delta time cap in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 293 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "common", "group": "Timer", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.CompileSdk", "family_id": "setting.server.Android.CompileSdk", "kind": "setting", "name": "Android.CompileSdk", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Android.CompileSdk = 35", "description": "Android compile SDK level for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "35" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.Icon", "family_id": "setting.server.Android.Icon", "kind": "setting", "name": "Android.Icon", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.Icon = Engine/Resources/Radiation.png", "description": "Android launcher icon PNG source path for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Engine/Resources/Radiation.png" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.KeyAlias", "family_id": "setting.server.Android.KeyAlias", "kind": "setting", "name": "Android.KeyAlias", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.KeyAlias = ", "description": "Android release signing key alias for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.KeyPassword", "family_id": "setting.server.Android.KeyPassword", "kind": "setting", "name": "Android.KeyPassword", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.KeyPassword = ", "description": "Android release signing key password for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": true, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.Keystore", "family_id": "setting.server.Android.Keystore", "kind": "setting", "name": "Android.Keystore", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.Keystore = ", "description": "Android release signing keystore path for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.KeystorePassword", "family_id": "setting.server.Android.KeystorePassword", "kind": "setting", "name": "Android.KeystorePassword", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.KeystorePassword = ", "description": "Android release signing keystore password for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": true, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.MinSdk", "family_id": "setting.server.Android.MinSdk", "kind": "setting", "name": "Android.MinSdk", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Android.MinSdk = 23", "description": "Android minimum supported SDK level for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "23" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.PackageName", "family_id": "setting.server.Android.PackageName", "kind": "setting", "name": "Android.PackageName", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.PackageName = com.fonline.app", "description": "Android application package name for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "com.fonline.app" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.ScreenOrientation", "family_id": "setting.server.Android.ScreenOrientation", "kind": "setting", "name": "Android.ScreenOrientation", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Android.ScreenOrientation = landscape", "description": "Android activity screen orientation for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "landscape" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.TargetSdk", "family_id": "setting.server.Android.TargetSdk", "kind": "setting", "name": "Android.TargetSdk", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Android.TargetSdk = 35", "description": "Android target SDK level for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "35" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Android.VersionCode", "family_id": "setting.server.Android.VersionCode", "kind": "setting", "name": "Android.VersionCode", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Android.VersionCode = 1", "description": "Android application version code for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 271 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Android", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Critter.CritterSlotEnabled", "family_id": "setting.server.Critter.CritterSlotEnabled", "kind": "setting", "name": "Critter.CritterSlotEnabled", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool[] Critter.CritterSlotEnabled = true, true", "description": "Critter slot enabled flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Critter", "type": "bool[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true", "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Critter.CritterSlotMultiItem", "family_id": "setting.server.Critter.CritterSlotMultiItem", "kind": "setting", "name": "Critter.CritterSlotMultiItem", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool[] Critter.CritterSlotMultiItem = true, false", "description": "Critter slot multi-item flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Critter", "type": "bool[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true", "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Critter.CritterSlotSendData", "family_id": "setting.server.Critter.CritterSlotSendData", "kind": "setting", "name": "Critter.CritterSlotSendData", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool[] Critter.CritterSlotSendData = false, true", "description": "Critter slot send data flags", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 325 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Critter", "type": "bool[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false", "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.CustomCollections", "family_id": "setting.server.DataBase.CustomCollections", "kind": "setting", "name": "DataBase.CustomCollections", "runtime_sides": [ "server" ], "receiver": null, "signature": "string[] DataBase.CustomCollections", "description": "Space-separated user-defined database collections in format CollectionName:Int or CollectionName:Str", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "string[]", "setting_kind": "read-only", "mutability": "read-only", "default_values": [], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.JsonIndent", "family_id": "setting.server.DataBase.JsonIndent", "kind": "setting", "name": "DataBase.JsonIndent", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 DataBase.JsonIndent = 4", "description": "JSON backend indentation, 0 for compact output", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.MongoEscapeChar", "family_id": "setting.server.DataBase.MongoEscapeChar", "kind": "setting", "name": "DataBase.MongoEscapeChar", "runtime_sides": [ "server" ], "receiver": null, "signature": "string DataBase.MongoEscapeChar = :", "description": "Single character used to replace dots in Mongo document keys", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ ":" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.OpLogEnabled", "family_id": "setting.server.DataBase.OpLogEnabled", "kind": "setting", "name": "DataBase.OpLogEnabled", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool DataBase.OpLogEnabled = true", "description": "If true, pending database changes are mirrored to oplog for recovery; if false, any database write failure causes immediate panic", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.OpLogPath", "family_id": "setting.server.DataBase.OpLogPath", "kind": "setting", "name": "DataBase.OpLogPath", "runtime_sides": [ "server" ], "receiver": null, "signature": "string DataBase.OpLogPath = DbPendingChanges.oplog", "description": "Pending database changes oplog path; committed replay progress path is derived as this value plus -committed", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "DbPendingChanges.oplog" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.PanicOpLogSizeThreshold", "family_id": "setting.server.DataBase.PanicOpLogSizeThreshold", "kind": "setting", "name": "DataBase.PanicOpLogSizeThreshold", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 DataBase.PanicOpLogSizeThreshold = 10000000", "description": "Pending database changes file size threshold in bytes after which panic is triggered", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "10000000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.PanicShutdownTimeout", "family_id": "setting.server.DataBase.PanicShutdownTimeout", "kind": "setting", "name": "DataBase.PanicShutdownTimeout", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 DataBase.PanicShutdownTimeout = 5000", "description": "Graceful shutdown timeout in milliseconds after database panic callback before forced termination", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "5000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.DataBase.ReconnectRetryPeriod", "family_id": "setting.server.DataBase.ReconnectRetryPeriod", "kind": "setting", "name": "DataBase.ReconnectRetryPeriod", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 DataBase.ReconnectRetryPeriod = 1000", "description": "Database backend retry period in milliseconds while oplog mode is active", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 347 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "DataBase", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Packaging.AppIcon", "family_id": "setting.server.Packaging.AppIcon", "kind": "setting", "name": "Packaging.AppIcon", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Packaging.AppIcon = ", "description": "Windows application ICO source path for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 286 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Packaging", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Packaging.CodeSigningHook", "family_id": "setting.server.Packaging.CodeSigningHook", "kind": "setting", "name": "Packaging.CodeSigningHook", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Packaging.CodeSigningHook = ", "description": "Windows code signing hook executable path for packaging tools", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 286 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Packaging", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Packaging.MsiUpgradeCode", "family_id": "setting.server.Packaging.MsiUpgradeCode", "kind": "setting", "name": "Packaging.MsiUpgradeCode", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Packaging.MsiUpgradeCode = ", "description": "Windows MSI installer upgrade GUID for packaging tools, must never change once an MSI has shipped", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 286 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Packaging", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.AutoStartClientOnServer", "family_id": "setting.server.Server.AutoStartClientOnServer", "kind": "setting", "name": "Server.AutoStartClientOnServer", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.AutoStartClientOnServer = 0", "description": "Number of embedded clients to auto-spawn on server startup; 0 disables the feature", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.CollapseLogOnStart", "family_id": "setting.server.Server.CollapseLogOnStart", "kind": "setting", "name": "Server.CollapseLogOnStart", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.CollapseLogOnStart = false", "description": "If true, log is collapsed on start", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.ConnectionProcessPeriodMs", "family_id": "setting.server.Server.ConnectionProcessPeriodMs", "kind": "setting", "name": "Server.ConnectionProcessPeriodMs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.ConnectionProcessPeriodMs = 100", "description": "Player / unlogined-player connection job re-poll period between data-arrival wakes, in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.CritterMovingPeriodMs", "family_id": "setting.server.Server.CritterMovingPeriodMs", "kind": "setting", "name": "Server.CritterMovingPeriodMs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.CritterMovingPeriodMs = 50", "description": "Critter movement-step job period in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "50" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.DbStorage", "family_id": "setting.server.Server.DbStorage", "kind": "setting", "name": "Server.DbStorage", "runtime_sides": [ "server" ], "receiver": null, "signature": "string Server.DbStorage = Memory", "description": "Database storage type", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "Memory" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.EntityIdReserveBatch", "family_id": "setting.server.Server.EntityIdReserveBatch", "kind": "setting", "name": "Server.EntityIdReserveBatch", "runtime_sides": [ "server" ], "receiver": null, "signature": "int64 Server.EntityIdReserveBatch = 1000", "description": "Entity IDs reserved per persisted-counter bump, so a new entity does not force a DB write of the last-id marker every time", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int64", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.EntityStartId", "family_id": "setting.server.Server.EntityStartId", "kind": "setting", "name": "Server.EntityStartId", "runtime_sides": [ "server" ], "receiver": null, "signature": "int64 Server.EntityStartId = 10000000001", "description": "Entity start ID", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int64", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "10000000001" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.FrameTimePeriodNs", "family_id": "setting.server.Server.FrameTimePeriodNs", "kind": "setting", "name": "Server.FrameTimePeriodNs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.FrameTimePeriodNs = 900", "description": "Frame-time update job period in nanoseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "900" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.HealthFilePeriodMs", "family_id": "setting.server.Server.HealthFilePeriodMs", "kind": "setting", "name": "Server.HealthFilePeriodMs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.HealthFilePeriodMs = 300", "description": "Health-file refresh job period in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "300" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.LockMaxWaitTime", "family_id": "setting.server.Server.LockMaxWaitTime", "kind": "setting", "name": "Server.LockMaxWaitTime", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.LockMaxWaitTime = 100", "description": "Maximum lock wait time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "100" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.MapInstanceStaticGrid", "family_id": "setting.server.Server.MapInstanceStaticGrid", "kind": "setting", "name": "Server.MapInstanceStaticGrid", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.MapInstanceStaticGrid = false", "description": "If true, map instance static grid is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.MaxServerLogLines", "family_id": "setting.server.Server.MaxServerLogLines", "kind": "setting", "name": "Server.MaxServerLogLines", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.MaxServerLogLines = 1000", "description": "Maximum server log lines in UI", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.MoveBridgeReportHexes", "family_id": "setting.server.Server.MoveBridgeReportHexes", "kind": "setting", "name": "Server.MoveBridgeReportHexes", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.MoveBridgeReportHexes = 2", "description": "Async-fix bridge length in hexes from which the client/server movement divergence is logged; 0 disables the report", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "2" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.MoveFinishCatchUpMaxMs", "family_id": "setting.server.Server.MoveFinishCatchUpMaxMs", "kind": "setting", "name": "Server.MoveFinishCatchUpMaxMs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.MoveFinishCatchUpMaxMs = 300", "description": "Upper bound in milliseconds on the movement remainder a client-reported arrival may fast-forward; the effective allowance is also capped by the connection round trip", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "300" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.NoStart", "family_id": "setting.server.Server.NoStart", "kind": "setting", "name": "Server.NoStart", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.NoStart = false", "description": "If true, server start is disabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.ProtoMapStaticGrid", "family_id": "setting.server.Server.ProtoMapStaticGrid", "kind": "setting", "name": "Server.ProtoMapStaticGrid", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.ProtoMapStaticGrid = false", "description": "If true, proto map static grid is enabled", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.ServerHeight", "family_id": "setting.server.Server.ServerHeight", "kind": "setting", "name": "Server.ServerHeight", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.ServerHeight = 600", "description": "Server window height in pixels (test bench host before any client is spawned)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "600" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.ServerPropertiesPackData", "family_id": "setting.server.Server.ServerPropertiesPackData", "kind": "setting", "name": "Server.ServerPropertiesPackData", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.ServerPropertiesPackData = true", "description": "If true, server entities with prototypes use overlay property storage", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "true" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.ServerWidth", "family_id": "setting.server.Server.ServerWidth", "kind": "setting", "name": "Server.ServerWidth", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.ServerWidth = 800", "description": "Server window width in pixels (test bench host before any client is spawned)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "800" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.ShutdownGraceMs", "family_id": "setting.server.Server.ShutdownGraceMs", "kind": "setting", "name": "Server.ShutdownGraceMs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.ShutdownGraceMs = 5000", "description": "Grace period in milliseconds for in-flight worker jobs to drain on shutdown before parked entity-lock waiters are force-aborted", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "5000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.SingleThreadedLogic", "family_id": "setting.server.Server.SingleThreadedLogic", "kind": "setting", "name": "Server.SingleThreadedLogic", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.SingleThreadedLogic = false", "description": "If true, all game logic runs on one worker thread and scripts need no explicit entity synchronization", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.SyncPeriodMs", "family_id": "setting.server.Server.SyncPeriodMs", "kind": "setting", "name": "Server.SyncPeriodMs", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.SyncPeriodMs = 10", "description": "Sync-point job period in milliseconds (100 FPS by default)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "10" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.WorkerThreads", "family_id": "setting.server.Server.WorkerThreads", "kind": "setting", "name": "Server.WorkerThreads", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 Server.WorkerThreads = 0", "description": "Worker thread count for entity processing (0 = auto)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.Server.WriteHealthFile", "family_id": "setting.server.Server.WriteHealthFile", "kind": "setting", "name": "Server.WriteHealthFile", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool Server.WriteHealthFile = false", "description": "If true, health file is written", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 387 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "Server", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.ChannelSecretKey", "family_id": "setting.server.ServerNetwork.ChannelSecretKey", "kind": "setting", "name": "ServerNetwork.ChannelSecretKey", "runtime_sides": [ "server" ], "receiver": null, "signature": "string ServerNetwork.ChannelSecretKey = ", "description": "Secure channel static X25519 secret key, 64 hex digits; every server needs it, in-process connections included", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": true, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.ClientPingTime", "family_id": "setting.server.ServerNetwork.ClientPingTime", "kind": "setting", "name": "ServerNetwork.ClientPingTime", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.ClientPingTime = 10000", "description": "Client ping time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "10000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.DisableNetworking", "family_id": "setting.server.ServerNetwork.DisableNetworking", "kind": "setting", "name": "ServerNetwork.DisableNetworking", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool ServerNetwork.DisableNetworking = false", "description": "If true, server networking listeners are not started", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.EnableUdp", "family_id": "setting.server.ServerNetwork.EnableUdp", "kind": "setting", "name": "ServerNetwork.EnableUdp", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool ServerNetwork.EnableUdp = false", "description": "If true, UDP listener is enabled for native clients", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.InactivityDisconnectTime", "family_id": "setting.server.ServerNetwork.InactivityDisconnectTime", "kind": "setting", "name": "ServerNetwork.InactivityDisconnectTime", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.InactivityDisconnectTime = 0", "description": "Inactivity disconnect time in milliseconds", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.ListenRetryDelay", "family_id": "setting.server.ServerNetwork.ListenRetryDelay", "kind": "setting", "name": "ServerNetwork.ListenRetryDelay", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.ListenRetryDelay = 500", "description": "Delay in milliseconds between listener bind attempts", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "500" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.ListenRetryTime", "family_id": "setting.server.ServerNetwork.ListenRetryTime", "kind": "setting", "name": "ServerNetwork.ListenRetryTime", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.ListenRetryTime = 30000", "description": "Time in milliseconds to keep retrying a listener whose port is still held by the previous process (0 = do not retry)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "30000" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.LoginTimeout", "family_id": "setting.server.ServerNetwork.LoginTimeout", "kind": "setting", "name": "ServerNetwork.LoginTimeout", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.LoginTimeout = 0", "description": "Maximum pre-login connection lifetime without handshake/auth/update progress in milliseconds (0 = unlimited)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxBufferedInputSize", "family_id": "setting.server.ServerNetwork.MaxBufferedInputSize", "kind": "setting", "name": "ServerNetwork.MaxBufferedInputSize", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxBufferedInputSize = 4194304", "description": "Max total unread input bytes retained per connection (0 = unlimited)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "4194304" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxConnections", "family_id": "setting.server.ServerNetwork.MaxConnections", "kind": "setting", "name": "ServerNetwork.MaxConnections", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxConnections = 0", "description": "Max simultaneous connections incl. unlogined (0 = unlimited); over this, new connections are rejected at accept", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxMessageSize", "family_id": "setting.server.ServerNetwork.MaxMessageSize", "kind": "setting", "name": "ServerNetwork.MaxMessageSize", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxMessageSize = 1048576", "description": "Max single inbound message size in bytes (0 = unlimited); rejected at the header", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1048576" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxMessagesPerProcessPass", "family_id": "setting.server.ServerNetwork.MaxMessagesPerProcessPass", "kind": "setting", "name": "ServerNetwork.MaxMessagesPerProcessPass", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxMessagesPerProcessPass = 256", "description": "Max messages drained per connection per worker job pass (0 = unlimited)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "256" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxPlayers", "family_id": "setting.server.ServerNetwork.MaxPlayers", "kind": "setting", "name": "ServerNetwork.MaxPlayers", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxPlayers = 0", "description": "Max simultaneous logined players (0 = unlimited); over this, new connections are rejected at accept", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxRemoteCallPayloadSize", "family_id": "setting.server.ServerNetwork.MaxRemoteCallPayloadSize", "kind": "setting", "name": "ServerNetwork.MaxRemoteCallPayloadSize", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxRemoteCallPayloadSize = 1048576", "description": "Runtime cap for a decoded remote-call payload (0 = structural per-call cap only)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1048576" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.MaxUdpReorderAhead", "family_id": "setting.server.ServerNetwork.MaxUdpReorderAhead", "kind": "setting", "name": "ServerNetwork.MaxUdpReorderAhead", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.MaxUdpReorderAhead = 1024", "description": "Max UDP packets buffered ahead of the next expected sequence (0 = unlimited)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "1024" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.NewConnectionRatePerSec", "family_id": "setting.server.ServerNetwork.NewConnectionRatePerSec", "kind": "setting", "name": "ServerNetwork.NewConnectionRatePerSec", "runtime_sides": [ "server" ], "receiver": null, "signature": "int32 ServerNetwork.NewConnectionRatePerSec = 0", "description": "Max new connections accepted per source host per second (0 = unlimited); bursts above this are dropped at accept", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "int32", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "0" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.RejectUdpConnections", "family_id": "setting.server.ServerNetwork.RejectUdpConnections", "kind": "setting", "name": "ServerNetwork.RejectUdpConnections", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool ServerNetwork.RejectUdpConnections = false", "description": "If true, UDP listener silently drops incoming Connect packets so clients fall back to TCP (debug aid)", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.UpdateFilesInMemory", "family_id": "setting.server.ServerNetwork.UpdateFilesInMemory", "kind": "setting", "name": "ServerNetwork.UpdateFilesInMemory", "runtime_sides": [ "server" ], "receiver": null, "signature": "bool ServerNetwork.UpdateFilesInMemory = false", "description": "If true, updater files are served from memory, otherwise from disk", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "bool", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "false" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.WssCertificate", "family_id": "setting.server.ServerNetwork.WssCertificate", "kind": "setting", "name": "ServerNetwork.WssCertificate", "runtime_sides": [ "server" ], "receiver": null, "signature": "string ServerNetwork.WssCertificate = ", "description": "WebSocket Secure certificate", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" }, { "id": "setting.server.ServerNetwork.WssPrivateKey", "family_id": "setting.server.ServerNetwork.WssPrivateKey", "kind": "setting", "name": "ServerNetwork.WssPrivateKey", "runtime_sides": [ "server" ], "receiver": null, "signature": "string ServerNetwork.WssPrivateKey = ", "description": "WebSocket Secure private key", "flags": [], "stability": "experimental", "since": "2022.1.0.wip", "deprecated": null, "examples": [], "source": { "path": "Source/Common/Settings.inc", "line": 111 }, "contract": { "explicit": true, "selector": "scope:native-codegen", "source": { "path": "Source/Common/Common.h", "line": 47 }, "notes": "" }, "declared_target": "server", "group": "ServerNetwork", "type": "string", "setting_kind": "read-only", "mutability": "read-only", "default_values": [ "" ], "command_line_redacted_by_default": false, "redaction_rule": "name matches a default Common.SecretSettingTokens entry" } ] }