FOnline Engine
Current master GitHub
Documentation Docs/en/reference/script-api/methods.md

Native Script Methods

Generated reference. Do not edit this page directly. Update engine metadata, regenerate Docs/generated/api.json, then run python BuildTools/docs_reference.py --write.

A dash in the description column means that the owning source metadata has no documentation comment. Every contract cell identifies an exact source classification, the inventory-pinned scope contract, or an unclassified default; script reachability alone does not make a symbol stable.

Reference index Canonical JSON model Generation contract

This page contains 997 native methods exported to scripts.

Critter (client)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
void Critter.AddAnimCallback(CritterStateAnim stateAnim, CritterActionAnim actionAnim, float32 normalizedTime, callback(void,Critter) animCallback) script.method.client.Critter.AddAnimCallback Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:362 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
void Critter.Animate(CritterStateAnim stateAnim, CritterActionAnim actionAnim, AbstractItem? contextItem = null, bool append = false) script.method.client.Critter.Animate Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:189 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
void Critter.ChangeDir(mdir dir) script.method.client.Critter.ChangeDir Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:497 Changes the local facing direction of this map critter through the normal client presentation path; throws when the critter is off-map
uint8 Critter.GetAlpha() script.method.client.Critter.GetAlpha Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:506 Returns the map sprite's current rendered alpha, or 255 when the critter is outside the map view
int16 Critter.GetBodyAngle() script.method.client.Critter.GetBodyAngle Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:471 Returns the rendered 3D body angle in degrees when a model is available, otherwise the critter's discrete direction angle
bool Critter.GetBonePos(hstring boneName, ipos& boneOffset) script.method.client.Critter.GetBonePos Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:393 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
Item? Critter.GetItem(ItemProperty property, int32 propertyValue) script.method.client.Critter.GetItem#20907df3571a66a9 Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:277 Returns the first visible inventory item whose integer-convertible property equals the requested value, or null when none match
Item? Critter.GetItem(ident itemId) script.method.client.Critter.GetItem#3e4a8f273e418d3b Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:219 Returns the visible inventory item with this entity id, or null when it is absent
Item? Critter.GetItem(hstring protoId) script.method.client.Critter.GetItem#5042179ea08a430e Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:227 Returns a visible inventory item with this prototype id, preferring the Inventory slot for non-stackable items; throws when the prototype id is invalid
Item? Critter.GetItem(ProtoItem proto) script.method.client.Critter.GetItem#8eedde0030f87e84 Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:255 Returns a visible inventory item matching the supplied prototype, preferring the Inventory slot for non-stackable items, or null when absent
Item[] Critter.GetItems(ItemProperty property, int32 propertyValue) script.method.client.Critter.GetItems#83c145745774df22 Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:311 Returns a snapshot of visible inventory items whose integer-convertible property equals the requested value
Item[] Critter.GetItems() script.method.client.Critter.GetItems#b851260ade7c353c Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:295 Returns a snapshot of handles to every item in this client-side inventory view
timespan Critter.GetModelAnimDuration(CritterStateAnim stateAnim, CritterActionAnim actionAnim) script.method.client.Critter.GetModelAnimDuration Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:156 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
MovingContext? Critter.GetMovingContext() script.method.client.Critter.GetMovingContext Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:110 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
ipos Critter.GetSpriteOffset() script.method.client.Critter.GetSpriteOffset Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:140 Returns the current rendered pixel offset of this map critter's sprite; throws when the critter is not on the loaded map
bool Critter.GetTextPos(ipos& pos) script.method.client.Critter.GetTextPos Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:332 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
bool Critter.IsAlive() script.method.client.Critter.IsAlive Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:73 Reports whether the critter's replicated condition is alive
bool Critter.IsAnimAvailable(CritterStateAnim stateAnim, CritterActionAnim actionAnim) script.method.client.Critter.IsAnimAvailable Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:148 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
bool Critter.IsAnimPlaying() script.method.client.Critter.IsAnimPlaying Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:181 Reports whether this map critter currently has an active visual animation; throws when the critter is not on the loaded map
bool Critter.IsDead() script.method.client.Critter.IsDead Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:87 Reports whether the critter's replicated condition is dead
bool Critter.IsKnockout() script.method.client.Critter.IsKnockout Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:80 Reports whether the critter's replicated condition is knockout
bool Critter.IsModel() script.method.client.Critter.IsModel Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:119 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
bool Critter.IsMoving() script.method.client.Critter.IsMoving Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:102 Reports whether this map critter is undergoing client-side movement; throws when the critter is not on the loaded map
bool Critter.IsOffline() script.method.client.Critter.IsOffline Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:66 Reports whether this critter is player-controlled and its replicated player-offline flag is set
bool Critter.IsOnMap() script.method.client.Critter.IsOnMap Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:94 Reports whether this client-side critter view is currently represented on the loaded map
bool Critter.IsVisible() script.method.client.Critter.IsVisible Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:132 Returns whether this map critter's sprite currently participates in rendering; throws when the critter is not on the loaded map
void Critter.MoveItemLocally(ident itemId, ident swapItemId, CritterItemSlot toSlot) script.method.client.Critter.MoveItemLocally Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:530 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
void Critter.MoveToDir(mdir dir, int32 speed) script.method.client.Critter.MoveToDir Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:453 Starts client-side movement of this map critter in the requested direction and at the requested speed; throws when the critter is off-map
MovingContext? Critter.MoveToHex(mpos hex, ipos hexOffset, int32 speed) script.method.client.Critter.MoveToHex#8abbda72eb8c68b8 Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:424 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
MovingContext? Critter.MoveToHex(mpos hex, int32 cut, ipos hexOffset, int32 speed) script.method.client.Critter.MoveToHex#c8ad324f4c60aadb Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:439 Starts local movement toward the target while retaining the requested cut distance and clamped sub-hex offset, returning the resulting context; throws off-map
void Critter.RefreshView() script.method.client.Critter.RefreshView Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:211 Reapplies the map critter's scale and movement presentation and refreshes its base visual animation when no explicit animation is active; throws off-map
void Critter.RunParticle(string particleName, hstring boneName, float32 moveX, float32 moveY, float32 moveZ) script.method.client.Critter.RunParticle Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:340 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
void Critter.SetAlpha(uint8 alpha) script.method.client.Critter.SetAlpha Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:519 Fades a map critter's sprite toward the requested target alpha; does nothing when the critter is outside the map view
void Critter.SetName(string name) script.method.client.Critter.SetName Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:59 Replaces the display name stored in this client-side critter view without updating authoritative server state
void Critter.StopAnim() script.method.client.Critter.StopAnim Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:203 Clears the active and queued visual animations of this map critter; throws when the critter is not on the loaded map
void Critter.StopMove() script.method.client.Critter.StopMove Critter client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientCritterScriptMethods.cpp:462 Stops the current client-side movement of this map critter; throws when the critter is not on the loaded map

Entity (client)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
int32 Entity.CountTimeEvent(callback(void,Entity,any) func) script.method.client.Entity.CountTimeEvent#08f3341698dc846a Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:134 Counts all client time events bound to this entity that use the selected callback
int32 Entity.CountTimeEvent(callback(void,Entity) func) script.method.client.Entity.CountTimeEvent#5609075e34e56857 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:127 Counts all client time events bound to this entity that use the selected callback
int32 Entity.CountTimeEvent(callback(void,Entity,TimeEventContext) func) script.method.client.Entity.CountTimeEvent#9c7dd3ed70f86a7d Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:148 Counts all client time events bound to this entity that use the selected callback
int32 Entity.CountTimeEvent(callback(void,Entity,any[]) func) script.method.client.Entity.CountTimeEvent#ad56856359be786a Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:141 Counts all client time events bound to this entity that use the selected callback
int32 Entity.CountTimeEvent(uint32 id) script.method.client.Entity.CountTimeEvent#e41a67022275199d Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:155 Returns one when a client time event with this id is bound to the entity, or zero when it is absent
void Entity.RepeatTimeEvent(uint32 id, timespan repeat) script.method.client.Entity.RepeatTimeEvent#28154675b58100aa Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:225 Sets the repeat interval for the event with this id and reschedules its next firing from now; does nothing when it is absent
void Entity.RepeatTimeEvent(callback(void,Entity,any) func, timespan repeat) script.method.client.Entity.RepeatTimeEvent#35eb685e9352ee97 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:204 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Entity.RepeatTimeEvent(callback(void,Entity,any[]) func, timespan repeat) script.method.client.Entity.RepeatTimeEvent#4c1ec6146e414fed Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:211 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Entity.RepeatTimeEvent(callback(void,Entity,TimeEventContext) func, timespan repeat) script.method.client.Entity.RepeatTimeEvent#d107502adf65e851 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:218 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Entity.RepeatTimeEvent(callback(void,Entity) func, timespan repeat) script.method.client.Entity.RepeatTimeEvent#d3e5bb91010a5ee6 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:197 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Entity.SetTimeEventData(callback(void,Entity,any) func, any data) script.method.client.Entity.SetTimeEventData#09c025b7150b6bcd Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:232 Replaces the single payload value for every time event using the selected callback; does nothing when none match
void Entity.SetTimeEventData(callback(void,Entity,any[]) func, any[] data) script.method.client.Entity.SetTimeEventData#46ce3a8e59df0b76 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:239 Replaces the payload array for every time event using the selected callback; does nothing when none match
void Entity.SetTimeEventData(uint32 id, any data) script.method.client.Entity.SetTimeEventData#995b7ca79df38c35 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:260 Replaces the single payload value for the time event with this id; does nothing when it is absent
void Entity.SetTimeEventData(uint32 id, any[] data) script.method.client.Entity.SetTimeEventData#adb2b4962b8e3874 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:267 Replaces the payload array for the time event with this id; does nothing when it is absent
void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any[] data) script.method.client.Entity.SetTimeEventData#c02fbdd5c31ecb21 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:253 Replaces the context payload array for every time event using the selected callback; does nothing when none match
void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any data) script.method.client.Entity.SetTimeEventData#c41820f30638ac18 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:246 Replaces the single context payload value for every time event using the selected callback; does nothing when none match
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any data) script.method.client.Entity.StartTimeEvent#170befe9003e3411 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:113 Schedules a repeating client time event whose callback context exposes one payload value, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func) script.method.client.Entity.StartTimeEvent#1e937a7976df63ac Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:64 Schedules a one-shot client time event whose callback receives a context for inspecting or modifying that event, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any[] data) script.method.client.Entity.StartTimeEvent#492d95e09fb651ed Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:78 Schedules a one-shot client time event whose callback context exposes the payload array, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity) func) script.method.client.Entity.StartTimeEvent#494379a91f97d59e Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:85 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
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any[] data) script.method.client.Entity.StartTimeEvent#64daaaa7e6125cb3 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:120 Schedules a repeating client time event whose callback context exposes the payload array, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any[]) func, any[] data) script.method.client.Entity.StartTimeEvent#805b4b72ba72a604 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:99 Schedules a repeating client time event with a callback payload array and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any) func, any data) script.method.client.Entity.StartTimeEvent#9e1b092a1d7fb963 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:92 Schedules a repeating client time event with one callback payload value and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any) func, any data) script.method.client.Entity.StartTimeEvent#ae9a39c7d8c1d6fa Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:50 Schedules a one-shot client time event bound to this entity, passes one payload value to the callback, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func) script.method.client.Entity.StartTimeEvent#af2f95f5513a4cfa Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:106 Schedules a repeating client time event whose callback receives a context for inspecting or modifying that event, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any[]) func, any[] data) script.method.client.Entity.StartTimeEvent#b494dfd4a4fa81ea Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:57 Schedules a one-shot client time event bound to this entity, passes the payload array to the callback, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any data) script.method.client.Entity.StartTimeEvent#d9b6635334d5ae05 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:71 Schedules a one-shot client time event whose callback context exposes one payload value, and returns its event id
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity) func) script.method.client.Entity.StartTimeEvent#e59548a665ddb838 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:43 Schedules a one-shot client time event bound to this entity after the requested delay and returns its event id
void Entity.StopTimeEvent(callback(void,Entity,any) func) script.method.client.Entity.StopTimeEvent#1ff4e8b7bdb6f35c Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:169 Stops all client time events bound to this entity that use the selected callback; does nothing when none match
void Entity.StopTimeEvent(callback(void,Entity,TimeEventContext) func) script.method.client.Entity.StopTimeEvent#58fd464d379e5ea5 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:183 Stops all client time events bound to this entity that use the selected callback; does nothing when none match
void Entity.StopTimeEvent(uint32 id) script.method.client.Entity.StopTimeEvent#be90949683fff93d Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:190 Stops the client time event with this id when it is bound to the entity; does nothing when it is absent
void Entity.StopTimeEvent(callback(void,Entity) func) script.method.client.Entity.StopTimeEvent#d792082ed73a8fc8 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:162 Stops all client time events bound to this entity that use the selected callback; does nothing when none match
void Entity.StopTimeEvent(callback(void,Entity,any[]) func) script.method.client.Entity.StopTimeEvent#ddfbd34ed1764f92 Player, Location, Map, Critter, Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ClientEntityScriptMethods.cpp:176 Stops all client time events bound to this entity that use the selected callback; does nothing when none match

Game (client)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
void Game.ActivateOffscreenSurface(bool forceClear) script.method.client.Game.ActivateOffscreenSurface Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1608 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
void Game.BindFont(FontType font, string fontFname, float32 defaultScale = 1.0f) script.method.client.Game.BindFont Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:875 Binds a .fofnt or .fnt resource to a client font slot with the supplied default scale; throws for any other extension
uint32 Game.BytesReceive() script.method.client.Game.BytesReceive Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:416 Returns the connection's cumulative received-byte counter narrowed to uint32
uint32 Game.BytesSend() script.method.client.Game.BytesSend Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:409 Returns the connection's cumulative sent-byte counter narrowed to uint32
uint8[] Game.CaptureScreenshot(int32 maxSide) script.method.client.Game.CaptureScreenshot Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1817 Returns the last complete frame as compact RGB PNG bytes, downscaled to maxSide when positive
void Game.ChangeLanguage(string langName) script.method.client.Game.ChangeLanguage Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1973 Loads the named language pack and makes it current without changing the configured startup language
Critter Game.Chosen() script.method.client.Game.Chosen Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:56 Returns the chosen critter, or throws when none is currently assigned; check HasChosen first when absence is expected
void Game.ClearEffectScriptValues(EffectType effectType, int64 effectSubtype) script.method.client.Game.ClearEffectScriptValues Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:917 Clears all script values associated with the selected effect instance
void Game.ClearForcedMousePos() script.method.client.Game.ClearForcedMousePos Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1966 Stops overriding the client's logical mouse position after input polling
void Game.Connect() script.method.client.Game.Connect Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1989 Queues a client connection request for processing by the main loop
VideoPlayback Game.CreateVideoPlayback(string videoName, bool looped) script.method.client.Game.CreateVideoPlayback Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ClientGlobalScriptMethods.cpp:746 Creates an independently drawable video playback object from a required resource, configures looping, and transfers ownership to the script
Location Game.CurLocation() script.method.client.Game.CurLocation Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:96 Returns the current Location view, or throws when none is available; check HasCurLocation first when absence is expected
Map Game.CurMap() script.method.client.Game.CurMap Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:116 Returns the current local Map view, or throws when none is loaded; check HasCurMap first when absence is expected
Player Game.CurPlayer() script.method.client.Game.CurPlayer Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:76 Returns the current Player view, or throws when none is available; check HasCurPlayer first when absence is expected
void Game.Disconnect() script.method.client.Game.Disconnect Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1996 Cancels any pending connection request and disconnects the active transport
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) script.method.client.Game.DrawCritter2d Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1418 Draws the resolved current 2D critter frame into the supplied bounds, forwarding scratch and center scaling modes; unresolved animation tuples are ignored
void Game.DrawCritter3d(uint32 instance, hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, int32[] layers, float32[] position, ucolor color) script.method.client.Game.DrawCritter3d Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1429 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
void Game.DrawMiniMap(int32 zoom, int32 x, int32 y, int32 w, int32 h) script.method.client.Game.DrawMiniMap Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:360 Prepares or refreshes the current local-map minimap for the supplied zoom and rectangle, then draws its line primitives
void Game.DrawPrimitive(RenderPrimitiveType primitiveType, int32[] data) script.method.client.Game.DrawPrimitive Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1396 During RenderIface, draws primitive points decoded from complete x, y, packed-color triplets; empty data is ignored and trailing incomplete values are dropped
void Game.DrawSprite(uint32 sprId, ipos pos, ucolor color = ucolor(), bool offs = false) script.method.client.Game.DrawSprite#09e9c2f9becdf091 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1257 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
void Game.DrawSprite(uint32 sprId, fpos pos, fsize size, ucolor color) script.method.client.Game.DrawSprite#779a85d218769bd8 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1299 During RenderIface, draws a loaded sprite at a floating-point position scaled to the supplied size; an empty color uses neutral tint
void Game.DrawSprite(uint32 sprId, fpos pos, ucolor color) script.method.client.Game.DrawSprite#7bcbb90671d41361 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1282 During RenderIface, draws a loaded sprite at a floating-point position using its intrinsic size; an empty color uses neutral tint
void Game.DrawSprite(uint32 sprId, ipos pos, isize size, ucolor color = ucolor(), bool fit = true, bool offs = false) script.method.client.Game.DrawSprite#f68df76d1db1b23c Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1316 During RenderIface, draws a loaded sprite into an integer rectangle with optional fitting and sprite-offset application; an empty color uses neutral tint
void Game.DrawSpritePattern(uint32 sprId, ipos pos, isize size, isize sprSize, ucolor color) script.method.client.Game.DrawSpritePattern Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1334 During RenderIface, tiles a loaded sprite over the supplied rectangle using sprSize as the tile dimensions; an empty color uses neutral tint
bool Game.DrawSpriteRegion(uint32 sprId, fpos uv0, fpos uv1, ipos pos, isize size, ucolor color = ucolor()) script.method.client.Game.DrawSpriteRegion Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1351 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
void Game.DrawText(string text, ipos pos, isize size, ucolor color, TextFormat format) script.method.client.Game.DrawText Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1368 During RenderIface, draws nonempty formatted text in the supplied rectangle; negative dimensions extend left or up, and an empty color uses text white
void Game.DrawVideoPlayback(VideoPlayback? video, ipos pos, isize size) script.method.client.Game.DrawVideoPlayback Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:769 During RenderIface, advances and draws a non-null video playback into a positive-size rectangle and marks the object stopped when its clip ends
void Game.DumpAtlases() script.method.client.Game.DumpAtlases Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:342 Writes every current texture atlas to a timestamped diagnostic PNG directory whose name includes total atlas memory use
void Game.FlashUnfocusedWindow() script.method.client.Game.FlashUnfocusedWindow Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1980 Requests a taskbar or window-manager attention flash only when the client window is unfocused
void Game.FreeSprite(uint32 sprId) script.method.client.Game.FreeSprite Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1110 Releases a client-local sprite handle, stopping its animation and retaining the resource in the reuse cache; unknown handles are ignored
uint8[] Game.GetCacheData(string name) script.method.client.Game.GetCacheData Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1890 Returns the bytes stored under a client cache entry name, or an empty array when the entry cannot be read
string Game.GetCacheText(string name) script.method.client.Game.GetCacheText Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1904 Returns the string stored under a client cache entry name, or an empty string when the entry cannot be read
Critter? Game.GetCritter(ident crId) script.method.client.Game.GetCritter Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:500 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
Critter[] Game.GetCritters(CritterFindType findType) script.method.client.Game.GetCritters#81d4328569cd9426 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:527 Returns current local-map or global-map critters that satisfy the requested CritterFindType filter
Critter[] Game.GetCritters(hstring pid, CritterFindType findType) script.method.client.Game.GetCritters#addc705539406d44 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:561 Returns current local-map or global-map critters that match the optional prototype id and requested CritterFindType filter; an empty id matches every prototype
Critter[] Game.GetCritters(ProtoCritter proto, CritterFindType findType) script.method.client.Game.GetCritters#e79de6b56cb9f3b3 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:615 Returns current local-map or global-map critters whose prototype id matches the supplied prototype and that satisfy the requested CritterFindType filter
int32 Game.GetDistance(Item item1, Item item2) script.method.client.Game.GetDistance#1be05ad1508d9bdf Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:214 Returns center-to-center hex distance between two items on the same map; throws for off-map or different-map inputs
int32 Game.GetDistance(Item item, Critter cr) script.method.client.Game.GetDistance#200d823fdf545d92 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:256 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
int32 Game.GetDistance(mpos hex, Critter cr) script.method.client.Game.GetDistance#33a4d51ef8eece2a Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:295 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
int32 Game.GetDistance(Critter cr, Item item) script.method.client.Game.GetDistance#3dade8869ec8c0ac Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:234 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
int32 Game.GetDistance(Item item, mpos hex) script.method.client.Game.GetDistance#8298d537bb9c7c37 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:327 Returns center-to-center hex distance from an on-map item to a hex; throws when the item is off map
int32 Game.GetDistance(Critter cr, mpos hex) script.method.client.Game.GetDistance#8a80a760debf852d Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:278 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
int32 Game.GetDistance(mpos hex, Item item) script.method.client.Game.GetDistance#b273c01749f73e8c Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:312 Returns center-to-center hex distance from a hex to an on-map item; throws when the item is off map
int32 Game.GetDistance(Critter cr1, Critter cr2) script.method.client.Game.GetDistance#dacea0c00ba4c5f1 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:192 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
bool Game.GetDrawCritter3dBounds(uint32 instance, irect& drawRect, irect& viewRect) script.method.client.Game.GetDrawCritter3dBounds Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1537 Returns positive draw and view bounds for a previously loaded 3D critter instance, false when unavailable, and throws without 3D support
GamepadState Game.GetGamepadState() script.method.client.Game.GetGamepadState Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:143 Returns a snapshot of the active input backend's gamepad state
Item? Game.GetItem(ident itemId) script.method.client.Game.GetItem Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:430 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
int32 Game.GetMusicVolume() script.method.client.Game.GetMusicVolume Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:381 Returns the live music-volume percentage owned by the audio manager
int32 Game.GetPing() script.method.client.Game.GetPing Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:423 Returns the most recently measured client-server round-trip time in milliseconds
string[] Game.GetSoundNames() script.method.client.Game.GetSoundNames Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:691 Returns the source-backed audio resource paths indexed by Audio.SoundFileExtensions
int32 Game.GetSoundVolume() script.method.client.Game.GetSoundVolume Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:395 Returns the live sound-effect volume percentage owned by the audio manager
isize Game.GetSpriteSize(uint32 sprId) script.method.client.Game.GetSpriteSize Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1117 Returns the current sprite size for a client-local handle, or a zero size when the handle is unknown
string Game.GetText(TextPackKey textKey, int32 textIndex) script.method.client.Game.GetText#18a1958c0507d2fd Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:814 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
string Game.GetText(string langName, TextPackKey textKey) script.method.client.Game.GetText#513ec7ba7fb47b7c Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:800 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
string Game.GetText(TextPackKey textKey) script.method.client.Game.GetText#6f20bf83e45a6a6d Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:807 Returns the first current-language text variant for a key
int32 Game.GetTextCount(TextPackKey textKey) script.method.client.Game.GetTextCount Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:825 Returns the number of current-language text variants registered for a key
void Game.GetTextInfo(string text, isize size, TextFormat format, isize& resultSize, int32& resultLines) script.method.client.Game.GetTextInfo Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1241 Measures formatted text inside the supplied size, writing its resulting extent and line count, and throws when the selected font cannot be evaluated
int32 Game.GetTextLines(isize size, FontType font) script.method.client.Game.GetTextLines Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1250 Returns how many complete lines of the selected font fit within a positive-size rectangle, or zero for nonpositive dimensions
bool Game.HasChosen() script.method.client.Game.HasChosen Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:49 Returns whether the client currently has a chosen critter
bool Game.HasCurLocation() script.method.client.Game.HasCurLocation Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:89 Returns whether the client currently has a Location view
bool Game.HasCurMap() script.method.client.Game.HasCurMap Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:109 Returns whether the client is currently displaying a local Map view
bool Game.HasCurPlayer() script.method.client.Game.HasCurPlayer Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:69 Returns whether the client currently has a replicated Player view
bool Game.IsAlwaysOnTop() script.method.client.Game.IsAlwaysOnTop Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:367 Reports whether the client window currently stays above other windows
bool Game.IsCacheEntry(string name) script.method.client.Game.IsCacheEntry Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1911 Returns whether the named client cache entry exists
bool Game.IsConnected() script.method.client.Game.IsConnected Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:185 Returns whether the client connection is currently established
bool Game.IsConnecting() script.method.client.Game.IsConnecting Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:178 Returns whether a connection attempt is currently in progress
bool Game.IsFullscreen() script.method.client.Game.IsFullscreen Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:157 Returns whether the client window is currently fullscreen
bool Game.IsMouseAvailable() script.method.client.Game.IsMouseAvailable Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:136 Returns whether the active input backend currently exposes mouse input
bool Game.IsSpriteHit(uint32 sprId, ipos pos) script.method.client.Game.IsSpriteHit Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1130 Hit-tests a client position against the current sprite frame and returns false when the handle is unknown
bool Game.IsTextPresent(TextPackKey textKey) script.method.client.Game.IsTextPresent Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:832 Returns whether the current language pack contains the supplied text key
bool Game.IsVideoPlaying() script.method.client.Game.IsVideoPlaying Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:739 Returns whether a fullscreen video clip is currently active
uint32 Game.LoadMapSprite(string sprName) script.method.client.Game.LoadMapSprite#7a0d7d6483239069 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1082 Loads a named sprite into the map-sprite atlas, starts its default animation, and returns a client-local handle, or zero when unresolved
uint32 Game.LoadMapSprite(hstring nameHash) script.method.client.Game.LoadMapSprite#aefb44cb240c9375 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1089 Loads a hashed sprite resource into the map-sprite atlas, starts its default animation, and returns a client-local handle, or zero when unresolved
uint32 Game.LoadSeparateSprite(string sprName) script.method.client.Game.LoadSeparateSprite#7a0d7d6483239069 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1096 Loads a named sprite as a separate one-image texture, starts its default animation, and returns a client-local handle, or zero when unresolved
uint32 Game.LoadSeparateSprite(hstring nameHash) script.method.client.Game.LoadSeparateSprite#aefb44cb240c9375 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1103 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
uint32 Game.LoadSprite(string sprName) script.method.client.Game.LoadSprite#7a0d7d6483239069 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1068 Loads a named sprite into the interface atlas, starts its default animation, and returns a client-local handle, or zero when unresolved
uint32 Game.LoadSprite(hstring nameHash) script.method.client.Game.LoadSprite#aefb44cb240c9375 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1075 Loads a hashed sprite resource into the interface atlas, starts its default animation, and returns a client-local handle, or zero when unresolved
void Game.MinimizeWindow() script.method.client.Game.MinimizeWindow Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:171 Requests minimization of the client window
ipos Game.MousePos() script.method.client.Game.MousePos Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Getter Source/Scripting/ClientGlobalScriptMethods.cpp:129 Returns the latest mouse position processed by the client input pipeline
bool Game.PlayMusic(string musicName, timespan repeatTime) script.method.client.Game.PlayMusic Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:720 Starts named music with the supplied repeat delay and returns whether playback was accepted; an empty name stops current music and returns true
bool Game.PlayParticleWithSeed(uint32 sprId, int32 seed) script.method.client.Game.PlayParticleWithSeed Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1202 Starts a loaded particle sprite with a deterministic seed and returns false for an unknown handle, non-particle sprite, or rejected playback
uint32 Game.PlaySound(string soundName, float32 attenuation, float32 pan) script.method.client.Game.PlaySound#1aa5e922f54f38a5 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:706 Starts the exact baked audio resource with initial attenuation and pan and returns its lifetime handle, or zero on failure
uint32 Game.PlaySound(string soundName) script.method.client.Game.PlaySound#fac885e1d1fb5d17 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:699 Starts the exact baked audio resource and returns its non-reused lifetime handle, or zero when no live sound starts
void Game.PlaySprite(uint32 sprId, hstring animName, bool looped, bool reversed) script.method.client.Game.PlaySprite Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1189 Starts the named animation on a client-local sprite with the requested looping and reverse flags; unknown handles are ignored
void Game.PlayVideo(string videoName, bool canInterrupt, bool enqueue) script.method.client.Game.PlayVideo Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:732 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
void Game.PopDrawScissor() script.method.client.Game.PopDrawScissor Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1582 Pops the top drawing scissor rectangle from the client renderer stack
void Game.Preload3dFiles(string[] fnames) script.method.client.Game.Preload3dFiles Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:857 Preloads each named model through the 3D model manager; throws when the 3D submodule or model sprite factory is unavailable
void Game.PresentOffscreenSurface(int32 effectSubtype, int32 fromX, int32 fromY, int32 fromW, int32 fromH, int32 toX, int32 toY, int32 toW, int32 toH) script.method.client.Game.PresentOffscreenSurface#2119d712f785fe8c Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1706 During RenderIface, consumes the active offscreen surface and draws independently clamped source and destination rectangles with the selected effect
void Game.PresentOffscreenSurface(int32 effectSubtype, ipos pos, isize size) script.method.client.Game.PresentOffscreenSurface#3c10a5be709fae45 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1661 During RenderIface, consumes the active offscreen surface and draws the clamped same-position source and destination rectangle with the selected effect
void Game.PresentOffscreenSurface(int32 effectSubtype, ipos pos, isize size, float32 scriptValue0, float32 scriptValue1, float32 scriptValue2, float32 scriptValue3) script.method.client.Game.PresentOffscreenSurface#5ec3a0fd048629a1 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1678 During RenderIface, sets the first four script values when supported, then consumes and draws the active offscreen surface in the clamped rectangle
void Game.PresentOffscreenSurface(int32 effectSubtype) script.method.client.Game.PresentOffscreenSurface#81efefba57ca2d31 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1651 During RenderIface, consumes the active offscreen surface and draws it over the screen with the selected offscreen effect
bool Game.PrewarmParticle(uint32 sprId) script.method.client.Game.PrewarmParticle Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1221 Advances a loaded particle sprite through its prewarm phase and returns false for an unknown handle or non-particle sprite
void Game.PushDrawScissor(ipos pos, isize size) script.method.client.Game.PushDrawScissor Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1575 Pushes a drawing scissor rectangle onto the client renderer stack
void Game.RemoveCacheEntry(string name) script.method.client.Game.RemoveCacheEntry Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1918 Removes the named client cache entry when present
string Game.ReplaceText(string text, string from, string to) script.method.client.Game.ReplaceText#587f96d5350d1194 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:839 Returns a copy of text with occurrences of the supplied substring replaced by another string
string Game.ReplaceText(string text, string from, int64 to) script.method.client.Game.ReplaceText#75a7b30c3e8c914d Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:848 Returns a copy of text with occurrences of the supplied substring replaced by the decimal representation of an integer
void Game.SaveScreenshot(string filePath) script.method.client.Game.SaveScreenshot Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1794 Reads the last main render target, corrects backend vertical flipping, and writes a PNG to a required nonempty path
void Game.SaveText(string filePath, string text) script.method.client.Game.SaveText Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1842 Creates parent directories and truncates the target file before writing the supplied text bytes; write and directory failures throw
isize Game.ScreenSize() script.method.client.Game.ScreenSize Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/ClientGlobalScriptMethods.cpp:150 Returns the current logical screen size
void Game.SetAlwaysOnTop(bool enable) script.method.client.Game.SetAlwaysOnTop Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:374 Enables or disables the client window's always-on-top mode
void Game.SetCacheData(string name, uint8[] data, int32 dataSize) script.method.client.Game.SetCacheData#34c4e9183aea7e54 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1877 Stores a resized copy of the byte array under a client cache entry, truncating or zero-extending it to a required nonnegative dataSize
void Game.SetCacheData(string name, uint8[] data) script.method.client.Game.SetCacheData#4fb7a51531e48788 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1870 Stores the complete byte array under a client cache entry name
void Game.SetCacheText(string name, string str) script.method.client.Game.SetCacheText Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1897 Stores a string under a client cache entry name
void Game.SetEffect(EffectType effectType, int64 effectSubtype, string effectPath) script.method.client.Game.SetEffect Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:890 Rebinds effect slots selected by EffectType to an effect resource; subtype selects entity, font, or offscreen instances where that effect class requires one
void Game.SetEffectScriptValue(EffectType effectType, int64 effectSubtype, int32 valueIndex, float32 value) script.method.client.Game.SetEffectScriptValue Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:897 Writes one script float at a validated index in the selected effect instance's script-value buffer
void Game.SetEffectScriptValues(EffectType effectType, int64 effectSubtype, int32 valueStartIndex, float32[] values, int32 valuesOffset = 0, int32 valuesCount = -1) script.method.client.Game.SetEffectScriptValues Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:904 Copies a validated slice of the supplied values into the selected effect instance's script-value buffer starting at valueStartIndex
void Game.SetForcedMousePos(ipos pos) script.method.client.Game.SetForcedMousePos Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1958 Forces the client's logical mouse position to the supplied value after each input poll without moving the native cursor
void Game.SetMousePos(ipos pos) script.method.client.Game.SetMousePos Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1951 Moves the native input backend's mouse cursor to the supplied client position
void Game.SetMusicVolume(int32 volume) script.method.client.Game.SetMusicVolume Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:388 Changes the live music-volume percentage without mutating startup settings
bool Game.SetParticleScale(uint32 sprId, float32 scale) script.method.client.Game.SetParticleScale Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1169 Changes the scale of a loaded particle sprite and returns false for an unknown handle or non-particle sprite
void Game.SetResolution(int32 width, int32 height) script.method.client.Game.SetResolution Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:349 Changes the logical screen size and, for a non-virtual window, the native client window size to the supplied dimensions
void Game.SetScreenKeyboard(bool enabled) script.method.client.Game.SetScreenKeyboard Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:2003 Enables or disables the active input backend's on-screen keyboard
void Game.SetSoundVolume(int32 volume) script.method.client.Game.SetSoundVolume Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:402 Changes the live sound-effect volume percentage without mutating startup settings
void Game.SetSpriteTime(uint32 sprId, float32 normalizedTime) script.method.client.Game.SetSpriteTime Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1156 Sets the normalized playback time of a client-local sprite; unknown handles are ignored
void Game.SetUserConfig(string[] keyValues) script.method.client.Game.SetUserConfig#404272fae1b8c4d2 Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1938 Replaces the cached user configuration with consecutive key/value pairs serialized as key = value, ignoring an unmatched final element
void Game.SetUserConfig(string=>string keyValues) script.method.client.Game.SetUserConfig#83f675b8f444529f Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1925 Replaces the cached user configuration with key/value lines serialized as key = value
void Game.SimulateConnectingFailed() script.method.client.Game.SimulateConnectingFailed Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1020 Raises the client connecting-failed event as the transport would deliver it
void Game.SimulateDisconnect() script.method.client.Game.SimulateDisconnect Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1011 Raises the disconnect notification without touching the connection itself
void Game.SimulateInfoMessage(EngineInfoMessage infoMessage, string extraText = "") script.method.client.Game.SimulateInfoMessage Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1027 Raises an engine info message with optional extra text, as the server would deliver it
void Game.SimulateKeyPress(KeyCode key, string text = "") script.method.client.Game.SimulateKeyPress Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1034 Injects a key-down event carrying optional text followed by key-up; KeyCode::None is a no-op
void Game.SimulateKeyboardPress(KeyCode key1, KeyCode key2, string key1Text, string key2Text) script.method.client.Game.SimulateKeyboardPress Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1046 Injects key1 down, a complete key2 press, then key1 up, skipping either KeyCode::None value and doing nothing when both are None
void Game.SimulateMouseClick(ipos pos, MouseButton button) script.method.client.Game.SimulateMouseClick Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:961 Moves the simulated mouse when needed and injects either a wheel step or a matching button-down/button-up pair
void Game.SimulateMouseDown(ipos pos, MouseButton button) script.method.client.Game.SimulateMouseDown Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:935 Moves the simulated mouse to the requested position when needed, then injects a button-down event
void Game.SimulateMouseMove(ipos pos) script.method.client.Game.SimulateMouseMove Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:924 Injects a mouse-move input event when the requested position differs from the current client mouse position, including the computed delta
void Game.SimulateMouseUp(ipos pos, MouseButton button) script.method.client.Game.SimulateMouseUp Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:948 Moves the simulated mouse to the requested position when needed, then injects a button-up event
void Game.SimulateTouchDown(int64 fingerId, ipos pos) script.method.client.Game.SimulateTouchDown Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:983 Injects a touch-down event for the supplied finger id and client position
void Game.SimulateTouchMove(int64 fingerId, ipos pos, ipos offsetPos) script.method.client.Game.SimulateTouchMove Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:990 Injects a touch-move event with the supplied finger id, position, and movement offset
void Game.SimulateTouchTap(ipos pos) script.method.client.Game.SimulateTouchTap Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1004 Injects a touch-tap event at the supplied client position
void Game.SimulateTouchUp(int64 fingerId, ipos pos) script.method.client.Game.SimulateTouchUp Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:997 Injects a touch-up event for the supplied finger id and client position
Critter[] Game.SortCrittersByDeep(Critter[] critters) script.method.client.Game.SortCrittersByDeep Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:647 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
void Game.StopSprite(uint32 sprId) script.method.client.Game.StopSprite Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:1143 Stops animation for a client-local sprite handle; unknown handles are ignored
void Game.ToggleFullscreen() script.method.client.Game.ToggleFullscreen Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:164 Switches the client window between fullscreen and windowed modes
bool Game.UpdateSound(uint32 soundId, float32 attenuation, float32 pan) script.method.client.Game.UpdateSound Game client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientGlobalScriptMethods.cpp:713 Updates attenuation and pan for a live sound handle and returns false after that sound has ended

ImGui (client)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
void ImGui.Image(uint32 sprId, fsize imageSize, fpos uv0 = fpos(0.0f, 0.0f), fpos uv1 = fpos(1.0f, 1.0f)) script.method.client.ImGui.Image ImGui client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientImGuiScriptMethods.cpp:142 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
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()) script.method.client.ImGui.ImageButton ImGui client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientImGuiScriptMethods.cpp:156 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

Item (client)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
Item Item.Clone() script.method.client.Item.Clone Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ClientItemScriptMethods.cpp:69 Creates a standalone client-side clone with the same id, prototype, and property values without inserting it into a map or inventory
void Item.Finish() script.method.client.Item.Finish Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:231 Starts the standard fade-out and finish sequence for a map item once; does nothing for items outside the map view
uint8 Item.GetAlpha() script.method.client.Item.GetAlpha Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:210 Returns the map sprite's current rendered alpha, or 255 for an item outside the map view
Item[] Item.GetInnerItems() script.method.client.Item.GetInnerItems Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:194 Returns a snapshot of handles to the item's immediate contained items, without recursively flattening nested containers
void Item.GetMapPos(mpos& hex) script.method.client.Item.GetMapPos Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:116 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
ipos Item.GetSpriteOffset() script.method.client.Item.GetSpriteOffset Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:56 Returns the current rendered pixel offset of this map item's sprite; throws if the item is not on the loaded map
bool Item.IsAnimPlaying() script.method.client.Item.IsAnimPlaying Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:127 Reports whether this map item's sprite animation is playing; returns false for items outside the map view
bool Item.IsMoving() script.method.client.Item.IsMoving Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:174 Reports whether this map item is undergoing client-side visual movement; returns false for items outside the map view
bool Item.IsVisible() script.method.client.Item.IsVisible Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:43 Returns whether this map item's sprite currently participates in rendering; throws if the item is not on the loaded map
void Item.MoveToHex(mpos hex, float32 speed) script.method.client.Item.MoveToHex Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:185 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
void Item.PlayAnim(hstring animName, bool looped, bool reversed) script.method.client.Item.PlayAnim Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:138 Starts the named sprite animation for a map item with the requested looping and reverse modes; does nothing for items outside the map view
void Item.SetAlpha(uint8 alpha) script.method.client.Item.SetAlpha Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:222 Fades a map item's sprite toward the requested target alpha; does nothing for items outside the map view
void Item.SetAnimDir(mdir dir) script.method.client.Item.SetAnimDir Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:165 Sets the directional variant used by a map item's sprite animation; does nothing for items outside the map view
void Item.SetAnimTime(float32 normalizedTime) script.method.client.Item.SetAnimTime Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:156 Sets the normalized playback position of a map item's sprite animation; does nothing for items outside the map view
void Item.StopAnim() script.method.client.Item.StopAnim Item client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientItemScriptMethods.cpp:147 Stops the current sprite animation for a map item; does nothing for items outside the map view

Map (client)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
FogLayer Map.AddFog(Critter? cr, DrawOrderType drawOrder, int32 flushEffectSubtype = -1) script.method.client.Map.AddFog#2b31b535aa5f8b00 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:966 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
FogLayer Map.AddFog(mpos hex, DrawOrderType drawOrder, int32 flushEffectSubtype = -1) script.method.client.Map.AddFog#d8badb89913d2e1b Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:979 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
void Map.ApplyScreenScroll(ipos offset, int32 speed, bool canStop) script.method.client.Map.ApplyScreenScroll Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:704 Applies a pixel scroll delta using the requested speed and interruption policy
void Map.ChangeZoom(float32 targetZoom) script.method.client.Map.ChangeZoom Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:755 Starts a zoom change anchored under the mouse cursor, or the screen center when mouse input is unavailable; an unchanged target is ignored
void Map.ClearTransparentEgg(TransparentEggSlot slot) script.method.client.Map.ClearTransparentEgg Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:857 Clears the selected transparent-egg slot from this map view
Item Map.CreateLocalItem(hstring pid, mpos hex) script.method.client.Map.CreateLocalItem Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:1015 Creates and attaches a client-local item of a known prototype at a valid map hex; invalid prototypes or coordinates throw
bool Map.DrawEntitySprite(Entity entity, int32 effectSubtype, ucolor color, int32 padding) script.method.client.Map.DrawEntitySprite Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:148 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
void Map.DrawMap() script.method.client.Map.DrawMap Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:44 Draws the loaded map during the RenderIface event; throws when called outside that render callback
void Map.DrawMapSprite(MapSpriteHolder mapSpr) script.method.client.Map.DrawMapSprite Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:55 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
Critter? Map.GetCritter(ident critterId) script.method.client.Map.GetCritter Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:286 Returns the critter with the supplied runtime id, or null for a zero or unknown id
Critter? Map.GetCritterAtScreenPos(ipos pos, int32 extraRange = 0) script.method.client.Map.GetCritterAtScreenPos Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:873 Returns the pixel-precise critter hit at a screen position, optionally retrying with an expanded range when the exact lookup finds none
Critter? Map.GetCritterInRadius(mpos hex, int32 radius, CritterFindType findType) script.method.client.Map.GetCritterInRadius Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:322 Returns the matching critter nearest to a valid center hex within the requested radius after accounting for multihex size, or null when none match
Critter? Map.GetCritterOnHex(mpos hex, CritterFindType findType) script.method.client.Map.GetCritterOnHex Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:298 Returns the matching critter nearest to a valid hex after accounting for multihex size, or null when none match; an invalid hex throws
Critter[] Map.GetCritters(hstring pid, CritterFindType findType) script.method.client.Map.GetCritters#addc705539406d44 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:366 Returns every critter on this map whose prototype id and find-type state match the supplied filters
Critter[] Map.GetCritters(CritterFindType findType = CritterFindType::Any) script.method.client.Map.GetCritters#d593b4ce96170bb4 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:346 Returns every critter on this map that passes the requested find-type filter
Critter[] Map.GetCritters(ProtoCritter proto, CritterFindType findType) script.method.client.Map.GetCritters#e79de6b56cb9f3b3 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:384 Returns every critter on this map whose prototype and find-type state match the supplied filters
Critter[] Map.GetCrittersInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType) script.method.client.Map.GetCrittersInPath Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:441 Traces the requested path corridor and returns matching critters intersected along it; invalid endpoint hexes throw
Critter[] Map.GetCrittersInRadius(mpos hex, int32 radius, CritterFindType findType) script.method.client.Map.GetCrittersInRadius Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:422 Returns matching critters within the requested radius of a valid hex, ordered by multihex-adjusted distance from it; an invalid hex throws
Critter[] Map.GetCrittersOnHex(mpos hex, CritterFindType findType) script.method.client.Map.GetCrittersOnHex Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:403 Returns matching critters overlapping a valid hex, ordered by multihex-adjusted distance from it; an invalid hex throws
Critter[] Map.GetCrittersWithBlockInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType, mpos& preBlockHex, mpos& blockHex) script.method.client.Map.GetCrittersWithBlockInPath Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:457 Traces the requested path corridor, returns matching critters, and writes the last pre-block and first blocking hexes; invalid endpoints throw
Entity? Map.GetEntityAtScreenPos(ipos pos, bool ignoreTransparentEgg = false) script.method.client.Map.GetEntityAtScreenPos Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:886 Returns the top selectable client entity at a screen position using pixel-precise hit testing, or null when none is hit
bool Map.GetHexAtScreenPos(ipos pos, mpos& hex, ipos& hexOffset) script.method.client.Map.GetHexAtScreenPos#8257da98c48140a5 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:817 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
bool Map.GetHexAtScreenPos(ipos pos, mpos& hex) script.method.client.Map.GetHexAtScreenPos#858322c2894be6b9 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:810 Resolves a screen position to a map hex, writes the hex on success, and returns whether the position maps to the view
isize Map.GetHexContentSize(mpos hex) script.method.client.Map.GetHexContentSize Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:1008 Returns the aggregate pixel size of content associated with the supplied hex in this map view
void Map.GetHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist) script.method.client.Map.GetHexInPath Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:473 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
ipos Map.GetHexMapPos(mpos hex) script.method.client.Map.GetHexMapPos Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:785 Returns the integer map-space position of the top-left of a valid hex cell; an invalid hex throws
ipos Map.GetHexScreenPos(mpos hex) script.method.client.Map.GetHexScreenPos Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:772 Returns the integer screen position of the visual center of a valid hex after current scrolling and projection; an invalid hex throws
fpos Map.GetHexScreenPosF(mpos hex) script.method.client.Map.GetHexScreenPosF Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:796 Returns the floating-point screen position of a valid hex center after current scrolling and sprite zoom; an invalid hex throws
int32 Map.GetHiddenRoofNum() script.method.client.Map.GetHiddenRoofNum Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:1050 Returns the roof group currently hidden by this map view's roof-hiding logic
Item? Map.GetItem(ident itemId) script.method.client.Map.GetItem Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:242 Returns the map item with the nonzero runtime id, or null when this map does not contain it; a zero id throws
Item? Map.GetItemAtScreenPos(ipos pos) script.method.client.Map.GetItemAtScreenPos Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:864 Returns the top selectable map item at a screen position using pixel-precise hit testing, or null when none is hit
Item? Map.GetItemOnHex(mpos hex) script.method.client.Map.GetItemOnHex Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:254 Returns the map's single-item lookup result for a valid hex, or null when no item is selected there; an invalid hex throws
Item[] Map.GetItems() script.method.client.Map.GetItems Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:266 Returns all client item views currently attached to this map
Item[] Map.GetItemsOnHex(mpos hex) script.method.client.Map.GetItemsOnHex Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:274 Returns all client item views occupying a valid hex; an invalid hex throws
ScrollDirection Map.GetManualScroll() script.method.client.Map.GetManualScroll Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:207 Returns the manual-scroll direction flags currently consumed by this map view
mdir[] Map.GetPath(mpos fromHex, mpos toHex, int32 cut) script.method.client.Map.GetPath#11a78e57794a1f73 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:489 Finds movement directions between valid hexes, optionally stopping the endpoint cut hexes short; returns an empty array when no movement or path is available
mdir[] Map.GetPath(mpos fromHex, mpos toHex, int32 cut, callback(bool,Item) gagCallback) script.method.client.Map.GetPath#2f15d4b55a4ef07c Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:569 Finds movement directions between valid hexes while the callback may pass gag items; returns an empty array when no movement or path is available
mdir[] Map.GetPath(Critter cr, mpos toHex, int32 cut) script.method.client.Map.GetPath#9abc1ca3612a809e Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:528 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
int32 Map.GetPathLength(mpos fromHex, mpos toHex, int32 cut) script.method.client.Map.GetPathLength#39f192296d8a7003 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:612 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
int32 Map.GetPathLength(Critter cr, mpos toHex, int32 cut) script.method.client.Map.GetPathLength#b62c50c709a20fb8 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:647 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
int32 Map.GetRoofNum(mpos hex) script.method.client.Map.GetRoofNum Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:1039 Returns the roof group number at a valid map hex; an out-of-range coordinate throws
isize Map.GetScreenSize() script.method.client.Map.GetScreenSize Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:179 Returns the current pixel size of the map view's rendering viewport
mpos[] Map.GetVisibleHexes() script.method.client.Map.GetVisibleHexes Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:901 Returns every map hex currently selected for drawing by this view
MapLayers Map.GetVisibleLayers() script.method.client.Map.GetVisibleLayers Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:221 Returns the set of layers currently visible in this map view
bool Map.IsAutoScrolling() script.method.client.Map.IsAutoScrolling Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:711 Returns whether this map view is currently performing an automatic scroll
bool Map.IsHexMovable(mpos hex) script.method.client.Map.IsHexMovable Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:933 Returns whether movement is currently unblocked on a valid hex; an invalid hex throws
bool Map.IsHexShootable(mpos hex) script.method.client.Map.IsHexShootable Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:944 Returns whether shooting is currently unblocked through a valid hex; an invalid hex throws
bool Map.IsHexValid(mpos hex) script.method.client.Map.IsHexValid Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:894 Returns whether the supplied hex lies inside this map's dimensions without throwing for an invalid coordinate
bool Map.IsHexVisible(mpos hex) script.method.client.Map.IsHexVisible Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:922 Returns the client visibility flag stored for a valid hex; an invalid hex throws
bool Map.IsOutsideArea(mpos hex) script.method.client.Map.IsOutsideArea Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:955 Returns whether a valid hex lies outside the map's configured playable area; an invalid hex throws
bool Map.IsScrollCheck() script.method.client.Map.IsScrollCheck Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:193 Returns the map view's current scroll-check flag
bool Map.MoveHexByDir(mpos& hex, mdir dir) script.method.client.Map.MoveHexByDir#62392271e1b42030 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:718 Moves a hex one cell in the requested direction when the destination remains inside the map, updates the argument, and reports success
int32 Map.MoveHexByDir(mpos& hex, mdir dir, int32 steps) script.method.client.Map.MoveHexByDir#b39016610645244b Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:730 Moves a hex up to the requested number of in-bounds cells in one direction, updates the argument, and returns the completed step count
void Map.MoveScreenToHex(mpos hex, ipos16 hex_offset, int32 speed, bool canStop) script.method.client.Map.MoveScreenToHex Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:685 Scrolls the view toward a valid hex using the supplied offset and nonnegative speed; speed zero jumps immediately and ignores the offset
void Map.RebuildFog() script.method.client.Map.RebuildFog Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:165 Rebuilds this map view's fog geometry and rendering state from its current fog layers
void Map.RedrawMap() script.method.client.Map.RedrawMap Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:748 Rebuilds the map view's renderable map state from its current client-side contents
SpritePattern? Map.RunSpritePattern(string spriteName, int32 spriteCount) script.method.client.Map.RunSpritePattern Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:996 Starts a named sprite pattern with a positive frame count and returns its controller, or null when the pattern cannot be created
void Map.SetDayColors(ucolor mapDayColor, int32 mapLightCapacity, ucolor globalDayColor, int32 globalLightCapacity) script.method.client.Map.SetDayColors Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:172 Replaces the map-local and global day colors together with their light-capacity values for this client map view
void Map.SetExtraScrollOffset(fpos offset) script.method.client.Map.SetExtraScrollOffset Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:235 Sets a script-owned transient camera offset applied on top of ordinary map scrolling
void Map.SetHiddenRoof(mpos hex) script.method.client.Map.SetHiddenRoof Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:1032 Sets the hex used by this map view's roof-hiding logic
void Map.SetManualScroll(ScrollDirection dirs) script.method.client.Map.SetManualScroll Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:214 Replaces the manual-scroll direction flags consumed by this map view
void Map.SetScreenSize(isize size) script.method.client.Map.SetScreenSize Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:186 Sets the pixel size used by this map view for projection, visibility, and rendering
void Map.SetScrollCheck(bool enabled) script.method.client.Map.SetScrollCheck Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:200 Enables or disables the map view's scroll-check behavior
void Map.SetTransparentEgg(TransparentEggSlot slot, mpos hex, ipos hexOffset, isize eggSize, TransparentEggTarget target) script.method.client.Map.SetTransparentEgg#b6b974b26dd5da96 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:824 Configures a transparent-egg slot around an explicit hex-relative rectangle without attaching it to a critter
void Map.SetTransparentEgg(TransparentEggSlot slot, Critter? cr) script.method.client.Map.SetTransparentEgg#d4f73ea0d2898f79 Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:831 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
void Map.SetVisibleLayers(MapLayers layers) script.method.client.Map.SetVisibleLayers Map client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ClientMapScriptMethods.cpp:228 Replaces the set of layers visible in this map view

Game (common)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
bool Game.AndroidBuild() script.method.common.Game.AndroidBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:84 Reports whether this binary targets Android
void Game.BreakIntoDebugger() script.method.common.Game.BreakIntoDebugger Game server, client, mapper internal (explicit)
contract source: Source/Scripting/CommonGlobalScriptMethods.cpp:214
Development-only debugger trap; intentionally not an embedding-project compatibility contract		 - Source/Scripting/CommonGlobalScriptMethods.cpp:216 Triggers the platform debugger break primitive for the current process
bool Game.CheckProtoCritter(hstring pid) script.method.common.Game.CheckProtoCritter Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:612 Returns whether a critter prototype with the supplied id is registered
bool Game.CheckProtoItem(hstring pid) script.method.common.Game.CheckProtoItem Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:557 Returns whether an item prototype with the supplied id is registered
bool Game.CheckProtoLocation(hstring pid) script.method.common.Game.CheckProtoLocation Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:722 Returns whether a location prototype with the supplied id is registered
bool Game.CheckProtoMap(hstring pid) script.method.common.Game.CheckProtoMap Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:667 Returns whether a map prototype with the supplied id is registered
int32 Game.CountTimeEvent(callback(void,any) func) script.method.common.Game.CountTimeEvent#3f402d7af9d733a8 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:931 Counts all time events on this Engine instance that use the selected callback
int32 Game.CountTimeEvent(callback(void,TimeEventContext) func) script.method.common.Game.CountTimeEvent#93f88715f57381d8 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:945 Counts all time events on this Engine instance that use the selected context callback
int32 Game.CountTimeEvent(callback(void) func) script.method.common.Game.CountTimeEvent#a7d6bf3965b779f9 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:924 Counts all time events on this Engine instance that use the selected callback
int32 Game.CountTimeEvent(callback(void,any[]) func) script.method.common.Game.CountTimeEvent#b5319e6dc3f86b0f Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:938 Counts all time events on this Engine instance that use the selected callback
int32 Game.CountTimeEvent(uint32 id) script.method.common.Game.CountTimeEvent#e41a67022275199d Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:952 Returns one when this Engine instance owns a time event with the supplied id, or zero when it is absent
string Game.CurrentLanguage() script.method.common.Game.CurrentLanguage Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:156 Returns the language pack currently owned by this Engine instance
bool Game.DebugBuild() script.method.common.Game.DebugBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:147 Reports whether this is a native Debug build
uint32 Game.DecodeUtf8(string text, int32& length) script.method.common.Game.DecodeUtf8 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:326 Decodes the first UTF-8 code point from the supplied text, writes the consumed byte count, and returns the Unicode scalar value
bool Game.DesktopBuild() script.method.common.Game.DesktopBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:102 Reports whether this binary targets a desktop platform
int32 Game.DivRem(int32 dividend, int32 divisor, int32& remainder) script.method.common.Game.DivRem Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:821 Divides two signed integers, writes the remainder, and returns the quotient
string Game.EncodeUtf8(uint32 ucs) script.method.common.Game.EncodeUtf8 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:339 Encodes one Unicode scalar value as a UTF-8 string
string=>uint64 Game.GetAllocatorStatistics() script.method.common.Game.GetAllocatorStatistics Game server, client, mapper experimental (explicit)
since 2022.1.0.wip
contract source: Source/Scripting/CommonGlobalScriptMethods.cpp:181
Opt-in diagnostic snapshot; availability and allocator scope are not a whole-process memory contract		 - Source/Scripting/CommonGlobalScriptMethods.cpp:183 Returns module-global rpmalloc pages and calling-thread size-class capacities, or an empty dictionary when diagnostics are unavailable
string Game.GetClipboardText() script.method.common.Game.GetClipboardText Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:526 Returns text currently provided by the host application's clipboard integration
int16 Game.GetDirAngleDiff(mdir dir1, mdir dir2) script.method.common.Game.GetDirAngleDiff Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:420 Returns the rounded signed shortest angular difference between two map directions in degrees
mdir Game.GetDirection(mpos fromHex, mpos toHex, float32 offset = 0.0f) script.method.common.Game.GetDirection Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:377 Returns the rounded angular map direction from one hex to another after applying the optional degree offset
int32 Game.GetDistance(mpos hex1, mpos hex2) script.method.common.Game.GetDistance Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:368 Returns the hex-grid distance between two map positions
void Game.GetHexInterval(mpos fromHex, mpos toHex, ipos& hexOffset) script.method.common.Game.GetHexInterval Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:429 Writes the pixel-space hex-grid offset from one map position to another
LanguageName Game.GetLanguage() script.method.common.Game.GetLanguage Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:875 Returns the language configured for this Engine instance as a hashed LanguageName
mdir Game.GetLineDirAngle(ipos fromPos, ipos toPos) script.method.common.Game.GetLineDirAngle Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:386 Returns the rounded angular direction of a line between two integer pixel positions
timespan Game.GetModelAnimDuration(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim) script.method.common.Game.GetModelAnimDuration Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:295 Returns the baked duration for a model's state/action animation tuple, or zero when the model metadata, tuple, or 3D support is unavailable
nanotime Game.GetPrecisionTime() script.method.common.Game.GetPrecisionTime Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:764 Returns the current high-resolution monotonic time point for measuring process-local elapsed time
ProtoCritter Game.GetProtoCritter(hstring pid) script.method.common.Game.GetProtoCritter Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:599 Returns the registered critter prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoCritter
ProtoCritter[] Game.GetProtoCritters() script.method.common.Game.GetProtoCritters#5e6c5c33c1f46eab Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:619 Returns handles to every registered critter prototype
ProtoCritter[] Game.GetProtoCritters(CritterProperty property, int32 propertyValue) script.method.common.Game.GetProtoCritters#b2a34033b30fd6e4 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:635 Returns registered critter prototypes whose selected integer-convertible property equals the supplied value
ProtoItem Game.GetProtoItem(hstring pid) script.method.common.Game.GetProtoItem Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:544 Returns the registered item prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoItem
ProtoItem[] Game.GetProtoItems() script.method.common.Game.GetProtoItems#dadf6ac4c721c1c3 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:564 Returns handles to every registered item prototype
ProtoItem[] Game.GetProtoItems(ItemProperty property, int32 propertyValue) script.method.common.Game.GetProtoItems#ebadf2a9b94bef13 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:580 Returns registered item prototypes whose selected integer-convertible property equals the supplied value
ProtoLocation Game.GetProtoLocation(hstring pid) script.method.common.Game.GetProtoLocation Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:709 Returns the registered location prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoLocation
ProtoLocation[] Game.GetProtoLocations() script.method.common.Game.GetProtoLocations#1b5286830c6298ad Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:729 Returns handles to every registered location prototype
ProtoLocation[] Game.GetProtoLocations(LocationProperty property, int32 propertyValue) script.method.common.Game.GetProtoLocations#77f203867b4d1242 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:745 Returns registered location prototypes whose selected integer-convertible property equals the supplied value
ProtoMap Game.GetProtoMap(hstring pid) script.method.common.Game.GetProtoMap Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:654 Returns the registered map prototype for the supplied id; an unknown id throws and can be tested first with CheckProtoMap
ProtoMap[] Game.GetProtoMaps() script.method.common.Game.GetProtoMaps#278f6581638f2219 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:674 Returns handles to every registered map prototype
ProtoMap[] Game.GetProtoMaps(MapProperty property, int32 propertyValue) script.method.common.Game.GetProtoMaps#54a26bee3bd9428d Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:690 Returns registered map prototypes whose selected integer-convertible property equals the supplied value
uint64 Game.GetUnixTime() script.method.common.Game.GetUnixTime Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:359 Returns the current Unix timestamp in whole seconds
string Game.GitBranch() script.method.common.Game.GitBranch Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:163 Returns the source branch recorded when this binary was built
string Game.GitCommit() script.method.common.Game.GitCommit Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:172 Returns the source revision recorded when this binary was built
bool Game.IOsBuild() script.method.common.Game.IOsBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:93 Reports whether this binary targets iOS
ImGui Game.ImGui() script.method.common.Game.ImGui Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonImGuiScriptMethods.cpp:114 Returns the Engine ImGui script facade during an active ImGui frame; throws when no context or frame scope is available
bool Game.IsImGuiAvailable() script.method.common.Game.IsImGuiAvailable Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:131 Returns whether an ImGui context exists and is currently inside an active frame scope
bool Game.IsResourcePresent(string resourcePath) script.method.common.Game.IsResourcePresent Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:261 Returns whether the Engine resource provider can resolve a file at the supplied resource path
bool Game.LinuxBuild() script.method.common.Game.LinuxBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:66 Reports whether this binary targets Linux
void Game.Log(string text) script.method.common.Game.Log Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:225 Writes the supplied text as one Engine log message
void Game.LogError(string text) script.method.common.Game.LogError Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:243 Writes the supplied text as one error-level Engine log message
void Game.LogWarning(string text) script.method.common.Game.LogWarning Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:234 Writes the supplied text as one warning-level Engine log message
bool Game.MacOsBuild() script.method.common.Game.MacOsBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:75 Reports whether this binary targets macOS
int32 Game.MapDirCount() script.method.common.Game.MapDirCount Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:138 Returns the compile-time number of movement directions for the configured map geometry
bool Game.MapHexagonal() script.method.common.Game.MapHexagonal Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:120 Reports whether the configured map geometry is hexagonal
bool Game.MapSquare() script.method.common.Game.MapSquare Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:129 Reports whether the configured map geometry is square
void Game.OpenLink(string link) script.method.common.Game.OpenLink Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:350 Asks the host application to open the supplied link using its platform integration
synctime Game.PackSynchronizedTime(int32 year, int32 month, int32 day, int32 hour, int32 minute, int32 second, int32 millisecond) script.method.common.Game.PackSynchronizedTime Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:800 Converts a local calendar date through milliseconds into the Engine synchronized-time domain; an invalid date throws
nanotime Game.PackTime(int32 year, int32 month, int32 day, int32 hour, int32 minute, int32 second, int32 millisecond, int32 microsecond, int32 nanosecond) script.method.common.Game.PackTime Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:773 Converts a local calendar date and subsecond fields into the corresponding high-resolution time point; an invalid date throws
int32 Game.Random(int32 minValue, int32 maxValue) script.method.common.Game.Random Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:319 Returns an Engine random integer in the inclusive range defined by the supplied minimum and maximum
string=>string Game.ReadConfigSection(string resourcePath, string sectionName) script.method.common.Game.ReadConfigSection Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:275 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
string Game.ReadResource(string resourcePath) script.method.common.Game.ReadResource Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:268 Reads and returns a text file through the Engine resource provider
void Game.RepeatTimeEvent(uint32 id, timespan repeat) script.method.common.Game.RepeatTimeEvent#28154675b58100aa Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1022 Sets the repeat interval for the event with this id and reschedules its next firing from now; does nothing when it is absent
void Game.RepeatTimeEvent(callback(void,any[]) func, timespan repeat) script.method.common.Game.RepeatTimeEvent#652b690f3dfe13f6 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1008 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Game.RepeatTimeEvent(callback(void) func, timespan repeat) script.method.common.Game.RepeatTimeEvent#9e12c325ddb90694 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:994 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Game.RepeatTimeEvent(callback(void,TimeEventContext) func, timespan repeat) script.method.common.Game.RepeatTimeEvent#a65d2cbccf611310 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1015 Sets the repeat interval for every matching context-callback event and reschedules each next firing from now; does nothing when none match
void Game.RepeatTimeEvent(callback(void,any) func, timespan repeat) script.method.common.Game.RepeatTimeEvent#fc48af159fae9e5d Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1001 Sets the repeat interval for every matching callback event and reschedules each next firing from now; does nothing when none match
void Game.RequestQuit(bool success = true) script.method.common.Game.RequestQuit Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:252 Requests application shutdown and marks the eventual process result as success or failure according to the argument
mdir Game.RotateDirAngle(mdir dir, bool clockwise, int16 step) script.method.common.Game.RotateDirAngle Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:395 Rotates an angular direction clockwise or counterclockwise by the supplied degree step and normalizes it to the zero-through-359 range
void Game.SetClipboardText(string text) script.method.common.Game.SetClipboardText Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:535 Replaces text in the host application's clipboard through its platform integration
void Game.SetTimeEventData(callback(void,TimeEventContext) func, any data) script.method.common.Game.SetTimeEventData#663f5a321c3707f7 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1043 Replaces the single context payload value for every time event using the selected callback; does nothing when none match
void Game.SetTimeEventData(uint32 id, any data) script.method.common.Game.SetTimeEventData#995b7ca79df38c35 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1057 Replaces the single payload value for the time event with this id; does nothing when it is absent
void Game.SetTimeEventData(uint32 id, any[] data) script.method.common.Game.SetTimeEventData#adb2b4962b8e3874 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1064 Replaces the payload array for the time event with this id; does nothing when it is absent
void Game.SetTimeEventData(callback(void,TimeEventContext) func, any[] data) script.method.common.Game.SetTimeEventData#f050f171334586b4 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1050 Replaces the context payload array for every time event using the selected callback; does nothing when none match
void Game.SetTimeEventData(callback(void) func, any data) script.method.common.Game.SetTimeEventData#f19e035707634deb Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1029 Replaces the single direct payload value for every time event using the selected callback; does nothing when none match
void Game.SetTimeEventData(callback(void,any[]) func, any[] data) script.method.common.Game.SetTimeEventData#f70e313f0f2186e1 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:1036 Replaces the direct payload array for every time event using the selected callback; does nothing when none match
uint32 Game.StartTimeEvent(timespan delay, callback(void) func) script.method.common.Game.StartTimeEvent#0f8d3281846b110f Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:833 Schedules a one-shot time event on this Engine instance after the requested delay and returns its event id
uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,any[]) func, any[] data) script.method.common.Game.StartTimeEvent#2e2e75ee1f40e7ce Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:896 Schedules a repeating Engine time event with a direct callback payload array and returns its event id
uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,TimeEventContext) func, any[] data) script.method.common.Game.StartTimeEvent#3a6c8eb0039422c6 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:917 Schedules a repeating Engine time event whose callback context exposes the payload array, and returns its event id
uint32 Game.StartTimeEvent(timespan delay, callback(void,TimeEventContext) func) script.method.common.Game.StartTimeEvent#60478fb435a8d90e Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:854 Schedules a one-shot Engine time event whose callback receives a context for inspecting or modifying that event, and returns its id
uint32 Game.StartTimeEvent(timespan delay, callback(void,TimeEventContext) func, any[] data) script.method.common.Game.StartTimeEvent#69df693441c071bc Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:868 Schedules a one-shot Engine time event whose callback context exposes the payload array, and returns its event id
uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,any) func, any data) script.method.common.Game.StartTimeEvent#803750a4ea861cf2 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:889 Schedules a repeating Engine time event with one direct callback payload value and returns its event id
uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,TimeEventContext) func) script.method.common.Game.StartTimeEvent#8ff2132c2ddcab3e Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:903 Schedules a repeating Engine time event whose callback receives a context for inspecting or modifying that event, and returns its id
uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void) func) script.method.common.Game.StartTimeEvent#9c79861746d77659 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:882 Schedules a repeating time event on this Engine instance, with its first firing after delay and later firings at repeat, and returns its id
uint32 Game.StartTimeEvent(timespan delay, timespan repeat, callback(void,TimeEventContext) func, any data) script.method.common.Game.StartTimeEvent#9f7fe12a272e5705 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:910 Schedules a repeating Engine time event whose callback context exposes one payload value, and returns its event id
uint32 Game.StartTimeEvent(timespan delay, callback(void,any[]) func, any[] data) script.method.common.Game.StartTimeEvent#d2339300efa9e872 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:847 Schedules a one-shot Engine time event, passes the payload array directly to the callback, and returns its event id
uint32 Game.StartTimeEvent(timespan delay, callback(void,any) func, any data) script.method.common.Game.StartTimeEvent#e60987dfd50cb4e5 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:840 Schedules a one-shot Engine time event, passes one payload value directly to the callback, and returns its event id
uint32 Game.StartTimeEvent(timespan delay, callback(void,TimeEventContext) func, any data) script.method.common.Game.StartTimeEvent#fa4e11482a1cdbc0 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:861 Schedules a one-shot Engine time event whose callback context exposes one payload value, and returns its event id
void Game.StopTimeEvent(callback(void,any) func) script.method.common.Game.StopTimeEvent#1ed76dd699da2d1f Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:966 Stops all time events on this Engine instance that use the selected callback; does nothing when none match
void Game.StopTimeEvent(callback(void,TimeEventContext) func) script.method.common.Game.StopTimeEvent#23bd9c39e1e601b4 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:980 Stops all time events on this Engine instance that use the selected context callback; does nothing when none match
void Game.StopTimeEvent(callback(void,any[]) func) script.method.common.Game.StopTimeEvent#a22b85adc04c5b0a Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:973 Stops all time events on this Engine instance that use the selected callback; does nothing when none match
void Game.StopTimeEvent(callback(void) func) script.method.common.Game.StopTimeEvent#bc872e42a8dfd6ad Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:959 Stops all time events on this Engine instance that use the selected callback; does nothing when none match
void Game.StopTimeEvent(uint32 id) script.method.common.Game.StopTimeEvent#be90949683fff93d Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:987 Stops the time event with this id on the Engine instance; does nothing when it is absent
bool Game.TabletBuild() script.method.common.Game.TabletBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:111 Reports whether this binary targets a tablet or mobile platform
mpos[] Game.TraceHexLine(msize mapSize, mpos fromHex, mpos toHex, int32 dist, float32 dirAngleOffset, ipos startOffset, ipos targetOffset) script.method.common.Game.TraceHexLine#8955c6e7c8318b5a Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:438 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
mpos[] Game.TraceHexLine(msize mapSize, mpos fromHex, float32 dirAngle, int32 dist, ipos startOffset, ipos targetOffset, mpos& targetHex) script.method.common.Game.TraceHexLine#a8077f78b077a5f9 Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:481 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
void Game.UnpackSynchronizedTime(synctime time, int32& year, int32& month, int32& day, int32& hour, int32& minute, int32& second, int32& millisecond) script.method.common.Game.UnpackSynchronizedTime Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:807 Decomposes an Engine synchronized time point into local calendar fields through milliseconds
void Game.UnpackTime(nanotime time, int32& year, int32& month, int32& day, int32& hour, int32& minute, int32& second, int32& millisecond, int32& microsecond, int32& nanosecond) script.method.common.Game.UnpackTime Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonGlobalScriptMethods.cpp:782 Decomposes a high-resolution time point into local calendar and subsecond fields
bool Game.WebBuild() script.method.common.Game.WebBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:48 Reports whether this binary targets the Web platform
bool Game.WindowsBuild() script.method.common.Game.WindowsBuild Game server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 GlobalGetter Source/Scripting/CommonGlobalScriptMethods.cpp:57 Reports whether this binary targets Windows

ImGui (common)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
void ImGui.AlignTextToFramePadding() script.method.common.ImGui.AlignTextToFramePadding ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:318 Advances the current line baseline so subsequent text aligns vertically with framed widgets
bool ImGui.ArrowButton(string strId, ImGui_Dir dir) script.method.common.ImGui.ArrowButton ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1227 Draws a square arrow button with a required nonempty ID and returns whether it was activated
bool ImGui.Begin(string label, ImGui_WindowFlags flags = ImGui_WindowFlags::None) script.method.common.ImGui.Begin#432e0a449bff3d19 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:141 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
bool ImGui.Begin(string label, bool& opened, ImGui_WindowFlags flags = ImGui_WindowFlags::None) script.method.common.ImGui.Begin#d84f88f92ac145e9 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:152 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
bool ImGui.BeginChild(string strId, isize size, ImGui_ChildFlags childFlags, ImGui_WindowFlags windowFlags) script.method.common.ImGui.BeginChild#91e43db0a33e8f18 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1125 Begins a required nonempty-ID child region with explicit child and window flags; always pair with EndChild regardless of the return value
bool ImGui.BeginChild(string strId, isize size, bool border) script.method.common.ImGui.BeginChild#ec21177b87910173 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1114 Begins a required nonempty-ID child region with optional border and supplied size; always pair with EndChild regardless of the return value
bool ImGui.BeginCombo(string label, string previewValue, ImGui_ComboFlags flags = ImGui_ComboFlags::None) script.method.common.ImGui.BeginCombo ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1884 Begins a required nonempty-label custom combo using previewValue and flags, returning whether popup contents may be submitted; call EndCombo only when true
void ImGui.BeginDisabled(bool disabled = true) script.method.common.ImGui.BeginDisabled ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2317 Begins a disabled scope when requested while still pushing a balanced scope when false; always pair with EndDisabled
void ImGui.BeginGroup() script.method.common.ImGui.BeginGroup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:669 Begins grouping subsequent items into one composite layout and interaction bounding box
bool ImGui.BeginItemTooltip() script.method.common.ImGui.BeginItemTooltip ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1440 Begins a tooltip when the last item is hovered and returns whether it opened; call EndTooltip only when true
bool ImGui.BeginListBox(string label, isize size = isize()) script.method.common.ImGui.BeginListBox ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1914 Begins a required nonempty-label list box of the supplied size and returns whether contents may be submitted; call EndListBox only when true
bool ImGui.BeginMainMenuBar() script.method.common.ImGui.BeginMainMenuBar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1573 Begins the main viewport menu bar and returns whether contents may be submitted; call EndMainMenuBar only when true
bool ImGui.BeginMenu(string label, bool enabled = true) script.method.common.ImGui.BeginMenu ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1601 Begins a required nonempty-label enabled or disabled menu and returns whether it is open; call EndMenu only when true
bool ImGui.BeginMenuBar() script.method.common.ImGui.BeginMenuBar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1587 Begins the current window's menu bar and returns whether contents may be submitted; call EndMenuBar only when true
bool ImGui.BeginPopup(string strId, ImGui_WindowFlags flags = ImGui_WindowFlags::None) script.method.common.ImGui.BeginPopup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1479 Begins a required nonempty-ID nonmodal popup and returns whether to submit its contents; call EndPopup only when true
bool ImGui.BeginPopupContextItem(string strId = "", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None) script.method.common.ImGui.BeginPopupContextItem ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1512 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
bool ImGui.BeginPopupContextVoid(string strId = "", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::MouseButtonRight) script.method.common.ImGui.BeginPopupContextVoid ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1530 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
bool ImGui.BeginPopupContextWindow(string strId = "", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None) script.method.common.ImGui.BeginPopupContextWindow ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1521 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
bool ImGui.BeginPopupModal(string name, bool& opened, ImGui_WindowFlags flags) script.method.common.ImGui.BeginPopupModal#1e97b73df215a7fc ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1501 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
bool ImGui.BeginPopupModal(string name) script.method.common.ImGui.BeginPopupModal#d6ec4d0ad6e4297f ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1490 Begins a required nonempty-name modal popup and returns whether to submit its contents; call EndPopup only when true
bool ImGui.BeginTabBar(string strId, ImGui_TabBarFlags flags = ImGui_TabBarFlags::None) script.method.common.ImGui.BeginTabBar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1771 Begins a tab bar with a required nonempty ID and returns whether contents may be submitted; call EndTabBar only when true
bool ImGui.BeginTabItem(string label, ImGui_TabItemFlags flags = ImGui_TabItemFlags::None) script.method.common.ImGui.BeginTabItem#8769abbb356a8660 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1789 Begins a required nonempty-label tab item and returns whether its contents are visible; call EndTabItem only when true
bool ImGui.BeginTabItem(string label, bool& opened, ImGui_TabItemFlags flags = ImGui_TabItemFlags::None) script.method.common.ImGui.BeginTabItem#99825a7be7e7e25c ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1800 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
bool ImGui.BeginTable(string strId, int32 columns, ImGui_TableFlags flags = ImGui_TableFlags::None) script.method.common.ImGui.BeginTable ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1630 Begins a table with a required nonempty ID and positive column count, returning whether contents may be submitted; call EndTable only when true
bool ImGui.BeginTooltip() script.method.common.ImGui.BeginTooltip ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1454 Begins an unconditional tooltip window; pair it with EndTooltip
void ImGui.Bullet() script.method.common.ImGui.Bullet ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:500 Emits a standalone bullet and advances the cursor on the same line for following content
void ImGui.BulletText(string text) script.method.common.ImGui.BulletText ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1948 Renders the supplied text preceded by an ImGui bullet
bool ImGui.Button(string label) script.method.common.ImGui.Button ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:602 Draws a required nonempty-label button and returns whether it was activated
float32 ImGui.CalcItemWidth() script.method.common.ImGui.CalcItemWidth ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:641 Resolves and returns the width ImGui would use for the next item
fsize ImGui.CalcTextSize(string text, bool hideTextAfterDoubleHash = false, float32 wrapWidth = -1.0f) script.method.common.ImGui.CalcTextSize ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:310 Measures text using the current font, optionally hiding the ID suffix after ## and wrapping at the supplied width
bool ImGui.Checkbox(string label, bool& value) script.method.common.ImGui.Checkbox ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:683 Draws a required nonempty-label checkbox, updates value on interaction, and returns whether it changed
bool ImGui.CheckboxFlags(string label, int32& flags, int32 flagsValue) script.method.common.ImGui.CheckboxFlags#458f2952235bd5d1 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:694 Draws a required nonempty-label checkbox that toggles the selected signed flag bits and returns whether flags changed
bool ImGui.CheckboxFlags(string label, uint32& flags, uint32 flagsValue) script.method.common.ImGui.CheckboxFlags#f574f68257656ebd ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:705 Draws a required nonempty-label checkbox that toggles the selected unsigned flag bits and returns whether flags changed
void ImGui.CloseCurrentPopup() script.method.common.ImGui.CloseCurrentPopup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1546 Requests closure of the current popup at the end of the frame
bool ImGui.CollapsingHeader(string label, ImGui_TreeNodeFlags flags = ImGui_TreeNodeFlags::None) script.method.common.ImGui.CollapsingHeader ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1143 Draws a required nonempty-label collapsing header and returns whether its contents are visible; it does not push a tree scope
bool ImGui.ColorButton(string descId, ucolor color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None, fsize size = fsize()) script.method.common.ImGui.ColorButton ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2146 Draws a color preview button with a required nonempty description ID, packed ucolor, flags, and optional size, returning whether it was activated
bool ImGui.ColorEdit3(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None) script.method.common.ImGui.ColorEdit3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2070 Draws a required nonempty-label RGB editor, converts ucolor channels to floats, preserves alpha, and stores clamped 8-bit RGB only when changed
bool ImGui.ColorEdit4(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None) script.method.common.ImGui.ColorEdit4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2089 Draws a required nonempty-label RGBA editor, converts ucolor channels to floats, and stores clamped 8-bit RGBA only when changed
bool ImGui.ColorPicker3(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None) script.method.common.ImGui.ColorPicker3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2108 Draws a required nonempty-label RGB picker, converts ucolor channels to floats, preserves alpha, and stores clamped 8-bit RGB only when changed
bool ImGui.ColorPicker4(string label, ucolor& color, ImGui_ColorEditFlags flags = ImGui_ColorEditFlags::None) script.method.common.ImGui.ColorPicker4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2127 Draws a required nonempty-label RGBA picker, converts ucolor channels to floats, and stores clamped 8-bit RGBA only when changed
bool ImGui.Combo(string label, int32& currentItem, string itemsSeparatedByZeros, int32 popupMaxHeightInItems = -1) script.method.common.ImGui.Combo ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1895 Draws a required nonempty-label combo from a NUL-separated item string, updates currentItem on selection, and returns whether it changed
bool ImGui.DragFloat(string label, float32& value, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.DragFloat ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:787 Draws a required nonempty-label float drag editor with speed, bounds, three-decimal display, and slider flags; updates value and reports changes
bool ImGui.DragFloat2(string label, float32& valueX, float32& valueY, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.DragFloat2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:809 Draws a required nonempty-label two-component float drag editor and writes both components back only when they change
bool ImGui.DragFloat3(string label, float32& valueX, float32& valueY, float32& valueZ, float32 speed, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.DragFloat3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:828 Draws a required nonempty-label three-component float drag editor and writes all components back only when they change
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) script.method.common.ImGui.DragFloat4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:848 Draws a required nonempty-label four-component float drag editor and writes all components back only when they change
bool ImGui.DragInt(string label, int32& value, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.DragInt ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:798 Draws a required nonempty-label integer drag editor with speed, bounds, and slider flags; updates value and reports changes
bool ImGui.DragInt2(string label, int32& valueX, int32& valueY, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.DragInt2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:869 Draws a required nonempty-label two-component integer drag editor and writes both components back only when they change
bool ImGui.DragInt3(string label, int32& valueX, int32& valueY, int32& valueZ, float32 speed, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.DragInt3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:888 Draws a required nonempty-label three-component integer drag editor and writes all components back only when they change
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) script.method.common.ImGui.DragInt4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:908 Draws a required nonempty-label four-component integer drag editor and writes all components back only when they change
void ImGui.Dummy(isize size) script.method.common.ImGui.Dummy ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:648 Submits an invisible layout item of the supplied size
void ImGui.End() script.method.common.ImGui.End ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:163 Ends the current window begun by Begin; this is required regardless of Begin's return value
void ImGui.EndChild() script.method.common.ImGui.EndChild ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1136 Ends the current child region begun by BeginChild; this is required regardless of BeginChild's return value
void ImGui.EndCombo() script.method.common.ImGui.EndCombo ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1907 Ends custom combo contents begun by a successful BeginCombo call
void ImGui.EndDisabled() script.method.common.ImGui.EndDisabled ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2324 Ends the current scope begun by BeginDisabled
void ImGui.EndGroup() script.method.common.ImGui.EndGroup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:676 Ends the current group and exposes it as the last submitted item
void ImGui.EndListBox() script.method.common.ImGui.EndListBox ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1925 Ends a list box begun by a successful BeginListBox call
void ImGui.EndMainMenuBar() script.method.common.ImGui.EndMainMenuBar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1580 Ends a main menu bar begun by a successful BeginMainMenuBar call
void ImGui.EndMenu() script.method.common.ImGui.EndMenu ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1612 Ends a menu begun by a successful BeginMenu call
void ImGui.EndMenuBar() script.method.common.ImGui.EndMenuBar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1594 Ends a window menu bar begun by a successful BeginMenuBar call
void ImGui.EndPopup() script.method.common.ImGui.EndPopup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1539 Ends a popup begun by a successful BeginPopup, BeginPopupModal, or context-popup call
void ImGui.EndTabBar() script.method.common.ImGui.EndTabBar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1782 Ends a tab bar begun by a successful BeginTabBar call
void ImGui.EndTabItem() script.method.common.ImGui.EndTabItem ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1811 Ends a tab item begun by a successful BeginTabItem call
void ImGui.EndTable() script.method.common.ImGui.EndTable ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1644 Ends a table begun by a successful BeginTable call
void ImGui.EndTooltip() script.method.common.ImGui.EndTooltip ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1461 Ends the current tooltip begun by BeginTooltip or a successful BeginItemTooltip
string ImGui.GetClipboardText() script.method.common.ImGui.GetClipboardText ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2331 Returns text from ImGui's platform clipboard backend, or an empty string when the backend returns null
float32 ImGui.GetContentRegionAvailX() script.method.common.ImGui.GetContentRegionAvailX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:532 Returns the horizontal space available from the current cursor to the content-region boundary
float32 ImGui.GetContentRegionAvailY() script.method.common.ImGui.GetContentRegionAvailY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:539 Returns the vertical space available from the current cursor to the content-region boundary
float32 ImGui.GetCursorPosX() script.method.common.ImGui.GetCursorPosX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:546 Returns the current cursor's local X coordinate within the window
float32 ImGui.GetCursorPosY() script.method.common.ImGui.GetCursorPosY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:553 Returns the current cursor's local Y coordinate within the window
fpos ImGui.GetCursorScreenPos() script.method.common.ImGui.GetCursorScreenPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:560 Returns the current cursor position in screen coordinates
int32 ImGui.GetFrameCount() script.method.common.ImGui.GetFrameCount ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:332 Returns the ImGui frame counter narrowed to int32
float32 ImGui.GetFrameHeight() script.method.common.ImGui.GetFrameHeight ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:353 Returns the standard framed-widget height for the current font and style
float32 ImGui.GetFrameHeightWithSpacing() script.method.common.ImGui.GetFrameHeightWithSpacing ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:360 Returns the standard framed-widget height plus vertical item spacing
fpos ImGui.GetItemRectMax() script.method.common.ImGui.GetItemRectMax ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1340 Returns the maximum screen-space corner of the last submitted item's bounding rectangle
fpos ImGui.GetItemRectMin() script.method.common.ImGui.GetItemRectMin ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1333 Returns the minimum screen-space corner of the last submitted item's bounding rectangle
fsize ImGui.GetItemRectSize() script.method.common.ImGui.GetItemRectSize ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1347 Returns the size of the last submitted item's bounding rectangle
fpos ImGui.GetMouseDragDelta(ImGui_MouseButton mouseButton = ImGui_MouseButton::Left, float32 lockThreshold = -1.0f) script.method.common.ImGui.GetMouseDragDelta ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1410 Returns mouse displacement since the selected button was clicked after crossing the supplied or configured drag threshold
fpos ImGui.GetMousePos() script.method.common.ImGui.GetMousePos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1354 Returns the current ImGui mouse position in screen coordinates
fpos ImGui.GetMousePosOnOpeningCurrentPopup() script.method.common.ImGui.GetMousePosOnOpeningCurrentPopup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1361 Returns the mouse position captured when the current popup was opened
float32 ImGui.GetScrollMaxX() script.method.common.ImGui.GetScrollMaxX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:444 Returns the maximum horizontal scroll offset of the current window
float32 ImGui.GetScrollMaxY() script.method.common.ImGui.GetScrollMaxY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:451 Returns the maximum vertical scroll offset of the current window
float32 ImGui.GetScrollX() script.method.common.ImGui.GetScrollX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:416 Returns the current window's horizontal scroll offset
float32 ImGui.GetScrollY() script.method.common.ImGui.GetScrollY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:423 Returns the current window's vertical scroll offset
float32 ImGui.GetTextLineHeight() script.method.common.ImGui.GetTextLineHeight ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:339 Returns the current font's text-line height without inter-line spacing
float32 ImGui.GetTextLineHeightWithSpacing() script.method.common.ImGui.GetTextLineHeightWithSpacing ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:346 Returns the current font's text-line height including ImGui item spacing
float64 ImGui.GetTime() script.method.common.ImGui.GetTime ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:325 Returns elapsed ImGui time in seconds since context initialization
float32 ImGui.GetTreeNodeToLabelSpacing() script.method.common.ImGui.GetTreeNodeToLabelSpacing ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:518 Returns the horizontal spacing from a tree-node arrow or bullet to its label
float32 ImGui.GetWindowHeight() script.method.common.ImGui.GetWindowHeight ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:409 Returns the current window height
fpos ImGui.GetWindowPos() script.method.common.ImGui.GetWindowPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:374 Returns the current window's top-left position in screen coordinates
fsize ImGui.GetWindowSize() script.method.common.ImGui.GetWindowSize ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:381 Returns the current window's size
float32 ImGui.GetWindowWidth() script.method.common.ImGui.GetWindowWidth ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:402 Returns the current window width
void ImGui.Indent(float32 indentW = 0.0f) script.method.common.ImGui.Indent ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:655 Increases the current line's horizontal indentation by the supplied amount or the style default when zero
bool ImGui.InputFloat(string label, float32& value, float32 step = 0.0f, float32 stepFast = 0.0f, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputFloat ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2181 Draws a required nonempty-label float input with step controls, three-decimal formatting, and text-input flags; updates value and reports changes
bool ImGui.InputFloat2(string label, float32& valueX, float32& valueY, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputFloat2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2192 Draws a required nonempty-label two-component float input and writes both components back only when editing changes them
bool ImGui.InputFloat3(string label, float32& valueX, float32& valueY, float32& valueZ, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputFloat3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2211 Draws a required nonempty-label three-component float input and writes all components back only when editing changes them
bool ImGui.InputFloat4(string label, float32& valueX, float32& valueY, float32& valueZ, float32& valueW, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputFloat4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2231 Draws a required nonempty-label four-component float input and writes all components back only when editing changes them
bool ImGui.InputInt(string label, int32& value, int32 step = 1, int32 stepFast = 100, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputInt ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:716 Draws a required nonempty-label signed integer input, updates value, and returns whether editing changed it
bool ImGui.InputInt2(string label, int32& valueX, int32& valueY, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputInt2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:727 Draws a required nonempty-label two-component integer input and writes both components back only when editing changes them
bool ImGui.InputInt3(string label, int32& valueX, int32& valueY, int32& valueZ, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputInt3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:746 Draws a required nonempty-label three-component integer input and writes all components back only when editing changes them
bool ImGui.InputInt4(string label, int32& valueX, int32& valueY, int32& valueZ, int32& valueW, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputInt4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:766 Draws a required nonempty-label four-component integer input and writes all components back only when editing changes them
bool ImGui.InputText(string label, string& value, uint32 maxLength, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputText ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2252 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
bool ImGui.InputTextMultiline(string label, string& value, uint32 maxLength, isize size, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputTextMultiline ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2273 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
bool ImGui.InputTextWithHint(string label, string hint, string& value, uint32 maxLength, ImGui_InputTextFlags flags = ImGui_InputTextFlags::None) script.method.common.ImGui.InputTextWithHint ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2294 Draws a required nonempty-label text input with hint backed by maxLength bytes, rejecting invalid capacity and writing value back only on change
bool ImGui.InvisibleButton(string strId, fsize size, ImGui_ButtonFlags flags = ImGui_ButtonFlags::None) script.method.common.ImGui.InvisibleButton ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1238 Submits an invisible button with a required nonempty ID, explicit size, and button flags, and returns whether it was activated
bool ImGui.IsAnyItemActive() script.method.common.ImGui.IsAnyItemActive ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:493 Returns whether any ImGui item is currently active
bool ImGui.IsAnyItemFocused() script.method.common.ImGui.IsAnyItemFocused ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1291 Returns whether any ImGui item currently owns keyboard focus
bool ImGui.IsAnyItemHovered() script.method.common.ImGui.IsAnyItemHovered ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:486 Returns whether any ImGui item is currently hovered
bool ImGui.IsItemActivated() script.method.common.ImGui.IsItemActivated ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1263 Returns whether the last submitted item became active this frame
bool ImGui.IsItemActive() script.method.common.ImGui.IsItemActive ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1312 Returns whether the last submitted item is currently active
bool ImGui.IsItemClicked(ImGui_MouseButton mouseButton = ImGui_MouseButton::Left) script.method.common.ImGui.IsItemClicked ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1256 Returns whether the last submitted item was clicked with the selected mouse button this frame
bool ImGui.IsItemDeactivated() script.method.common.ImGui.IsItemDeactivated ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1270 Returns whether the last submitted item stopped being active this frame
bool ImGui.IsItemDeactivatedAfterEdit() script.method.common.ImGui.IsItemDeactivatedAfterEdit ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1277 Returns whether the last submitted item stopped being active this frame after its value was edited
bool ImGui.IsItemEdited() script.method.common.ImGui.IsItemEdited ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1319 Returns whether the last submitted item's value was edited this frame
bool ImGui.IsItemHovered(ImGui_HoveredFlags flags = ImGui_HoveredFlags::None) script.method.common.ImGui.IsItemHovered ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1249 Returns whether the last submitted item is hovered under the supplied hover flags
bool ImGui.IsItemToggledOpen() script.method.common.ImGui.IsItemToggledOpen ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1284 Returns whether the last submitted tree node or collapsing header toggled its open state this frame
bool ImGui.IsItemVisible() script.method.common.ImGui.IsItemVisible ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1326 Returns whether the last submitted item overlaps the current clipping rectangle
bool ImGui.IsMouseClicked(ImGui_MouseButton mouseButton) script.method.common.ImGui.IsMouseClicked ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1375 Returns whether the selected mouse button was clicked this frame
bool ImGui.IsMouseDoubleClicked(ImGui_MouseButton mouseButton) script.method.common.ImGui.IsMouseDoubleClicked ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1389 Returns whether the selected mouse button registered a double-click this frame
bool ImGui.IsMouseDown(ImGui_MouseButton mouseButton) script.method.common.ImGui.IsMouseDown ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1368 Returns whether the selected mouse button is currently held down
bool ImGui.IsMouseDragging(ImGui_MouseButton mouseButton, float32 lockThreshold = -1.0f) script.method.common.ImGui.IsMouseDragging ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1403 Returns whether the selected mouse button is dragging beyond the supplied threshold, or the configured threshold when negative
bool ImGui.IsMouseHoveringRect(fpos rectMin, fpos rectMax, bool clip = true) script.method.common.ImGui.IsMouseHoveringRect ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1396 Returns whether the mouse is inside the supplied screen-space rectangle, optionally intersected with the current clip rectangle
bool ImGui.IsMouseReleased(ImGui_MouseButton mouseButton) script.method.common.ImGui.IsMouseReleased ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1382 Returns whether the selected mouse button was released this frame
bool ImGui.IsPopupOpen(string strId, ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None) script.method.common.ImGui.IsPopupOpen ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1553 Returns whether a popup matching the required nonempty ID is open under the supplied query flags
bool ImGui.IsRectVisible(fsize size) script.method.common.ImGui.IsRectVisible#05fb9e94e4abfe05 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:388 Returns whether a rectangle of the supplied size at the current cursor position overlaps the current clipping rectangle
bool ImGui.IsRectVisible(fpos rectMin, fpos rectMax) script.method.common.ImGui.IsRectVisible#417dc43e9e79eea8 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:395 Returns whether the supplied screen-space rectangle overlaps the current clipping rectangle
bool ImGui.IsWindowAppearing() script.method.common.ImGui.IsWindowAppearing ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:367 Returns whether the current window has just appeared after being hidden, inactive, or newly created
bool ImGui.IsWindowFocused(ImGui_FocusedFlags flags = ImGui_FocusedFlags::None) script.method.common.ImGui.IsWindowFocused ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1298 Returns whether the current window is focused under the supplied focus flags
bool ImGui.IsWindowHovered(ImGui_HoveredFlags flags = ImGui_HoveredFlags::None) script.method.common.ImGui.IsWindowHovered ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1305 Returns whether the current window is hovered under the supplied hover flags
void ImGui.LoadIniSettingsFromDisk(string iniFilename) script.method.common.ImGui.LoadIniSettingsFromDisk ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2346 Loads ImGui window and table settings from a required nonempty filesystem path using ImGui's direct disk API
void ImGui.LoadIniSettingsFromMemory(string iniData) script.method.common.ImGui.LoadIniSettingsFromMemory ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2368 Replaces ImGui window and table settings from the exact supplied in-memory ini bytes
void ImGui.LogButtons() script.method.common.ImGui.LogButtons ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1870 Draws ImGui's logging controls for starting and stopping supported log destinations
void ImGui.LogFinish() script.method.common.ImGui.LogFinish ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1863 Finishes the active ImGui logging session and flushes its destination
void ImGui.LogText(string text) script.method.common.ImGui.LogText ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1877 Appends the supplied text verbatim to the active ImGui logging destination without rendering a widget
void ImGui.LogToClipboard(int32 autoOpenDepth = -1) script.method.common.ImGui.LogToClipboard ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1856 Starts automatic ImGui text logging to the clipboard with optional tree auto-open depth
void ImGui.LogToFile(int32 autoOpenDepth = -1, string filename = "") script.method.common.ImGui.LogToFile ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1848 Starts automatic ImGui text logging to the optional filename, or the configured default when empty, with optional tree auto-open depth
void ImGui.LogToTTY(int32 autoOpenDepth = -1) script.method.common.ImGui.LogToTTY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1841 Starts automatic ImGui text logging to the terminal, optionally auto-opening tree nodes to the supplied depth
bool ImGui.MenuItem(string label, bool selected = false, bool enabled = true) script.method.common.ImGui.MenuItem ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1619 Draws a required nonempty-label menu item with display-only selected state and enabled state, returning whether it was activated
void ImGui.NewLine() script.method.common.ImGui.NewLine ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1107 Ends the current line and advances the layout cursor to a new line
void ImGui.OpenPopup(string strId, ImGui_PopupFlags popupFlags = ImGui_PopupFlags::None) script.method.common.ImGui.OpenPopup ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1468 Marks a popup with the required nonempty ID to open on the next matching BeginPopup call
void ImGui.OpenPopupOnItemClick(string strId = "", ImGui_PopupFlags popupFlags = ImGui_PopupFlags::MouseButtonRight) script.method.common.ImGui.OpenPopupOnItemClick ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1564 Opens a context popup when the last item is clicked under the supplied flags, using the last item's ID when strId is empty
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()) script.method.common.ImGui.PlotHistogram ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2006 Draws a required nonempty-label histogram over the supplied values with offset, optional overlay, scale bounds, and graph size
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()) script.method.common.ImGui.PlotLines ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1993 Draws a required nonempty-label line plot over the supplied values with offset, optional overlay, scale bounds, and graph size
void ImGui.PopID() script.method.common.ImGui.PopID ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:191 Pops the most recently pushed component from the ImGui ID stack
void ImGui.PopItemWidth() script.method.common.ImGui.PopItemWidth ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:634 Restores the previous default item width
void ImGui.PopStyleColor(int32 count = 1) script.method.common.ImGui.PopStyleColor ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:205 Pops count entries from the ImGui style-color stack
void ImGui.PopStyleVar(int32 count = 1) script.method.common.ImGui.PopStyleVar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:226 Pops count entries from the ImGui style-variable stack
void ImGui.PopTextWrapPos() script.method.common.ImGui.PopTextWrapPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:588 Restores the previous text-wrapping position
void ImGui.ProgressBar(float32 fraction) script.method.common.ImGui.ProgressBar#815e8744ccf75287 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1932 Draws a progress bar using fraction as the completion ratio and ImGui's default size and overlay
void ImGui.ProgressBar(float32 fraction, isize size, string overlay = "") script.method.common.ImGui.ProgressBar#f96f13b84ae54c68 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1939 Draws a progress bar with the supplied completion ratio and size, using an explicit overlay or ImGui's percentage text when empty
void ImGui.PushID(string strId) script.method.common.ImGui.PushID#a0aa657cec446999 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:171 Pushes a required nonempty string component onto the ImGui ID stack
void ImGui.PushID(int32 intId) script.method.common.ImGui.PushID#e81ac04f2708cf59 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:183 Pushes an integer component onto the ImGui ID stack
void ImGui.PushItemWidth(float32 itemWidth) script.method.common.ImGui.PushItemWidth ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:627 Pushes a default width for subsequent items; restore it with PopItemWidth
void ImGui.PushStyleColor(ImGui_Col colorId, float32 r, float32 g, float32 b, float32 a) script.method.common.ImGui.PushStyleColor ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:198 Pushes an RGBA override for the selected ImGui style color; restore it with PopStyleColor
void ImGui.PushStyleVar(ImGui_StyleVar styleVar, float32 value) script.method.common.ImGui.PushStyleVar ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:212 Pushes a scalar override for a scalar-valued ImGui style variable; restore it with PopStyleVar
void ImGui.PushStyleVarVec2(ImGui_StyleVar styleVar, float32 x, float32 y) script.method.common.ImGui.PushStyleVarVec2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:219 Pushes a two-component override for a vector-valued ImGui style variable; restore it with PopStyleVar
void ImGui.PushTextWrapPos(float32 wrapLocalPosX = 0.0f) script.method.common.ImGui.PushTextWrapPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:581 Pushes a local X coordinate at which subsequent text wraps; zero uses the content-region boundary
bool ImGui.RadioButton(string label, int32& value, int32 buttonValue) script.method.common.ImGui.RadioButton#91a4f0c54483dccb ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1205 Draws a required nonempty-label radio button, assigns buttonValue to value when activated, and returns whether the assignment occurred
bool ImGui.RadioButton(string label, bool active) script.method.common.ImGui.RadioButton#d8d7646ac97bdd7b ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1194 Draws a required nonempty-label radio button using active as display state and returns whether it was activated; active is not written back
void ImGui.ResetMouseDragDelta(ImGui_MouseButton mouseButton = ImGui_MouseButton::Left) script.method.common.ImGui.ResetMouseDragDelta ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1417 Resets the accumulated drag origin for the selected mouse button to the current mouse position
void ImGui.SameLine(float32 offsetFromStartX = 0.0f, float32 spacing = -1.0f) script.method.common.ImGui.SameLine ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:613 Places the next item on the current line with optional start offset and spacing overrides
void ImGui.SaveIniSettingsToDisk(string iniFilename) script.method.common.ImGui.SaveIniSettingsToDisk ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2357 Saves current ImGui window and table settings to a required nonempty filesystem path using ImGui's direct disk API
string ImGui.SaveIniSettingsToMemory() script.method.common.ImGui.SaveIniSettingsToMemory ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2375 Serializes current ImGui window and table settings to a string, or returns an empty string when ImGui supplies no buffer
bool ImGui.Selectable(string label, bool selected = false, ImGui_SelectableFlags flags = ImGui_SelectableFlags::None) script.method.common.ImGui.Selectable ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1183 Draws a required nonempty-label selectable using selected as display state and returns whether it was activated; selected is not written back
void ImGui.Separator() script.method.common.ImGui.Separator ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1093 Draws a separator appropriate to the current horizontal or vertical layout context
void ImGui.SeparatorText(string label) script.method.common.ImGui.SeparatorText ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:507 Draws a separator carrying a required nonempty label
void ImGui.SetClipboardText(string text) script.method.common.ImGui.SetClipboardText ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2339 Replaces text in ImGui's platform clipboard backend
void ImGui.SetColorEditOptions(ImGui_ColorEditFlags flags) script.method.common.ImGui.SetColorEditOptions ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2159 Sets default display, data-type, picker, and input options for subsequent color editors and pickers
void ImGui.SetCursorPos(float32 x, float32 y) script.method.common.ImGui.SetCursorPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:567 Sets the current cursor position in window-local coordinates
void ImGui.SetCursorScreenPos(fpos pos) script.method.common.ImGui.SetCursorScreenPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:574 Sets the current cursor position in screen coordinates
void ImGui.SetItemDefaultFocus() script.method.common.ImGui.SetItemDefaultFocus ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1424 Gives the last submitted item default focus when its appearing window has no restored focus state
void ImGui.SetItemTooltip(string text) script.method.common.ImGui.SetItemTooltip ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1447 Shows a text tooltip for the last item when ImGui's item-tooltip hover policy is satisfied
void ImGui.SetKeyboardFocusHere(int32 offset = 0) script.method.common.ImGui.SetKeyboardFocusHere ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:595 Requests keyboard focus for a focusable item at the supplied offset relative to the next submitted item
void ImGui.SetNextItemOpen(bool isOpen, ImGui_Cond cond = ImGui_Cond::None) script.method.common.ImGui.SetNextItemOpen ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:525 Sets the next tree node or collapsing header's open state subject to the supplied ImGui condition
void ImGui.SetNextItemWidth(float32 itemWidth) script.method.common.ImGui.SetNextItemWidth ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:620 Overrides the width of the next submitted item
void ImGui.SetNextWindowBgAlpha(float32 alpha) script.method.common.ImGui.SetNextWindowBgAlpha ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:282 Overrides the background alpha of the next window
void ImGui.SetNextWindowCollapsed(bool collapsed, ImGui_Cond cond = ImGui_Cond::None) script.method.common.ImGui.SetNextWindowCollapsed ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:247 Sets whether the next window is collapsed subject to the supplied ImGui condition
void ImGui.SetNextWindowContentSize(isize size) script.method.common.ImGui.SetNextWindowContentSize ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:261 Sets the explicit content size of the next window, controlling its scrollable extent independently of the window size
void ImGui.SetNextWindowFocus() script.method.common.ImGui.SetNextWindowFocus ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:268 Requests focus for the next window begun in the current frame
void ImGui.SetNextWindowPos(ipos pos, ImGui_Cond cond = ImGui_Cond::None) script.method.common.ImGui.SetNextWindowPos ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:233 Sets the next window's screen position subject to the supplied ImGui condition
void ImGui.SetNextWindowScroll(fpos scroll) script.method.common.ImGui.SetNextWindowScroll ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:275 Sets the next window's initial scroll coordinates; negative components leave the corresponding axis unchanged
void ImGui.SetNextWindowSize(isize size, ImGui_Cond cond = ImGui_Cond::None) script.method.common.ImGui.SetNextWindowSize ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:240 Sets the next window's size subject to the supplied ImGui condition
void ImGui.SetNextWindowSizeConstraints(isize sizeMin, isize sizeMax) script.method.common.ImGui.SetNextWindowSizeConstraints ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:254 Constrains the next window's size between the supplied minimum and maximum dimensions
void ImGui.SetScrollFromPosX(float32 localX, float32 centerXRatio = 0.5f) script.method.common.ImGui.SetScrollFromPosX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:472 Adjusts horizontal scrolling so a local X position appears at the requested viewport ratio
void ImGui.SetScrollFromPosY(float32 localY, float32 centerYRatio = 0.5f) script.method.common.ImGui.SetScrollFromPosY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:479 Adjusts vertical scrolling so a local Y position appears at the requested viewport ratio
void ImGui.SetScrollHereX(float32 centerXRatio = 0.5f) script.method.common.ImGui.SetScrollHereX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:458 Adjusts horizontal scrolling so the current cursor position appears at the requested viewport ratio
void ImGui.SetScrollHereY(float32 centerYRatio = 0.5f) script.method.common.ImGui.SetScrollHereY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:465 Adjusts vertical scrolling so the current cursor position appears at the requested viewport ratio
void ImGui.SetScrollX(float32 scrollX) script.method.common.ImGui.SetScrollX ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:430 Sets the current window's horizontal scroll offset
void ImGui.SetScrollY(float32 scrollY) script.method.common.ImGui.SetScrollY ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:437 Sets the current window's vertical scroll offset
void ImGui.SetTabItemClosed(string tabLabel) script.method.common.ImGui.SetTabItemClosed ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1829 Notifies ImGui that a required nonempty-label tab was closed externally so its tab-bar state can be updated
void ImGui.SetTooltip(string text) script.method.common.ImGui.SetTooltip ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1431 Immediately renders a tooltip containing the supplied text verbatim
bool ImGui.SliderFloat(string label, float32& value, float32 minValue, float32 maxValue) script.method.common.ImGui.SliderFloat ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:929 Draws a required nonempty-label bounded float slider, updates value, and returns whether it changed
bool ImGui.SliderFloat2(string label, float32& valueX, float32& valueY, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderFloat2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:951 Draws a required nonempty-label two-component bounded float slider and writes both components back only when they change
bool ImGui.SliderFloat3(string label, float32& valueX, float32& valueY, float32& valueZ, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderFloat3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:970 Draws a required nonempty-label three-component bounded float slider and writes all components back only when they change
bool ImGui.SliderFloat4(string label, float32& valueX, float32& valueY, float32& valueZ, float32& valueW, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderFloat4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:990 Draws a required nonempty-label four-component bounded float slider and writes all components back only when they change
bool ImGui.SliderInt(string label, int32& value, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderInt ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:940 Draws a required nonempty-label bounded integer slider with the supplied flags, updates value, and reports changes
bool ImGui.SliderInt2(string label, int32& valueX, int32& valueY, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderInt2 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1011 Draws a required nonempty-label two-component bounded integer slider and writes both components back only when they change
bool ImGui.SliderInt3(string label, int32& valueX, int32& valueY, int32& valueZ, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderInt3 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1030 Draws a required nonempty-label three-component bounded integer slider and writes all components back only when they change
bool ImGui.SliderInt4(string label, int32& valueX, int32& valueY, int32& valueZ, int32& valueW, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.SliderInt4 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1050 Draws a required nonempty-label four-component bounded integer slider and writes all components back only when they change
bool ImGui.SmallButton(string label) script.method.common.ImGui.SmallButton ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1216 Draws a required nonempty-label button without standard frame padding and returns whether it was activated
void ImGui.Spacing() script.method.common.ImGui.Spacing ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1100 Adds one standard vertical spacing unit to the current layout
bool ImGui.TabItemButton(string label, ImGui_TabItemFlags flags = ImGui_TabItemFlags::None) script.method.common.ImGui.TabItemButton ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1818 Draws a required nonempty-label tab-bar button and returns whether it was activated; it does not create a tab contents scope
void ImGui.TableAngledHeadersRow() script.method.common.ImGui.TableAngledHeadersRow ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1764 Emits an angled-header row for columns configured with angled-header flags
int32 ImGui.TableGetColumnCount() script.method.common.ImGui.TableGetColumnCount ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1715 Returns the current table's column count, or zero outside a table
ImGui_TableColumnFlags ImGui.TableGetColumnFlags(int32 columnN = -1) script.method.common.ImGui.TableGetColumnFlags ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1743 Returns the requested table column's current status flags, using the current column when columnN is negative
int32 ImGui.TableGetColumnIndex() script.method.common.ImGui.TableGetColumnIndex ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1722 Returns the current table column index, or -1 before selecting a column or outside a table
string ImGui.TableGetColumnName(int32 columnN = -1) script.method.common.ImGui.TableGetColumnName ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1736 Returns the requested table column's configured name, using the current column when columnN is negative
int32 ImGui.TableGetHoveredColumn() script.method.common.ImGui.TableGetHoveredColumn ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1757 Returns the hovered table column index, with ImGui sentinel values for none or unused trailing space
int32 ImGui.TableGetRowIndex() script.method.common.ImGui.TableGetRowIndex ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1729 Returns the current table row index, or -1 before starting a row or outside a table
void ImGui.TableHeader(string label) script.method.common.ImGui.TableHeader ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1679 Emits a required nonempty-label header cell for the current table column
void ImGui.TableHeadersRow() script.method.common.ImGui.TableHeadersRow ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1672 Emits one table header row from columns configured by TableSetupColumn
bool ImGui.TableNextColumn() script.method.common.ImGui.TableNextColumn ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1658 Advances to the next table column, creating a row when needed, and returns whether the destination column is visible
void ImGui.TableNextRow(ImGui_TableRowFlags rowFlags = ImGui_TableRowFlags::None) script.method.common.ImGui.TableNextRow ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1651 Advances the current table to a new row using the supplied row flags
void ImGui.TableSetBgColor(ImGui_TableBgTarget target, ucolor color, int32 columnN = -1) script.method.common.ImGui.TableSetBgColor ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1708 Overrides a table row or cell background target with the supplied packed color, using the current column when columnN is negative
void ImGui.TableSetColumnEnabled(int32 columnN, bool enabled) script.method.common.ImGui.TableSetColumnEnabled ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1750 Enables or disables a table column by zero-based index
bool ImGui.TableSetColumnIndex(int32 columnN) script.method.common.ImGui.TableSetColumnIndex ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1665 Selects a table column by zero-based index and returns whether that column is visible
void ImGui.TableSetupColumn(string label, ImGui_TableColumnFlags flags = ImGui_TableColumnFlags::None) script.method.common.ImGui.TableSetupColumn ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1690 Configures the next table column with a required nonempty label and column flags before the first row is submitted
void ImGui.TableSetupScrollFreeze(int32 cols, int32 rows) script.method.common.ImGui.TableSetupScrollFreeze ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1701 Freezes the requested leading table columns and rows when the table scrolls
void ImGui.Text(string text) script.method.common.ImGui.Text ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:289 Renders text verbatim without interpreting it as a printf-style format string
void ImGui.TextColored(string text, float32 r, float32 g, float32 b, float32 a) script.method.common.ImGui.TextColored ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2019 Renders the supplied text with an explicit RGBA color
void ImGui.TextDisabled(string text) script.method.common.ImGui.TextDisabled ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:296 Renders text using ImGui's disabled-text style
bool ImGui.TextLink(string label) script.method.common.ImGui.TextLink ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1955 Draws a required nonempty-label text link and returns whether it was activated without opening a URL itself
bool ImGui.TextLinkOpenURL(string label, string url) script.method.common.ImGui.TextLinkOpenURL#6af05af1a530865a ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1979 Draws a required nonempty-label link, asks ImGui's platform URL handler to open the required URL when activated, and reports activation
bool ImGui.TextLinkOpenURL(string label) script.method.common.ImGui.TextLinkOpenURL#b52d43bc02aa8901 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1967 Draws a required nonempty-label link, asks ImGui's platform URL handler to open the label when activated, and reports activation
void ImGui.TextWrapped(string text) script.method.common.ImGui.TextWrapped ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:303 Renders text with wrapping at the current content-region boundary
bool ImGui.TreeNode(string label) script.method.common.ImGui.TreeNode ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1154 Draws a required nonempty-label tree node and returns whether it is open; call TreePop only when true
bool ImGui.TreeNodeEx(string label, ImGui_TreeNodeFlags flags) script.method.common.ImGui.TreeNodeEx ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1165 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
void ImGui.TreePop() script.method.common.ImGui.TreePop ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1176 Pops the tree scope pushed by an open TreeNode or TreeNodeEx call
void ImGui.Unindent(float32 indentW = 0.0f) script.method.common.ImGui.Unindent ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:662 Decreases the current line's horizontal indentation by the supplied amount or the style default when zero
bool ImGui.VSliderFloat(string label, fsize size, float32& value, float32 minValue, float32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.VSliderFloat ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1071 Draws a required nonempty-label vertical float slider of the supplied size and bounds, updates value, and reports changes
bool ImGui.VSliderInt(string label, fsize size, int32& value, int32 minValue, int32 maxValue, ImGui_SliderFlags flags = ImGui_SliderFlags::None) script.method.common.ImGui.VSliderInt ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:1082 Draws a required nonempty-label vertical integer slider of the supplied size and bounds, updates value, and reports changes
void ImGui.Value(string prefix, bool value) script.method.common.ImGui.Value#031100c2fda9013e ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2026 Renders a boolean value after a required nonempty prefix using ImGui's standard value formatting
void ImGui.Value(string prefix, int32 value) script.method.common.ImGui.Value#11dff794976df969 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2037 Renders a signed integer value after a required nonempty prefix using ImGui's standard value formatting
void ImGui.Value(string prefix, uint32 value) script.method.common.ImGui.Value#69d025366813cd9a ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2048 Renders an unsigned integer value after a required nonempty prefix using ImGui's standard value formatting
void ImGui.Value(string prefix, float32 value) script.method.common.ImGui.Value#90152b1c9fa83617 ImGui server, client, mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/CommonImGuiScriptMethods.cpp:2059 Renders a float value after a required nonempty prefix using ImGui's standard value formatting

Game (mapper)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
Critter Game.AddCritter(hstring pid, mpos hex) script.method.mapper.Game.AddCritter#7053965abb306d1b Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:140 Creates a critter from the supplied prototype id on a valid hex of the currently shown Mapper map and returns its editable client view
Critter Game.AddCritter(ProtoCritter proto, mpos hex) script.method.mapper.Game.AddCritter#fa5e6a45b39828c0 Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:154 Creates a critter from the supplied prototype on a valid hex of the currently shown Mapper map and returns its editable client view
Item Game.AddItem(ProtoItem proto, mpos hex) script.method.mapper.Game.AddItem#659cb03d0e702e66 Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:126 Creates an item from the supplied prototype on a valid hex of the currently shown Mapper map and returns its editable client view
Item Game.AddItem(hstring pid, mpos hex) script.method.mapper.Game.AddItem#f08c1b76d0bf34c1 Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:112 Creates an item from the supplied prototype id on a valid hex of the currently shown Mapper map
void Game.AddMapperIgnoredItemPids(hstring[] itemPids) script.method.mapper.Game.AddMapperIgnoredItemPids Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:865 Adds item prototype ids to the current map's Mapper ignore set and rebuilds the map view so the filtering takes effect
void Game.AddMessage(string message) script.method.mapper.Game.AddMessage Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:683 Appends a message to the Mapper's on-screen message log
Item Game.AddTile(hstring pid, mpos hex, int32 layer, bool roof) script.method.mapper.Game.AddTile Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:320 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
float32 Game.CalcMapperFitZoom(isize viewportSize) script.method.mapper.Game.CalcMapperFitZoom Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:888 Calculates the smaller horizontal or vertical zoom needed to fit the configured playable area, or the full map bounds, inside a positive viewport
void Game.CenterMapperOnHex(mpos hex) script.method.mapper.Game.CenterMapperOnHex Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:746 Centers and rebuilds the current Mapper view on a valid in-map hex; an invalid hex or missing current map throws
void Game.CenterMapperOnPlayableArea() script.method.mapper.Game.CenterMapperOnPlayableArea Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:724 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
void Game.CenterMapperOnRawHex(ipos rawHex) script.method.mapper.Game.CenterMapperOnRawHex Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:759 Centers and rebuilds the current Mapper view on an unclamped raw hex coordinate, allowing authored playable areas outside the map rectangle
void Game.DeleteEntities(Entity[] entities) script.method.mapper.Game.DeleteEntities Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:234 Deletes each non-null, non-destroyed editable entity in the supplied collection and skips unusable entries
void Game.DeleteEntity(Entity entity) script.method.mapper.Game.DeleteEntity Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:227 Deletes one editable entity through the Mapper's normal deletion path
Entity? Game.FindEntityById(ident id) script.method.mapper.Game.FindEntityById Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:298 Finds an editable entity by runtime id on the currently shown Mapper map, or returns null when it is absent
Critter? Game.GetCritterOnHex(mpos hex, CritterFindType findType) script.method.mapper.Game.GetCritterOnHex Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:186 Returns the first critter on a hex that passes the requested find-type filter, or null when none match
Critter[] Game.GetCrittersOnHex(mpos hex, CritterFindType findType) script.method.mapper.Game.GetCrittersOnHex Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:201 Returns all critters on a hex of the current Mapper map that pass the requested find-type filter
msize Game.GetCurMapHexSize() script.method.mapper.Game.GetCurMapHexSize Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:690 Returns the current Mapper map's dimensions in hex cells; throws when no map is shown
isize Game.GetCurMapPixelSize() script.method.mapper.Game.GetCurMapPixelSize Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:699 Returns the current Mapper map's full hex-grid bounding size in pixels; throws when no map is shown
Item? Game.GetItemOnHex(mpos hex) script.method.mapper.Game.GetItemOnHex Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:168 Returns the current Mapper map's single-item lookup result for a hex, or null when no item is selected there
Item[] Game.GetItemsOnHex(mpos hex) script.method.mapper.Game.GetItemsOnHex Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:177 Returns all editable item views occupying a hex on the currently shown Mapper map
Map[] Game.GetLoadedMaps(int32& index) script.method.mapper.Game.GetLoadedMaps Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:418 Returns all loaded Mapper maps in load order and writes the current map's index, or -1 when no returned map is current
string[] Game.GetMapFileNames(string dir, bool recursive) script.method.mapper.Game.GetMapFileNames Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:442 Enumerates declared map names from prototype files under a Mapper maps directory, optionally descending recursively
mpos[] Game.GetMapperScrollBorderHexes() script.method.mapper.Game.GetMapperScrollBorderHexes Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:818 Returns drawable in-map hexes lying on the configured axial scroll-area border, or an empty array when no map or border is available
mpos[] Game.GetMapperTrackOverlayHexes() script.method.mapper.Game.GetMapperTrackOverlayHexes Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:804 Returns the hex sequence currently exposed by the Mapper track overlay
int32[] Game.GetMapperTrackOverlayKinds() script.method.mapper.Game.GetMapperTrackOverlayKinds Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:811 Returns the per-entry kind values aligned with the Mapper track overlay hex sequence
Entity[] Game.GetSelectedEntities() script.method.mapper.Game.GetSelectedEntities Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:284 Returns a snapshot of all entities in the Mapper's current selection order
Entity? Game.GetSelectedEntity() script.method.mapper.Game.GetSelectedEntity Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:277 Returns the first selected Mapper entity, or null when the selection is empty
MapLayers Game.GetVisibleMapLayers() script.method.mapper.Game.GetVisibleMapLayers Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:89 Returns the map layers currently visible in the Mapper viewport
bool Game.IsMapperHexOverlayVisible() script.method.mapper.Game.IsMapperHexOverlayVisible Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:797 Returns whether the Mapper-wide hex overlay is visible
bool Game.IsMapperOverlayVisible() script.method.mapper.Game.IsMapperOverlayVisible Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:777 Returns whether the current map's general Mapper overlay is visible, or false when no map is shown
Map? Game.LoadMap(string fileName) script.method.mapper.Game.LoadMap Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:371 Loads a map from the Mapper file system by file name and returns its view, or null when loading fails
void Game.MoveEntity(Entity? entity, mpos hex) script.method.mapper.Game.MoveEntity Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:210 Moves a non-null editable entity to a valid hex of the current Mapper map; a null entity is ignored
Map? Game.NewMap(string name, int32 width, int32 height) script.method.mapper.Game.NewMap Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:339 Creates and loads a minimal named map with dimensions clamped to Engine limits and its work hex at the center; an empty name throws
Map? Game.NewMapFromText(string name, string text) script.method.mapper.Game.NewMapFromText Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:357 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
void Game.ResizeMap(int32 width, int32 height) script.method.mapper.Game.ResizeMap Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:465 Resizes the currently shown Mapper map to the requested dimensions through the editor's normal resize operation
void Game.SaveMap(Map map, string customName) script.method.mapper.Game.SaveMap Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:386 Saves the supplied Mapper map using an optional custom name through the normal map-save path
void Game.SaveMapToPath(Map map, string subDir, string name) script.method.mapper.Game.SaveMapToPath Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:393 Saves a map beneath the Mapper maps root using a subdirectory and separator-free name; empty names and parent traversal are rejected
void Game.SaveMapperScreenshot(string filePath) script.method.mapper.Game.SaveMapperScreenshot Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:931 Saves the current map rendering as PNG to a nonempty file path using the Mapper's map-only screenshot path
void Game.SelectEntities(Entity[] entities, bool set) script.method.mapper.Game.SelectEntities Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:261 Adds or removes every non-null entity in the supplied collection from the Mapper selection according to set
void Game.SelectEntity(Entity entity, bool set) script.method.mapper.Game.SelectEntity Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:249 Adds one editable entity to the Mapper selection when set is true, or removes it when false
bool Game.SetEntityProperty(Entity entity, string propName, string valueText) script.method.mapper.Game.SetEntityProperty Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:307 Parses and applies a named property value to an editable entity, returning whether Mapper accepted the text; an unknown property name throws
void Game.SetMapperHexOverlayVisible(bool visible) script.method.mapper.Game.SetMapperHexOverlayVisible Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:790 Shows or hides the Mapper-wide hex overlay
void Game.SetMapperHiddenSpritesVisible(bool visible) script.method.mapper.Game.SetMapperHiddenSpritesVisible Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:856 Shows or hides sprites marked as hidden on the currently displayed Mapper map
void Game.SetMapperOverlayVisible(bool visible) script.method.mapper.Game.SetMapperOverlayVisible Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:768 Shows or hides the general Mapper overlay on the currently displayed map
void Game.SetMapperScrollCheckEnabled(bool enabled) script.method.mapper.Game.SetMapperScrollCheckEnabled Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:878 Enables or disables scroll checking on the current Mapper map and rebuilds its view
void Game.SetMapperViewSize(isize size) script.method.mapper.Game.SetMapperViewSize Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:711 Sets a positive rendering viewport size on the currently shown Mapper map; nonpositive dimensions or a missing map throw
void Game.SetMapperZoom(float32 zoom) script.method.mapper.Game.SetMapperZoom Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:917 Applies a positive zoom immediately to the current Mapper map and updates its zoom target; nonpositive values or a missing map throw
void Game.SetMouseScroll(bool inFullscreen, bool inWindow) script.method.mapper.Game.SetMouseScroll Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:104 Configures whether edge-driven mouse scrolling is enabled in fullscreen and windowed Mapper modes
void Game.SetVisibleMapLayers(MapLayers layers) script.method.mapper.Game.SetVisibleMapLayers Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:96 Replaces the map layers visible in the Mapper viewport and applies the visibility state
void Game.ShowMap(Map map) script.method.mapper.Game.ShowMap Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:411 Makes the supplied loaded map the map currently shown by the Mapper
void Game.TabDelete(int32 tab) script.method.mapper.Game.TabDelete Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:637 Clears a valid Mapper content tab, recreates its empty aggregate default subtab, and makes that subtab active
hstring[] Game.TabGetCritterPids(int32 tab, string subTab) script.method.mapper.Game.TabGetCritterPids Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:494 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
hstring[] Game.TabGetItemPids(int32 tab, string subTab) script.method.mapper.Game.TabGetItemPids Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:473 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
void Game.TabSelect(int32 tab, string subTab, bool show) script.method.mapper.Game.TabSelect Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:650 Optionally shows a valid Mapper panel mode and selects an existing named or default content subtab when that mode owns content tabs
void Game.TabSetCritterPids(int32 tab, string subTab, hstring[] critterPids) script.method.mapper.Game.TabSetCritterPids Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:576 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
void Game.TabSetItemPids(int32 tab, string subTab, hstring[] itemPids) script.method.mapper.Game.TabSetItemPids Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:515 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
void Game.TabSetName(int32 tab, string tabName) script.method.mapper.Game.TabSetName Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:672 Replaces the display name of a valid Mapper panel mode
void Game.UnloadMap(Map map) script.method.mapper.Game.UnloadMap Game mapper experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/MapperGlobalScriptMethods.cpp:379 Unloads the supplied map view from the Mapper

Critter (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
void Critter.Action(CritterAction action, int32 actionData, AbstractItem? contextItem) script.method.server.Critter.Action Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:705 SyncScope: requires self + context item when non-null; sends/broadcasts action only
Item Critter.AddItem(ProtoItem proto) script.method.server.Critter.AddItem#6029176d1f44719d Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:473 SyncScope: requires self; creates and attaches a new inventory item under self's cover
Item Critter.AddItem(hstring pid) script.method.server.Critter.AddItem#e8b1d5e540061d17 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:455 SyncScope: requires self; creates and attaches a new inventory item under self's cover
void Critter.AttachToCritter(Critter cr) script.method.server.Critter.AttachToCritter Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:922 SyncScope: requires self + cr, and both must be on the same covered map
void Critter.ChangeItemSlot(ident itemId, CritterItemSlot slot) script.method.server.Critter.ChangeItemSlot Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:589 SyncScope: requires self + inventory item; mutates item slot and fires movement/equipment events
void Critter.ChangeMovingSpeed(int32 speed) script.method.server.Critter.ChangeMovingSpeed Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:911 SyncScope: requires self; changes current movement speed
void Critter.DetachAllCritters() script.method.server.Critter.DetachAllCritters Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:974 SyncScope: requires self and attached critters; detaches each attached critter and refreshes visibility
void Critter.DetachFromCritter() script.method.server.Critter.DetachFromCritter Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:962 SyncScope: requires self + current map; detaches self and refreshes visibility
void Critter.Disconnect() script.method.server.Critter.Disconnect Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:732 SyncScope: requires self + its auto-widened Player link; closes that player's connection
Critter[] Critter.GetAttachedCritters() script.method.server.Critter.GetAttachedCritters Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:985 SyncScope: requires self; returned attached critters need their own cover before mutation
Critter? Critter.GetCritter(ident id, CritterSeeType seeType) script.method.server.Critter.GetCritter Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:376 SyncScope: requires self; observer lookup may need self's map covered when self is mapped
Critter[] Critter.GetCritters(CritterSeeType seeType, CritterFindType findType) script.method.server.Critter.GetCritters Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:384 SyncScope: requires self and current map when mapped; returned critters are covered only while that cover remains
ident[] Critter.GetGlobalMapCritterIds(uint64& revision) script.method.server.Critter.GetGlobalMapCritterIds Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:113 SyncScope: requires self; returns the ids of self's current global-map group together with the group's
membership revision (empty with revision 0 when self is mapped). Group members are independent Critter roots
that self's cover does not include, so a caller that sends initial info to, transfers, or destroys a
global-map critter resolves and covers the returned ids and then re-reads ids plus revision to prove the
membership did not change while it was acquiring that cover
Item? Critter.GetItem(ItemProperty property, int32 propertyValue) script.method.server.Critter.GetItem#20907df3571a66a9 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:511 SyncScope: requires self; returned inventory item is covered by self while the cover remains
Item? Critter.GetItem(ident itemId) script.method.server.Critter.GetItem#3e4a8f273e418d3b Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:485 SyncScope: requires self; returned inventory item is covered by self while the cover remains
Item? Critter.GetItem(hstring protoId) script.method.server.Critter.GetItem#5042179ea08a430e Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:497 SyncScope: requires self; returned inventory item is covered by self while the cover remains
Item? Critter.GetItem(ProtoItem proto) script.method.server.Critter.GetItem#8eedde0030f87e84 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:504 SyncScope: requires self; returned inventory item is covered by self while the cover remains
Item[] Critter.GetItems(ItemProperty property, int32 propertyValue) script.method.server.Critter.GetItems#83c145745774df22 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:534 SyncScope: requires self; returned inventory items are covered by self while the cover remains
Item[] Critter.GetItems(hstring protoId) script.method.server.Critter.GetItems#a6ae510092488b1e Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:553 SyncScope: requires self; returned inventory items are covered by self while the cover remains
Item[] Critter.GetItems() script.method.server.Critter.GetItems#b851260ade7c353c Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:526 SyncScope: requires self; returned inventory items are covered by self while the cover remains
Item[] Critter.GetItems(ProtoItem proto) script.method.server.Critter.GetItems#ef66ddcc26718dfe Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:571 SyncScope: requires self; returned inventory items are covered by self while the cover remains
Map? Critter.GetMap() script.method.server.Critter.GetMap Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerCritterScriptMethods.cpp:100 SyncScope: requires self; returns the current parent map handle, but does not cover it for later reads
MovingContext? Critter.GetMovingContext() script.method.server.Critter.GetMovingContext Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:77 SyncScope: requires self; returned movement context is a snapshot handle for self's active move
MovingState Critter.GetMovingState() script.method.server.Critter.GetMovingState Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:897 SyncScope: requires self; reads current movement state only
uint32 Critter.GetMovingUid() script.method.server.Critter.GetMovingUid Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:85 SyncScope: requires self; reads current movement uid only
Player? Critter.GetPlayer() script.method.server.Critter.GetPlayer Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:92 SyncScope: requires self; returns the auto-widen partner Player when one is attached
timespan Critter.GetPlayerOfflineTime() script.method.server.Critter.GetPlayerOfflineTime Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:993 SyncScope: requires self; reads offline state for this critter's player link only
CritterVisibilityMode Critter.GetVisibilityMode(Critter cr) script.method.server.Critter.GetVisibilityMode Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:433 SyncScope: requires self + cr; reads self's visibility-mode cache for a covered critter
bool Critter.IsAlive() script.method.server.Critter.IsAlive Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:334 SyncScope: requires self; reads current condition state only
bool Critter.IsDead() script.method.server.Critter.IsDead Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:348 SyncScope: requires self; reads current condition state only
bool Critter.IsKnockout() script.method.server.Critter.IsKnockout Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:341 SyncScope: requires self; reads current condition state only
bool Critter.IsMoving() script.method.server.Critter.IsMoving Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:70 SyncScope: requires self; reads current movement flag only
bool Critter.IsOnline() script.method.server.Critter.IsOnline Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:778 SyncScope: requires self + its auto-widened Player link; reads online state only
bool Critter.IsSee(Critter cr) script.method.server.Critter.IsSee#11f3357f2df75c38 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:407 SyncScope: requires self + cr; checks self's visibility cache for a covered critter
bool Critter.IsSee(Item item) script.method.server.Critter.IsSee#c05ec9ee4a1d9b41 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:446 SyncScope: requires self + item; checks self's visible-item cache for a covered item
bool Critter.IsSeenBy(Critter cr) script.method.server.Critter.IsSeenBy Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:420 SyncScope: requires self + cr; checks cr's visibility cache for this covered critter
void Critter.MakeControllable(bool controllable) script.method.server.Critter.MakeControllable Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:745 SyncScope: requires self + current map; changes controllable/player state and may self-sync map
MovingContext Critter.MoveToHex(mpos hex, int32 cut, int32 speed, callback(bool,Critter,Item) gagCallabck) script.method.server.Critter.MoveToHex#59785332969dbd15 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerCritterScriptMethods.cpp:869 SyncScope: requires self + current map; starts movement and returns the new movement context
MovingContext Critter.MoveToHex(mpos hex, int32 cut, ipos16 endHexOffset, int32 speed, callback(bool,Critter,Item) gagCallabck) script.method.server.Critter.MoveToHex#877a3be2a55ba41a Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerCritterScriptMethods.cpp:878 SyncScope: requires self + current map; starts movement and returns the new movement context
MovingContext Critter.MoveToHex(mpos hex, int32 cut, ipos16 endHexOffset, int32 maxPathLength, int32 speed, callback(bool,Critter,Item) gagCallabck) script.method.server.Critter.MoveToHex#b27a6e0f0f8ceddb Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerCritterScriptMethods.cpp:888 A request whose route would be longer than maxPathLength steps is refused as HexTooFar, and the refusal costs
no more than a search of that depth; 0 keeps Geometry.MaxPathFindLength
void Critter.RefreshView() script.method.server.Critter.RefreshView Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:355 SyncScope: requires self + current map when mapped; recomputes visible critters/items
void Critter.RefreshVisibility() script.method.server.Critter.RefreshVisibility Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:1000 SyncScope: requires self + current map when mapped; recomputes visible critters/items
void Critter.SendGlobalMapGroupInfo() script.method.server.Critter.SendGlobalMapGroupInfo Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:122 SyncScope: requires self + every critter of self's current global-map group; sends the other members to self's
player without acquiring any cover. Initial info sends only the critter itself, so a caller that attaches a
global-map critter to a player covers the group (Sync::WidenCritterWithGlobalMapGroup) and then calls this
void Critter.SendItems(Item[] items, bool owned = false, bool withInnerEntities = false, any contextParam = any()) script.method.server.Critter.SendItems Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:714 SyncScope: requires self + every non-null item in items; sends a network payload without changing cover
void Critter.SetCondition(CritterCondition cond, CritterActionAnim actionAnim, AbstractItem? contextItem) script.method.server.Critter.SetCondition Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:659 SyncScope: requires self + current map when mapped + context item when non-null; mutates condition and map fields
void Critter.SetDir(mdir dir) script.method.server.Critter.SetDir Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:363 SyncScope: requires self; mutates direction and broadcasts it
void Critter.SetupScript(callback(void,Critter,bool) initFunc) script.method.server.Critter.SetupScript Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:44 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities
void Critter.SetupScriptEx(hstring initFunc) script.method.server.Critter.SetupScriptEx Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:59 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities
void Critter.StopMoving() script.method.server.Critter.StopMoving Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:904 SyncScope: requires self; stops current movement
void Critter.TransferToGlobal() script.method.server.Critter.TransferToGlobal Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:239 SyncScope: requires self + current source map when self is mapped; mutates self to global-map state
void Critter.TransferToGlobalGroup(Critter globalCr) script.method.server.Critter.TransferToGlobalGroup Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:281 SyncScope: requires self + globalCr; if self is mapped also requires self's current source map
void Critter.TransferToGlobalWithGroup(Critter[] group) script.method.server.Critter.TransferToGlobalWithGroup Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:256 SyncScope: requires self + current source map and every group critter + its current source map before transfer
void Critter.TransferToHex(mpos hex, mdir dir) script.method.server.Critter.TransferToHex#8438d509ef6a8651 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:167 SyncScope: requires self + current map; transfer keeps self covered and mutates current-map placement/dir
void Critter.TransferToHex(mpos hex) script.method.server.Critter.TransferToHex#a9a09ef8641e16c0 Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:145 SyncScope: requires self + current map; transfer keeps self covered and mutates current-map placement
void Critter.TransferToMap(Map map, mpos hex) script.method.server.Critter.TransferToMap#c9880f573836f54f Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:198 SyncScope: requires self + source map if mapped + destination map + destination location; scripts should use Sync::LockForTransferToMap(self, map)
void Critter.TransferToMap(Map map, mpos hex, mdir dir, bool preciseHex = false) script.method.server.Critter.TransferToMap#dc3840f5d203dd4b Critter server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerCritterScriptMethods.cpp:216 SyncScope: requires self + source map if mapped + destination map + destination location; scripts should use Sync::LockForTransferToMap(self, map)

Entity (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
int32 Entity.CountTimeEvent(callback(void,Entity,any) func) script.method.server.Entity.CountTimeEvent#08f3341698dc846a Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:156 SyncScope: requires self; counts events bound to self, no cover change
int32 Entity.CountTimeEvent(callback(void,Entity) func) script.method.server.Entity.CountTimeEvent#5609075e34e56857 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:149 SyncScope: requires self; counts events bound to self, no cover change
int32 Entity.CountTimeEvent(callback(void,Entity,TimeEventContext) func) script.method.server.Entity.CountTimeEvent#9c7dd3ed70f86a7d Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:170 SyncScope: requires self; counts events bound to self, no cover change
int32 Entity.CountTimeEvent(callback(void,Entity,any[]) func) script.method.server.Entity.CountTimeEvent#ad56856359be786a Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:163 SyncScope: requires self; counts events bound to self, no cover change
int32 Entity.CountTimeEvent(uint32 id) script.method.server.Entity.CountTimeEvent#e41a67022275199d Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:177 SyncScope: requires self; counts events bound to self, no cover change
int32 Entity.GetRefCount() script.method.server.Entity.GetRefCount Game, Player, Location, Map, Critter, Item, ImGui server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerEntityScriptMethods.cpp:58 A reference-leak diagnostic: every script wrapper and in-flight native pin is counted, so only a difference
measured around a controlled sequence of calls means anything
bool Entity.IsPersistent() script.method.server.Entity.IsPersistent Game, Player, Location, Map, Critter, Item, ImGui server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerEntityScriptMethods.cpp:43 SyncScope: requires self; reads persistence flag only
void Entity.MakePersistent(bool persistent) script.method.server.Entity.MakePersistent Game, Player, Location, Map, Critter, Item, ImGui server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerEntityScriptMethods.cpp:50 SyncScope: requires self; persistence cascade may self-sync covered child entities
void Entity.RepeatTimeEvent(uint32 id, timespan repeat) script.method.server.Entity.RepeatTimeEvent#28154675b58100aa Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:247 SyncScope: requires self; updates repeat for event bound to self, no cover change
void Entity.RepeatTimeEvent(callback(void,Entity,any) func, timespan repeat) script.method.server.Entity.RepeatTimeEvent#35eb685e9352ee97 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:226 SyncScope: requires self; updates repeat for event bound to self, no cover change
void Entity.RepeatTimeEvent(callback(void,Entity,any[]) func, timespan repeat) script.method.server.Entity.RepeatTimeEvent#4c1ec6146e414fed Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:233 SyncScope: requires self; updates repeat for event bound to self, no cover change
void Entity.RepeatTimeEvent(callback(void,Entity,TimeEventContext) func, timespan repeat) script.method.server.Entity.RepeatTimeEvent#d107502adf65e851 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:240 SyncScope: requires self; updates repeat for event bound to self, no cover change
void Entity.RepeatTimeEvent(callback(void,Entity) func, timespan repeat) script.method.server.Entity.RepeatTimeEvent#d3e5bb91010a5ee6 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:219 SyncScope: requires self; updates repeat for event bound to self, no cover change
void Entity.SetTimeEventData(callback(void,Entity,any) func, any data) script.method.server.Entity.SetTimeEventData#09c025b7150b6bcd Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:254 SyncScope: requires self; updates data for event bound to self, no cover change
void Entity.SetTimeEventData(callback(void,Entity,any[]) func, any[] data) script.method.server.Entity.SetTimeEventData#46ce3a8e59df0b76 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:261 SyncScope: requires self; updates data for event bound to self, no cover change
void Entity.SetTimeEventData(uint32 id, any data) script.method.server.Entity.SetTimeEventData#995b7ca79df38c35 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:282 SyncScope: requires self; updates data for event bound to self, no cover change
void Entity.SetTimeEventData(uint32 id, any[] data) script.method.server.Entity.SetTimeEventData#adb2b4962b8e3874 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:289 SyncScope: requires self; updates data for event bound to self, no cover change
void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any[] data) script.method.server.Entity.SetTimeEventData#c02fbdd5c31ecb21 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:275 SyncScope: requires self; updates data for event bound to self, no cover change
void Entity.SetTimeEventData(callback(void,Entity,TimeEventContext) func, any data) script.method.server.Entity.SetTimeEventData#c41820f30638ac18 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:268 SyncScope: requires self; updates data for event bound to self, no cover change
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any data) script.method.server.Entity.StartTimeEvent#170befe9003e3411 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:135 SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func) script.method.server.Entity.StartTimeEvent#1e937a7976df63ac Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:86 SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any[] data) script.method.server.Entity.StartTimeEvent#492d95e09fb651ed Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:100 SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity) func) script.method.server.Entity.StartTimeEvent#494379a91f97d59e Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:107 SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func, any[] data) script.method.server.Entity.StartTimeEvent#64daaaa7e6125cb3 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:142 SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any[]) func, any[] data) script.method.server.Entity.StartTimeEvent#805b4b72ba72a604 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:121 SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,any) func, any data) script.method.server.Entity.StartTimeEvent#9e1b092a1d7fb963 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:114 SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any) func, any data) script.method.server.Entity.StartTimeEvent#ae9a39c7d8c1d6fa Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:72 SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, timespan repeat, callback(void,Entity,TimeEventContext) func) script.method.server.Entity.StartTimeEvent#af2f95f5513a4cfa Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:128 SyncScope: requires self to schedule repeating event; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,any[]) func, any[] data) script.method.server.Entity.StartTimeEvent#b494dfd4a4fa81ea Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:79 SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity,TimeEventContext) func, any data) script.method.server.Entity.StartTimeEvent#d9b6635334d5ae05 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:93 SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self
uint32 Entity.StartTimeEvent(timespan delay, callback(void,Entity) func) script.method.server.Entity.StartTimeEvent#e59548a665ddb838 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:65 SyncScope: requires self to schedule; fired handler later gets dispatcher cover for self
void Entity.StopTimeEvent(callback(void,Entity,any) func) script.method.server.Entity.StopTimeEvent#1ff4e8b7bdb6f35c Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:191 SyncScope: requires self; stops events bound to self, no cover change
void Entity.StopTimeEvent(callback(void,Entity,TimeEventContext) func) script.method.server.Entity.StopTimeEvent#58fd464d379e5ea5 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:205 SyncScope: requires self; stops events bound to self, no cover change
void Entity.StopTimeEvent(uint32 id) script.method.server.Entity.StopTimeEvent#be90949683fff93d Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:212 SyncScope: requires self; stops event bound to self, no cover change
void Entity.StopTimeEvent(callback(void,Entity) func) script.method.server.Entity.StopTimeEvent#d792082ed73a8fc8 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:184 SyncScope: requires self; stops events bound to self, no cover change
void Entity.StopTimeEvent(callback(void,Entity,any[]) func) script.method.server.Entity.StopTimeEvent#ddfbd34ed1764f92 Player, Location, Map, Critter, Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 TimeEventRelated Source/Scripting/ServerEntityScriptMethods.cpp:198 SyncScope: requires self; stops events bound to self, no cover change

Game (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
bool Game.CallStaticItemFunction(Critter? cr, StaticItem staticItem, Item? usedItem, any param) script.method.server.Game.CallStaticItemFunction Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1423 SyncScope: requires cr and usedItem when non-null; staticItem is static map data, not a live entity cover
Item Game.CloneItem(Item item) script.method.server.Game.CloneItem Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:333 Clones the complete live item and returns the new item with synchronization cover
Critter Game.CreateCritter(hstring protoId, bool forPlayer, CritterProperty=>any props) script.method.server.Game.CreateCritter#151d7b0fa45c079e Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:76 SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use
Critter Game.CreateCritter(ProtoCritter proto, bool forPlayer) script.method.server.Game.CreateCritter#e68fa5ea3ffe3cc4 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:68 SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use
Critter Game.CreateCritter(hstring protoId, bool forPlayer) script.method.server.Game.CreateCritter#e774d859a418b9da Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:60 SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use
Critter Game.CreateCritter(ProtoCritter proto, bool forPlayer, CritterProperty=>any props) script.method.server.Game.CreateCritter#e8d3f028fa79075f Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:97 SyncScope: no existing entity cover required; creates a detached critter, cover it before cross-entity use
Item Game.CreateItem(hstring protoId, ItemProperty=>int32 props) script.method.server.Game.CreateItem#27766bb940021b1f Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:313 Creates an item with integer property overrides applied before OnItemInit and returns it with synchronization cover
Item Game.CreateItem(ProtoItem proto) script.method.server.Game.CreateItem#6029176d1f44719d Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:306 Creates an item from the supplied prototype descriptor and returns it with synchronization cover
Item Game.CreateItem(hstring protoId) script.method.server.Game.CreateItem#ba49673cbfedbc07 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:295 Creates an item from the supplied prototype id and returns it with synchronization cover
Location Game.CreateLocation(hstring protoId, hstring[] map_pids, LocationProperty=>any props) script.method.server.Game.CreateLocation#03c25a496a41709a Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:613 SyncScope: creates a new location/maps in the current context; returned location is covered by registration self-sync
Location Game.CreateLocation(ProtoLocation proto, LocationProperty=>any props) script.method.server.Game.CreateLocation#09335f3291c54d05 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:598 SyncScope: creates a new location in the current context; returned location is covered by registration self-sync
Location Game.CreateLocation(ProtoLocation proto) script.method.server.Game.CreateLocation#392f59fecd72fe17 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:561 SyncScope: creates a new location in the current context; returned location is covered by registration self-sync
Location Game.CreateLocation(hstring protoId) script.method.server.Game.CreateLocation#4f3d2969824dd3bc Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:553 SyncScope: creates a new location in the current context; returned location is covered by registration self-sync
Location Game.CreateLocation(hstring protoId, hstring[] map_pids) script.method.server.Game.CreateLocation#5a0f0539462eafe3 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:569 SyncScope: creates a new location/maps in the current context; returned location is covered by registration self-sync
Location Game.CreateLocation(hstring protoId, LocationProperty=>any props) script.method.server.Game.CreateLocation#c94de2fea30a1454 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:577 SyncScope: creates a new location in the current context; returned location is covered by registration self-sync
Player Game.CreateNotLoggedInPlayer() script.method.server.Game.CreateNotLoggedInPlayer Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:699 SyncScope: no existing entity cover required; creates a disconnected not-logged-in player session
ident[] Game.DbGetAllRecordIds(hstring collectionName) script.method.server.Game.DbGetAllRecordIds Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1040 SyncScope: database collection scan only; no live entity cover is required
string[] Game.DbGetAllRecordKeys(hstring collectionName) script.method.server.Game.DbGetAllRecordKeys Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1051 SyncScope: database collection scan only; no live entity cover is required
string=>string Game.DbGetPlayerData(ident playerId) script.method.server.Game.DbGetPlayerData Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1071 SyncScope: database lookup only; does not touch live player entity cover
string=>string Game.DbGetRecord(hstring collectionName, string id) script.method.server.Game.DbGetRecord#86e082d9df76b104 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1138 SyncScope: database record read only; no live entity cover is required
string=>string Game.DbGetRecord(hstring collectionName, ident id) script.method.server.Game.DbGetRecord#c524f7821136061a Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1117 SyncScope: database record read only; no live entity cover is required
bool Game.DbHasEntity(Entity entity) script.method.server.Game.DbHasEntity Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1062 SyncScope: requires entity for type/id read; database lookup itself does not cover a live entity
bool Game.DbHasRecord(hstring collectionName, string id) script.method.server.Game.DbHasRecord#31a3ffa964f519b8 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1103 SyncScope: database record lookup only; no live entity cover is required
bool Game.DbHasRecord(hstring collectionName, ident id) script.method.server.Game.DbHasRecord#e13466af940b3833 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1089 SyncScope: database record lookup only; no live entity cover is required
void Game.DbInsertRecord(hstring collectionName, ident id, string=>string keyValues) script.method.server.Game.DbInsertRecord#23ac03d711edaa50 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1159 SyncScope: database record insert only; no live entity cover is required
void Game.DbInsertRecord(hstring collectionName, string id, string=>string keyValues) script.method.server.Game.DbInsertRecord#27a079e12448f9d8 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1196 SyncScope: database record insert only; no live entity cover is required
void Game.DbRemoveRecord(hstring collectionName, ident id) script.method.server.Game.DbRemoveRecord#2039b29db1a1d593 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1337 SyncScope: database record remove only; no live entity cover is required
void Game.DbRemoveRecord(hstring collectionName, string id) script.method.server.Game.DbRemoveRecord#2749ed5b0c8482ba Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1353 SyncScope: database record remove only; no live entity cover is required
void Game.DbUpdateRecordBool(hstring collectionName, ident id, string key, bool value) script.method.server.Game.DbUpdateRecordBool#6b7737017a2e23dd Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1323 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordBool(hstring collectionName, string id, string key, bool value) script.method.server.Game.DbUpdateRecordBool#717491d844575aca Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1330 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordFloat64(hstring collectionName, ident id, string key, float64 value) script.method.server.Game.DbUpdateRecordFloat64#0e7e221242df2792 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1309 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordFloat64(hstring collectionName, string id, string key, float64 value) script.method.server.Game.DbUpdateRecordFloat64#f5d0799b4804bb25 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1316 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordInt64(hstring collectionName, string id, string key, int64 value) script.method.server.Game.DbUpdateRecordInt64#4b791154e44562fd Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1302 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordInt64(hstring collectionName, ident id, string key, int64 value) script.method.server.Game.DbUpdateRecordInt64#91d6b71d16aee463 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1295 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordString(hstring collectionName, ident id, string key, string value) script.method.server.Game.DbUpdateRecordString#76e92f4eee20fb7b Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1281 SyncScope: database record update only; no live entity cover is required
void Game.DbUpdateRecordString(hstring collectionName, string id, string key, string value) script.method.server.Game.DbUpdateRecordString#cbc3625de444b49c Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1288 SyncScope: database record update only; no live entity cover is required
void Game.DestroyCritter(Critter? cr) script.method.server.Game.DestroyCritter Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:521 SyncScope: requires cr + current source map when cr is non-null and not player-controlled
void Game.DestroyCritters(Critter[] critters) script.method.server.Game.DestroyCritters Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:536 SyncScope: requires every non-null cr + current source map when not player-controlled
void Game.DestroyEntities(Entity[] entities) script.method.server.Game.DestroyEntities Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:481 SyncScope: requires every non-null entity + current parent when present; destroys each subtree
void Game.DestroyEntity(Entity? entity) script.method.server.Game.DestroyEntity Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:469 SyncScope: requires entity + current parent when entity is non-null; destroys the entity subtree
void Game.DestroyItem(Item? item) script.method.server.Game.DestroyItem Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:495 SyncScope: requires item + current item parent when item is non-null; destroys the item subtree
void Game.DestroyItems(Item[] items) script.method.server.Game.DestroyItems Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:507 SyncScope: requires every non-null item + current item parent; destroys each item subtree
void Game.DestroyLocation(Location? loc) script.method.server.Game.DestroyLocation Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:634 SyncScope: requires loc when non-null; destroy cascade self-syncs covered child maps/entities
void Game.DestroyMap(Map? map) script.method.server.Game.DestroyMap Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:646 SyncScope: requires map + parent location when map is non-null; destroy cascade self-syncs covered child entities
void Game.DestroyUnloadedCritter(ident crId) script.method.server.Game.DestroyUnloadedCritter Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:130 SyncScope: unloaded-record operation only; no live entity cover is required
Item[] Game.GetAllItems(ProtoItem? proto) script.method.server.Game.GetAllItems#5f63b29e3fbd4374 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:991 SyncScope: registry scan only; returned item handles are not covered for later reads/mutations
Item[] Game.GetAllItems(hstring pid) script.method.server.Game.GetAllItems#986ac88634199639 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:971 SyncScope: registry scan only; returned item handles are not covered for later reads/mutations
Critter[] Game.GetAllNpc(hstring pid) script.method.server.Game.GetAllNpc#568d2e4962ad093b Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1377 SyncScope: registry scan only; returned NPC critter handles are not covered for later reads/mutations
Critter[] Game.GetAllNpc(ProtoCritter proto) script.method.server.Game.GetAllNpc#d318af6f5c78cd43 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1396 SyncScope: registry scan only; returned NPC critter handles are not covered for later reads/mutations
Critter[] Game.GetAllNpc() script.method.server.Game.GetAllNpc#e7c595cfaf4c11a4 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1369 SyncScope: registry scan only; returned NPC critter handles are not covered for later reads/mutations
int64 Game.GetAllocatorMemoryUsage() script.method.server.Game.GetAllocatorMemoryUsage Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1730 SyncScope: allocator metric read only; no entity cover is required
Critter? Game.GetCritter(ident crId) script.method.server.Game.GetCritter Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:658 SyncScope: registry lookup only; returned critter handle is not covered for later reads/mutations
int32 Game.GetCritterRegistryCount() script.method.server.Game.GetCritterRegistryCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1767 SyncScope: registry count only; no entity cover required
Critter[] Game.GetCritters(CritterFindType findType) script.method.server.Game.GetCritters Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:682 SyncScope: registry scan only; returned critter handles are not covered for later reads/mutations
int32 Game.GetDistance(Item item1, Item item2) script.method.server.Game.GetDistance#1be05ad1508d9bdf Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:158 SyncScope: requires item1 + item2; reads same-map placement from the covered items
int32 Game.GetDistance(Item item, Critter cr) script.method.server.Game.GetDistance#200d823fdf545d92 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:198 SyncScope: requires item + cr; reads same-map placement from the covered entities
int32 Game.GetDistance(mpos hex, Critter cr) script.method.server.Game.GetDistance#33a4d51ef8eece2a Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:236 SyncScope: requires cr; reads critter placement from the covered critter
int32 Game.GetDistance(Critter cr, Item item) script.method.server.Game.GetDistance#3dade8869ec8c0ac Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:177 SyncScope: requires cr + item; reads same-map placement from the covered entities
int32 Game.GetDistance(Item item, mpos hex) script.method.server.Game.GetDistance#8298d537bb9c7c37 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:253 SyncScope: requires item; reads item placement from the covered item
int32 Game.GetDistance(Critter cr, mpos hex) script.method.server.Game.GetDistance#8a80a760debf852d Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:219 SyncScope: requires cr; reads critter placement from the covered critter
int32 Game.GetDistance(mpos hex, Item item) script.method.server.Game.GetDistance#b273c01749f73e8c Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:268 SyncScope: requires item; reads item placement from the covered item
int32 Game.GetDistance(Critter cr1, Critter cr2) script.method.server.Game.GetDistance#dacea0c00ba4c5f1 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:137 SyncScope: requires cr1 + cr2; reads same-map placement from the covered critters
Entity? Game.GetEntity(ident entityId) script.method.server.Game.GetEntity Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:670 SyncScope: registry lookup only; returned entity handle is not covered for later reads/mutations
int32 Game.GetEntityRegistryCount() script.method.server.Game.GetEntityRegistryCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1739 SyncScope: registry count only; no entity cover is required
Entity[] Game.GetHeldSyncEntities() script.method.server.Game.GetHeldSyncEntities Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1687 SyncScope: returns current held cover; does not change cover
Item? Game.GetItem(ident itemId) script.method.server.Game.GetItem Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:283 SyncScope: registry lookup only; returned item handle is not covered for later reads/mutations
int32 Game.GetItemRegistryCount() script.method.server.Game.GetItemRegistryCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1774 SyncScope: registry count only; no entity cover required
hstring[] Game.GetItemRegistryProtoIds() script.method.server.Game.GetItemRegistryProtoIds Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1782 SyncScope: registry snapshot of proto ids only; reads the registry map without touching entity state,
so no entity cover is required. Intended for test-harness leak diagnostics
Location? Game.GetLocation(ident locId) script.method.server.Game.GetLocation#08a98bf7bce0a9bf Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:850 SyncScope: registry lookup only; returned location handle is not covered for later reads/mutations
Location? Game.GetLocation(ProtoLocation locProto, int32 skipCount = 0) script.method.server.Game.GetLocation#2f5eccddea2f5dd1 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:866 SyncScope: registry lookup only; returned location handle is not covered for later reads/mutations
Location? Game.GetLocation(hstring locPid, int32 skipCount = 0) script.method.server.Game.GetLocation#4b1903ede1dd2fa2 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:858 SyncScope: registry lookup only; returned location handle is not covered for later reads/mutations
Location? Game.GetLocation(LocationProperty property, int32 propertyValue) script.method.server.Game.GetLocation#8d03e18599ee2a1e Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:875 SyncScope: registry scan only; returned location handle is not covered for later reads/mutations
int32 Game.GetLocationRegistryCount() script.method.server.Game.GetLocationRegistryCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1753 SyncScope: registry count only; no entity cover required
Location[] Game.GetLocations() script.method.server.Game.GetLocations#53d313c4ee2358d8 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:891 SyncScope: registry scan only; returned location handles are not covered for later reads/mutations
Location[] Game.GetLocations(ProtoLocation? proto) script.method.server.Game.GetLocations#7e3ec9d90972cfaf Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:926 SyncScope: registry scan only; returned location handles are not covered for later reads/mutations
Location[] Game.GetLocations(hstring pid) script.method.server.Game.GetLocations#8eb7a49e747de27a Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:906 SyncScope: registry scan only; returned location handles are not covered for later reads/mutations
Location[] Game.GetLocations(LocationProperty property, int32 propertyValue) script.method.server.Game.GetLocations#c590f9bbe1535ddd Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:953 SyncScope: registry scan only; returned location handles are not covered for later reads/mutations
Map? Game.GetMap(hstring mapPid, int32 skipCount = 0) script.method.server.Game.GetMap#28a9744f2e2f208e Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:774 SyncScope: registry lookup only; returned map handle is not covered for later reads/mutations
Map? Game.GetMap(ident mapId) script.method.server.Game.GetMap#38ce2f11f2b9397e Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:766 SyncScope: registry lookup only; returned map handle is not covered for later reads/mutations
Map? Game.GetMap(ProtoMap mapProto, int32 skipCount = 0) script.method.server.Game.GetMap#b7b3d34523400d1f Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:782 SyncScope: registry lookup only; returned map handle is not covered for later reads/mutations
int32 Game.GetMapRegistryCount() script.method.server.Game.GetMapRegistryCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1760 SyncScope: registry count only; no entity cover required
Map[] Game.GetMaps(hstring pid) script.method.server.Game.GetMaps#12174f7cc9f609d1 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:799 SyncScope: registry scan only; returned map handles are not covered for later reads/mutations
Map[] Game.GetMaps() script.method.server.Game.GetMaps#3cd2c62b701248d5 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:791 SyncScope: registry scan only; returned map handles are not covered for later reads/mutations
Map[] Game.GetMaps(ProtoMap? proto) script.method.server.Game.GetMaps#779d5c9f8b1fd466 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:821 SyncScope: registry scan only; returned map handles are not covered for later reads/mutations
Player[] Game.GetOnlinePlayers() script.method.server.Game.GetOnlinePlayers Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:1018 SyncScope: registry scan only; returned player handles are not covered for later reads/mutations
Player? Game.GetPlayer(ident playerId) script.method.server.Game.GetPlayer Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerGlobalScriptMethods.cpp:754 SyncScope: registry lookup only; returned player handle is not covered for later reads/mutations
int32 Game.GetPlayerRegistryCount() script.method.server.Game.GetPlayerRegistryCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1746 SyncScope: registry count only; no entity cover required
int64 Game.GetProcessMemoryUsage() script.method.server.Game.GetProcessMemoryUsage Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1721 SyncScope: process metric read only; no entity cover is required
ProtoCritter[] Game.GetProtoCrittersForProtoMap(ProtoMap proto) script.method.server.Game.GetProtoCrittersForProtoMap Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1450 SyncScope: static proto-map read only; no live entity cover is required
ident[] Game.GetRegisteredPlayerIds() script.method.server.Game.GetRegisteredPlayerIds Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1033 SyncScope: database registry read only; no live player cover is required
StaticItem[] Game.GetStaticItemsForProtoMap(ProtoMap proto) script.method.server.Game.GetStaticItemsForProtoMap Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1441 SyncScope: static proto-map read only; no live entity cover is required
int32 Game.GetTextCount(TextPackKey textKey) script.method.server.Game.GetTextCount Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1475 SyncScope: language-pack read only; no entity cover is required
bool Game.IsEntityLocked(Entity? entity) script.method.server.Game.IsEntityLocked Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1696 SyncScope: sync-safe probe; returns whether entity is covered without emitting diagnostics
bool Game.IsTextPresent(TextPackKey textKey) script.method.server.Game.IsTextPresent Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1468 SyncScope: language-pack read only; no entity cover is required
Critter Game.LoadCritter(ident crId, bool forPlayer) script.method.server.Game.LoadCritter Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:112 SyncScope: database/registry load only; returned critter must be covered before cross-entity use
void Game.Lock() script.method.server.Game.Lock Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1705 SyncScope: locks the Game singleton bucket; do not call Game.Sync while this lock is held
Player Game.LoginPlayerToExistentRecord(Player notLoggedInPlayer, ident playerId) script.method.server.Game.LoginPlayerToExistentRecord Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:737 SyncScope: requires notLoggedInPlayer plus the prepared main-critter/map/location graph; a live reconnect
additionally requires the existing player. Login preserves the caller-provided cover
Player Game.LoginPlayerToNewRecord(Player notLoggedInPlayer) script.method.server.Game.LoginPlayerToNewRecord Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:708 SyncScope: requires notLoggedInPlayer; login mutates that player/session record
Player Game.LoginPlayerToTempSession(Player notLoggedInPlayer) script.method.server.Game.LoginPlayerToTempSession Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:722 SyncScope: requires notLoggedInPlayer; login mutates that player/session record
Item? Game.MoveItem(Item item, Item toCont, any stackId = any()) script.method.server.Game.MoveItem#2ed0d82a6f587a26 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:373 SyncScope: requires item + current item parent + destination container item
Item? Game.MoveItem(Item item, Map toMap, mpos toHex) script.method.server.Game.MoveItem#883528ad0763e772 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:357 SyncScope: requires item + current item parent + destination map
Item? Game.MoveItem(Item item, Critter toCr) script.method.server.Game.MoveItem#c26f82c316789816 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:346 Moves the complete item to the destination critter and returns it, or null if the move removes it
void Game.MoveItems(Item[] items, Critter toCr) script.method.server.Game.MoveItems#5402fba4af9b29a1 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:384 SyncScope: requires destination critter + every item and its current parent
void Game.MoveItems(Item[] items, Item toCont, any stackId = any()) script.method.server.Game.MoveItems#8a09125d1c5aeacb Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:442 SyncScope: requires destination container item + every item and its current parent
void Game.MoveItems(Item[] items, Map toMap, mpos toHex) script.method.server.Game.MoveItems#efe80393199559d9 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:411 SyncScope: requires destination map + every item and its current parent
void Game.SetSynchronizedTime(synctime time) script.method.server.Game.SetSynchronizedTime Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1415 SyncScope: requires Game.Lock singleton; mutates global synchronized time, not a live entity
void Game.Sync(Entity entity) script.method.server.Game.Sync#3a28adb1be02af8c Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async Source/Scripting/ServerGlobalScriptMethods.cpp:1567 SyncScope: replaces current cover with entity plus engine auto-widen partners
void Game.Sync(Entity entity1, Entity entity2, Entity entity3) script.method.server.Game.Sync#8a5e8bb38f1776db Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async, AllowDestroyedEntityArgs Source/Scripting/ServerGlobalScriptMethods.cpp:1599 SyncScope: replaces current cover with all entities plus engine auto-widen partners
void Game.Sync(Entity[] entities) script.method.server.Game.Sync#a0c5737d3ba111b8 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async, AllowDestroyedEntityArgs Source/Scripting/ServerGlobalScriptMethods.cpp:1621 SyncScope: replaces current cover with all non-null entities plus engine auto-widen partners
void Game.Sync(Entity entity1, Entity entity2) script.method.server.Game.Sync#b42b6f6d6b684d2a Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async, AllowDestroyedEntityArgs Source/Scripting/ServerGlobalScriptMethods.cpp:1581 SyncScope: replaces current cover with both entities plus engine auto-widen partners
void Game.SyncRelease() script.method.server.Game.SyncRelease Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1671 SyncScope: releases the full held set — the entity cover AND any singleton Game.Lock entries
(SyncContext::Release drains both buckets); a Game.Lock taken before this call needs no Unlock after it
void Game.SyncWiden(Entity[] entities) script.method.server.Game.SyncWiden Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async, AllowDestroyedEntityArgs Source/Scripting/ServerGlobalScriptMethods.cpp:1646 Widens the current synchronization cover in place to include the supplied live entities
void Game.SyncYield() script.method.server.Game.SyncYield Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async Source/Scripting/ServerGlobalScriptMethods.cpp:1679 Hands the current thread's whole entity cover to waiting workers and reacquires it before returning; a held Game singleton forbids this call
int32 Game.SystemCall(string command, string& output) script.method.server.Game.SystemCall#5f9bd54717eb40b8 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1534 SyncScope: external process call only; requires no entity cover but must not run under unrelated entity locks
int32 Game.SystemCall(string command) script.method.server.Game.SystemCall#bc91017a887fc615 Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1524 SyncScope: external process call only; requires no entity cover but must not run under unrelated entity locks
bool Game.TrySyncEntity(ident entity_id) script.method.server.Game.TrySyncEntity Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 Async Source/Scripting/ServerGlobalScriptMethods.cpp:1550 Resolves an entity id, acquires synchronization cover for the live entity, and reports whether it remains usable
void Game.UnloadCritter(Critter cr) script.method.server.Game.UnloadCritter Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:120 SyncScope: requires cr + current parent map; unload mutates critter simulation state
void Game.Unlock() script.method.server.Game.Unlock Game server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerGlobalScriptMethods.cpp:1713 SyncScope: unlocks the Game singleton bucket; entity cover is unchanged

Item (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
Item Item.AddItem(ProtoItem proto, any stackId = any()) script.method.server.Item.AddItem#bfe6263d4ff550ad Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerItemScriptMethods.cpp:88 SyncScope: requires self; creates and attaches a new inner item under the container cover
Item Item.AddItem(hstring pid, any stackId = any()) script.method.server.Item.AddItem#c6fbcb98959420b1 Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerItemScriptMethods.cpp:73 SyncScope: requires self; creates and attaches a new inner item under the container cover
Critter? Item.GetCritter() script.method.server.Item.GetCritter Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerItemScriptMethods.cpp:127 SyncScope: requires self; returns holder critter when item is in critter inventory, not a new cover
Item[] Item.GetItems(any stackId = any()) script.method.server.Item.GetItems Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerItemScriptMethods.cpp:100 SyncScope: requires self; returns inner item handles covered by self while the cover remains
Map? Item.GetMap() script.method.server.Item.GetMap Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerItemScriptMethods.cpp:109 SyncScope: requires self; may also read holder critter/map parent chain, returned map is not covered for later reads
Map? Item.GetMapPosition(mpos& hex) script.method.server.Item.GetMapPosition Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 PassOwnership Source/Scripting/ServerItemScriptMethods.cpp:118 SyncScope: requires self; may also read holder critter/map parent chain, returned map is not covered for later reads
void Item.RefreshVisibility() script.method.server.Item.RefreshVisibility Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerItemScriptMethods.cpp:136 SyncScope: requires self + current map when map-owned; refreshes map visibility/blocking caches
void Item.SetupScript(callback(void,Item,bool) initFunc) script.method.server.Item.SetupScript Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerItemScriptMethods.cpp:47 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities
void Item.SetupScriptEx(hstring initFunc) script.method.server.Item.SetupScriptEx Item server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerItemScriptMethods.cpp:62 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities

Location (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
Map Location.AddMap(ProtoMap mapProto) script.method.server.Location.AddMap#64169b002e08e159 Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:80 SyncScope: requires self; creates and attaches a child map under the location cover
Map Location.AddMap(hstring mapPid) script.method.server.Location.AddMap#f4dae4b3925387ad Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:68 SyncScope: requires self; creates and attaches a child map under the location cover
Map? Location.GetMap(ProtoMap mapProto) script.method.server.Location.GetMap#102f60993beb7009 Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:116 SyncScope: requires self; returned map is covered by self while the location cover remains
Map? Location.GetMap(hstring mapPid) script.method.server.Location.GetMap#c71a7456cd1c7874 Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:101 SyncScope: requires self; returned map is covered by self while the location cover remains
Map Location.GetMapByIndex(int32 index) script.method.server.Location.GetMapByIndex Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:132 SyncScope: requires self; returned map is covered by self while the location cover remains
int32 Location.GetMapCount() script.method.server.Location.GetMapCount Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:94 SyncScope: requires self; counts child maps covered by the location cover
Map[] Location.GetMaps() script.method.server.Location.GetMaps Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:141 SyncScope: requires self; returned maps are covered by self while the location cover remains
void Location.Regenerate() script.method.server.Location.Regenerate Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:150 SyncScope: requires self; regenerates all child maps covered by the location cover
void Location.SetupScript(callback(void,Location,bool) initFunc) script.method.server.Location.SetupScript Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:42 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities
void Location.SetupScriptEx(hstring initFunc) script.method.server.Location.SetupScriptEx Location server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerLocationScriptMethods.cpp:57 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities

Map (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir, CritterProperty=>any props) script.method.server.Map.AddCritter#1e4e76b759d6c5e8 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1159 SyncScope: requires self; creates and attaches a new critter on the map under self cover
Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir, CritterProperty=>int32 props) script.method.server.Map.AddCritter#42310745cd07d9a7 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1111 SyncScope: requires self; creates and attaches a new critter on the map under self cover
Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir) script.method.server.Map.AddCritter#469abe60680fae4e Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1054 SyncScope: requires self; creates and attaches a new critter on the map under self cover
Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir) script.method.server.Map.AddCritter#4bf2d1bf57efc238 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1069 SyncScope: requires self; creates and attaches a new critter on the map under self cover
Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir, CritterProperty=>int32 props) script.method.server.Map.AddCritter#8b44cc2e5aeaa303 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1084 SyncScope: requires self; creates and attaches a new critter on the map under self cover
Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir, CritterProperty=>any props) script.method.server.Map.AddCritter#ab45ffd3c807403c Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1132 SyncScope: requires self; creates and attaches a new critter on the map under self cover
Item Map.AddItem(mpos hex, hstring protoId, ItemProperty=>int32 props) script.method.server.Map.AddItem#3b5f3b7a0ad0569d Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:106 SyncScope: requires self; creates and attaches a new map item under the map cover
Item Map.AddItem(mpos hex, ProtoItem proto) script.method.server.Map.AddItem#4c836c86ebb331f9 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:91 SyncScope: requires self; creates and attaches a new map item under the map cover
Item Map.AddItem(mpos hex, hstring protoId) script.method.server.Map.AddItem#93da72a5ec69c371 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:76 SyncScope: requires self; creates and attaches a new map item under the map cover
Item Map.AddItem(mpos hex, ProtoItem proto, ItemProperty=>int32 props) script.method.server.Map.AddItem#dd69e509a0195144 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:133 SyncScope: requires self; creates and attaches a new map item under the map cover
void Map.BlockHex(mpos hex, bool full) script.method.server.Map.BlockHex Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1254 SyncScope: requires self; mutates manual blocking for one map hex
bool Map.CheckPlaceForItem(mpos hex, hstring pid) script.method.server.Map.CheckPlaceForItem#7df5c41f5f61890c Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1234 SyncScope: requires self; reads map placement rules and item prototype data
bool Map.CheckPlaceForItem(mpos hex, ProtoItem proto) script.method.server.Map.CheckPlaceForItem#f95a6f1b9e4a1b61 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1247 SyncScope: requires self; reads map placement rules and item prototype data
bool Map.FindPathToAny(Critter cr, mpos[] targetHexes, int32& pathLength, mpos& targetHex, callback(bool,Critter,Item) gagCallback) script.method.server.Map.FindPathToAny#049a83ae871129e5 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1000 SyncScope: requires self + cr; pathing reads map blockers and cr state
bool Map.FindPathToAny(mpos fromHex, mpos[] targetHexes, int32& pathLength, mpos& targetHex, callback(bool,Item) gagCallback) script.method.server.Map.FindPathToAny#d989184e940c3179 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:967 SyncScope: requires self; pathing reads map blockers and optional gag callback items
mpos[] Map.FindReachableHexes(mpos fromHex, mpos[] targetHexes, callback(bool,Item) gagCallback) script.method.server.Map.FindReachableHexes Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1032 Answers which target hexes are reachable from the start within the configured path-length limit
Critter? Map.GetCritter(ident crid) script.method.server.Map.GetCritter#beaf90ce99481bb9 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:657 SyncScope: requires self; returned critter is covered by self while the map cover remains
Critter? Map.GetCritter(CritterProperty property, int32 propertyValue, CritterFindType findType) script.method.server.Map.GetCritter#cc2efc7ac9caf8b7 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:682 SyncScope: requires self; returned critter is covered by self while the map cover remains
Critter? Map.GetCritterOnHex(mpos hex) script.method.server.Map.GetCritterOnHex Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:665 SyncScope: requires self; returned critter is covered by self while the map cover remains
Critter[] Map.GetCritters(CritterFindType findType) script.method.server.Map.GetCritters#81d4328569cd9426 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:753 SyncScope: requires self; returned critters are covered by self while the map cover remains
Critter[] Map.GetCritters(hstring pid, CritterFindType findType) script.method.server.Map.GetCritters#addc705539406d44 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:772 SyncScope: requires self; returned critters are covered by self while the map cover remains
Critter[] Map.GetCritters(CritterProperty property, int32 propertyValue, CritterFindType findType) script.method.server.Map.GetCritters#d9bfa22ace1ec9d4 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:808 SyncScope: requires self; returned critters are covered by self while the map cover remains
Critter[] Map.GetCritters(ProtoCritter proto, CritterFindType findType) script.method.server.Map.GetCritters#e79de6b56cb9f3b3 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:790 SyncScope: requires self; returned critters are covered by self while the map cover remains
Critter[] Map.GetCrittersInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType) script.method.server.Map.GetCrittersInPath#8b046729d6d79d34 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:827 SyncScope: requires self; returned path critters are covered by self while the map cover remains
Critter[] Map.GetCrittersInPath(mpos fromHex, mpos toHex, float32 angle, int32 dist, CritterFindType findType, mpos& preBlockHex, mpos& blockHex) script.method.server.Map.GetCrittersInPath#a2a00a1dfe4f3d7e Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:836 SyncScope: requires self; returned path critters are covered by self while the map cover remains
Critter[] Map.GetCrittersInRadius(mpos hex, int32 radius, CritterFindType findType) script.method.server.Map.GetCrittersInRadius Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:716 SyncScope: requires self; returned critters are covered by self while the map cover remains
Critter[] Map.GetCrittersOnHex(mpos hex, CritterFindType findType) script.method.server.Map.GetCrittersOnHex Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:697 SyncScope: requires self; returned critters are covered by self while the map cover remains
Critter[] Map.GetCrittersWhoSeeHex(mpos hex, CritterFindType findType) script.method.server.Map.GetCrittersWhoSeeHex#331d6938741ba331 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:847 SyncScope: requires self; returned observer critters are covered by self while the map cover remains
Critter[] Map.GetCrittersWhoSeeHex(mpos hex, int32 radius, CritterFindType findType) script.method.server.Map.GetCrittersWhoSeeHex#6295b4bbbc256992 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:862 SyncScope: requires self; returned observer critters are covered by self while the map cover remains
Critter[] Map.GetCrittersWhoSeePath(mpos fromHex, mpos toHex, CritterFindType findType) script.method.server.Map.GetCrittersWhoSeePath Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:877 SyncScope: requires self; returned observer critters are covered by self while the map cover remains
void Map.GetHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist) script.method.server.Map.GetHexInPath Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:894 SyncScope: requires self; path trace reads static/map blockers only
Item? Map.GetItem(ident itemId) script.method.server.Map.GetItem Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:154 SyncScope: requires self; returned item is covered by self while the map cover remains
Item? Map.GetItemInRadius(mpos hex, int32 radius, hstring pid) script.method.server.Map.GetItemInRadius#2c45a3b349bce706 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:210 SyncScope: requires self; returned item is covered by self while the map cover remains
Item? Map.GetItemInRadius(mpos hex, int32 radius, ProtoItem proto) script.method.server.Map.GetItemInRadius#43a0e23b140b9e9a Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:232 SyncScope: requires self; returned item is covered by self while the map cover remains
Item? Map.GetItemInRadius(mpos hex, int32 radius, ItemProperty property, int32 propertyValue) script.method.server.Map.GetItemInRadius#fe27ffaff6bf5b08 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:254 SyncScope: requires self; returned item is covered by self while the map cover remains
Item? Map.GetItemOnHex(mpos hex, ProtoItem proto) script.method.server.Map.GetItemOnHex#6ece718d14bda9df Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:178 SyncScope: requires self; returned item is covered by self while the map cover remains
Item? Map.GetItemOnHex(mpos hex, hstring pid) script.method.server.Map.GetItemOnHex#bde72d72df216ffd Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:166 SyncScope: requires self; returned item is covered by self while the map cover remains
Item? Map.GetItemOnHex(mpos hex, ItemProperty property, int32 propertyValue) script.method.server.Map.GetItemOnHex#fd531ae0c65b5f38 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:190 SyncScope: requires self; returned item is covered by self while the map cover remains
Item[] Map.GetItems(ItemProperty property, int32 propertyValue) script.method.server.Map.GetItems#83c145745774df22 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:397 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItems(hstring pid) script.method.server.Map.GetItems#986ac88634199639 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:285 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItems() script.method.server.Map.GetItems#b851260ade7c353c Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:277 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItems(ProtoItem proto) script.method.server.Map.GetItems#ef66ddcc26718dfe Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:303 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItemsInRadius(mpos hex, int32 radius, ProtoItem proto) script.method.server.Map.GetItemsInRadius#1b2344cf4e6a8ad6 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:372 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItemsInRadius(mpos hex, int32 radius) script.method.server.Map.GetItemsInRadius#2c10a43df574d95a Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:333 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItemsInRadius(mpos hex, int32 radius, hstring pid) script.method.server.Map.GetItemsInRadius#71e75da3d8138709 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:347 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItemsInRadius(mpos hex, int32 radius, ItemProperty property, int32 propertyValue) script.method.server.Map.GetItemsInRadius#e5b26ab1ca51093e Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:440 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItemsOnHex(mpos hex) script.method.server.Map.GetItemsOnHex#2becb51a4793de35 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:321 SyncScope: requires self; returned items are covered by self while the map cover remains
Item[] Map.GetItemsOnHex(mpos hex, ItemProperty property, int32 propertyValue) script.method.server.Map.GetItemsOnHex#5db3ed64fff8551d Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:416 SyncScope: requires self; returned items are covered by self while the map cover remains
Location Map.GetLocation() script.method.server.Map.GetLocation Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:68 SyncScope: requires self; returns parent location, but does not cover it for later reads
int32 Map.GetPathLength(Critter cr, mpos toHex, int32 cut, callback(bool,Critter,Item) gagCallabck) script.method.server.Map.GetPathLength#aaa618b299e12baf Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:942 SyncScope: requires self + cr; pathing reads map blockers and cr state
int32 Map.GetPathLength(mpos fromHex, mpos toHex, int32 cut, callback(bool,Item) gagCallabck) script.method.server.Map.GetPathLength#b14b16361e6bc348 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:916 SyncScope: requires self; pathing reads map blockers and optional gag callback items
int32 Map.GetPlayerCritterCount() script.method.server.Map.GetPlayerCritterCount Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:745 SyncScope: requires self; reads the map's player-critter membership without materializing it
Player[] Map.GetSpectatorPlayers() script.method.server.Map.GetSpectatorPlayers Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:762 SyncScope: requires self; returns the map's current spectator Players. A spectator is an independent Player
root that neither the map nor its location cover includes, so a caller that destroys this map or its location
must cover every returned Player first and re-read this list to prove the membership did not change
StaticItem? Map.GetStaticItem(ident id) script.method.server.Map.GetStaticItem Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:491 SyncScope: requires self; returned static item is map-static data covered by the map cover
StaticItem? Map.GetStaticItemOnHex(mpos hex, ProtoItem proto) script.method.server.Map.GetStaticItemOnHex#2ff535bb81b4c46e Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:511 SyncScope: requires self; returned static item is map-static data covered by the map cover
StaticItem? Map.GetStaticItemOnHex(mpos hex, hstring pid) script.method.server.Map.GetStaticItemOnHex#8f12443105465e0c Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:499 SyncScope: requires self; returned static item is map-static data covered by the map cover
StaticItem[] Map.GetStaticItems(ItemProperty property, int32 propertyValue) script.method.server.Map.GetStaticItems#05085759f098a103 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:630 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItems(ProtoItem proto) script.method.server.Map.GetStaticItems#3d6e192e1648eca6 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:622 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItems(hstring pid) script.method.server.Map.GetStaticItems#ba60a4d88539cc01 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:614 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItems() script.method.server.Map.GetStaticItems#e35ab59d1c820445 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:649 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, ProtoItem proto) script.method.server.Map.GetStaticItemsInRadius#9fcecfdd954f2f40 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:550 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, hstring pid) script.method.server.Map.GetStaticItemsInRadius#b716f83c2f22af43 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:535 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, ItemProperty property, int32 propertyValue) script.method.server.Map.GetStaticItemsInRadius#f3c9729ff42f4ae8 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:588 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItemsOnHex(mpos hex) script.method.server.Map.GetStaticItemsOnHex#4a9a56826105ef2b Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:523 SyncScope: requires self; returned static items are map-static data covered by the map cover
StaticItem[] Map.GetStaticItemsOnHex(mpos hex, ItemProperty property, int32 propertyValue) script.method.server.Map.GetStaticItemsOnHex#5d15ee5943a3edd0 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:565 SyncScope: requires self; returned static items are map-static data covered by the map cover
void Map.GetWallHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist) script.method.server.Map.GetWallHexInPath Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:902 SyncScope: requires self; path trace reads wall blockers only
bool Map.IsHexMovable(mpos hex) script.method.server.Map.IsHexMovable Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1187 SyncScope: requires self; reads map blocking state
bool Map.IsHexShootable(mpos hex) script.method.server.Map.IsHexShootable Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1212 SyncScope: requires self; reads map shoot-blocking state
bool Map.IsHexValid(mpos hex) script.method.server.Map.IsHexValid Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1180 SyncScope: requires self; reads map size only
bool Map.IsHexesMovable(mpos hex, int32 radius) script.method.server.Map.IsHexesMovable Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1198 SyncScope: requires self; reads map blocking state
bool Map.IsOutsideArea(mpos hex) script.method.server.Map.IsOutsideArea Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1223 SyncScope: requires self; reads map outdoor/indoor area state
bool Map.MoveHexByDir(mpos& hex, mdir dir) script.method.server.Map.MoveHexByDir#62392271e1b42030 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1289 SyncScope: requires self; uses map size for a pure coordinate step
int32 Map.MoveHexByDir(mpos& hex, mdir dir, int32 steps) script.method.server.Map.MoveHexByDir#b39016610645244b Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1301 SyncScope: requires self; uses map size for pure coordinate steps
void Map.Regenerate() script.method.server.Map.Regenerate Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1282 SyncScope: requires self; regenerates map content and placement caches
bool Map.RemoveStaticItem(ident staticItemId) script.method.server.Map.RemoveStaticItem#7b30d7a907ece580 Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:469 Removal is one-way for the life of the map instance: clients already on the map are only ever told to drop
a static item, so taking an id back out of the list is rejected rather than silently ignored
bool Map.RemoveStaticItem(StaticItem staticItem) script.method.server.Map.RemoveStaticItem#a89f4bb2ef62c35a Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:480 SyncScope: requires self; mutates the map's own removal list, which the property sync fans out to clients
void Map.SetupScript(callback(void,Map,bool) initFunc) script.method.server.Map.SetupScript Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:43 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities
void Map.SetupScriptEx(hstring initFunc) script.method.server.Map.SetupScriptEx Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:57 SyncScope: requires self; init callback runs under the same cover and must widen before touching other entities
void Map.UnblockHex(mpos hex) script.method.server.Map.UnblockHex Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1268 SyncScope: requires self; mutates manual blocking for one map hex
void Map.VerifyTrigger(Critter cr, mpos hex, mdir dir) script.method.server.Map.VerifyTrigger Map server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerMapScriptMethods.cpp:1319 SyncScope: requires self + cr; trigger verification may inspect/mutate critter-facing map state

Player (server)

Signature Symbol ID Applies to Runtime Contract Flags Source Description
void Player.Disconnect() script.method.server.Player.Disconnect Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:55 SyncScope: requires self; closes this player's connection
Critter? Player.GetControlledCritter() script.method.server.Player.GetControlledCritter Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:102 SyncScope: requires self; returns the controlled critter handle, auto-widened when self is Sync'd
DisconnectReason Player.GetDisconnectReason() script.method.server.Player.GetDisconnectReason Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:69 SyncScope: requires self; reads connection state only
string Player.GetHost() script.method.server.Player.GetHost Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:41 SyncScope: requires self; reads connection endpoint only
int32 Player.GetPort() script.method.server.Player.GetPort Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:48 SyncScope: requires self; reads connection endpoint only
Map? Player.GetViewMapTarget() script.method.server.Player.GetViewMapTarget Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:138 SyncScope: requires self; returns the map self currently spectates, but does not cover it for later reads.
The view target is an independent Map root that self's cover does not include, so a caller that reads or
mutates it covers the returned map first and re-reads this handle to prove the view did not change
void Player.HardDisconnect() script.method.server.Player.HardDisconnect Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:62 SyncScope: requires self; forcibly closes this player's connection
void Player.RefreshCritterMoving(Critter cr) script.method.server.Player.RefreshCritterMoving Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:110 SyncScope: requires self + cr; sends movement state for a critter visible on player's current map
void Player.ResetViewMap() script.method.server.Player.ResetViewMap Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:173 SyncScope: requires self; clears view-map state, no entity reparent
void Player.SetName(string name) script.method.server.Player.SetName Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:76 SyncScope: requires self; mutates player name only
void Player.SwitchCritter(Critter? cr) script.method.server.Player.SwitchCritter Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:93 SyncScope: requires self + cr when cr is non-null; before linkage callers must explicitly cover both
void Player.UnloadMap() script.method.server.Player.UnloadMap Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:180 SyncScope: requires self; clears view-map state and sends unload, no entity reparent
void Player.ViewMap(Map map, mpos hex) script.method.server.Player.ViewMap Player server experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47		 - Source/Scripting/ServerPlayerScriptMethods.cpp:145 SyncScope: requires self + map + map location; sends load-map data and opens a map view for self
Start typing to search.