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 runpython 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 1028 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:332 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:159 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:467 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:476 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:441 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:363 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:247 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:189 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:197 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:225 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:281 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:265 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:126 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:80 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:110 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:302 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:43 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:118 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:151 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:57 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:50 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:89 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:72 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:36 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:64 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:102 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:500 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:423 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:394 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:409 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:181 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:310 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:489 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:29 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:173 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientCritterScriptMethods.cpp:432 | 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, bool excludeExecuting = false) |
script.method.client.Entity.CountTimeEvent#3032339c32e34b9d |
Player, Location, Map, Critter, Item |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:111 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Entity.CountTimeEvent(callback(void,Entity,TimeEventContext) func, bool excludeExecuting = false) |
script.method.client.Entity.CountTimeEvent#417e7527b8152349 |
Player, Location, Map, Critter, Item |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:118 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Entity.CountTimeEvent(callback(void,Entity,any) func, bool excludeExecuting = false) |
script.method.client.Entity.CountTimeEvent#45d21a68801eb4f0 |
Player, Location, Map, Critter, Item |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:104 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Entity.CountTimeEvent(callback(void,Entity) func, bool excludeExecuting = false) |
script.method.client.Entity.CountTimeEvent#7ed3553b71048a0d |
Player, Location, Map, Critter, Item |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:97 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Entity.CountTimeEvent(uint32 id, bool excludeExecuting = false) |
script.method.client.Entity.CountTimeEvent#db3b98741c5df44b |
Player, Location, Map, Critter, Item |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:125 | Counts matching registered time events; excludeExecuting omits executing callbacks |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:195 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:174 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:181 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:188 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:167 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:202 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:209 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:230 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:237 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:223 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:216 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:83 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:34 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:48 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:55 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:90 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:69 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:62 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:20 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:76 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:27 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:41 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:13 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:139 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:153 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:160 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:132 | 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ClientEntityScriptMethods.cpp:146 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1721 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:859 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:400 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:393 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1930 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2086 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:26 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:901 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2079 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2102 | Queues a client connection request for processing by the main loop |
uint32 Game.CreateSpriteSequence(uint32[] sources, int32[] frames, ipos[] offsets, ipos[] motions, int32 framesPerDirection, timespan duration) |
script.method.client.Game.CreateSpriteSequence |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1182 | Creates a stopped independent 2D sequence from explicit direction-major frame arrays and duration |
VideoPlayback Game.CreateVideoPlayback(string videoName, bool looped) |
script.method.client.Game.CreateVideoPlayback |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ClientGlobalScriptMethods.cpp:730 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:66 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:86 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:46 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2109 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1530 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1542 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:344 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1508 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1368 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1410 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1393 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1427 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1446 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1463 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1480 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:753 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:326 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2093 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1221 | Releases a client-local sprite handle; named resources enter the atlas-specific reuse cache, constructed sequences are released, and unknown handles are ignored |
uint8[] Game.GetCacheData(string name) |
script.method.client.Game.GetCacheData |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2003 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2017 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:484 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:511 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:545 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:599 | Returns current local-map or global-map critters whose prototype id matches the supplied prototype and that satisfy the requested CritterFindType filter |
isize[] Game.GetDisplayModes() |
script.method.client.Game.GetDisplayModes |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:127 | Returns distinct pixel dimensions of fullscreen modes for the display containing the client window, or an empty list when unavailable |
isize Game.GetDisplaySize() |
script.method.client.Game.GetDisplaySize |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:120 | Returns the desktop pixel dimensions of the display containing the client window, or zero when unavailable |
int32 Game.GetDistance(Item item1, Item item2) |
script.method.client.Game.GetDistance#1be05ad1508d9bdf |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:198 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:240 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:279 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:218 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:311 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:262 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:296 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:176 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1650 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:113 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:414 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:365 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:407 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:675 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:379 | Returns the live sound-effect volume percentage owned by the audio manager |
int32 Game.GetSpriteDirectionCount(uint32 sprId) |
script.method.client.Game.GetSpriteDirectionCount |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1139 | Returns a checked 2D sprite's direction count; static images have one direction |
timespan Game.GetSpriteDuration(uint32 sprId) |
script.method.client.Game.GetSpriteDuration |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1149 | Returns a checked 2D sprite's duration; static images have zero duration |
int32 Game.GetSpriteFrameCount(uint32 sprId) |
script.method.client.Game.GetSpriteFrameCount |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1129 | Returns a checked 2D sprite's frame count; static images have one frame |
ipos Game.GetSpriteFrameMotion(uint32 sprId, int32 frame, mdir dir) |
script.method.client.Game.GetSpriteFrameMotion |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1170 | Returns a checked frame's pixel motion delta; static images have zero displacement |
ipos Game.GetSpriteFrameOffset(uint32 sprId, int32 frame, mdir dir) |
script.method.client.Game.GetSpriteFrameOffset |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1159 | Returns a checked frame's absolute pixel draw offset; one-direction sources serve every direction |
isize Game.GetSpriteSize(uint32 sprId) |
script.method.client.Game.GetSpriteSize |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1228 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:798 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:784 | Returns a uniformly random text variant 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:791 | Returns a uniformly random 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:809 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1352 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1361 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:19 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:59 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:79 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:39 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:351 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2024 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:169 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:162 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:141 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:106 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1241 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:816 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:723 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1073 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1080 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1087 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1094 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1059 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1066 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:155 | Requests minimization of the client window |
ipos Game.MousePos() |
script.method.client.Game.MousePos |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Getter |
Source/Scripting/ClientGlobalScriptMethods.cpp:99 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:704 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1313 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:690 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:683 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1300 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:716 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1695 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:841 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1819 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1774 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1791 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1764 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1332 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1688 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2031 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:823 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:832 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1907 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1955 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/ClientGlobalScriptMethods.cpp:134 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:358 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1990 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1983 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2010 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:874 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:881 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:888 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2071 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2064 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:372 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1280 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:333 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2116 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:386 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1267 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2051 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:2038 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1011 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1002 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1018 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1025 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1037 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:945 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:919 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:908 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:932 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:967 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:974 | Injects a touch-move event with the supplied finger id, position, and movement offset |
void Game.SimulateTouchScroll(ipos pos, ipos offsetPos) |
script.method.client.Game.SimulateTouchScroll |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:995 | Injects a touch-scroll event at the supplied client position with the signed pixel offset |
void Game.SimulateTouchTap(ipos pos) |
script.method.client.Game.SimulateTouchTap |
Game |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:988 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:981 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:631 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:1254 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:148 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientGlobalScriptMethods.cpp:697 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientImGuiScriptMethods.cpp:112 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientImGuiScriptMethods.cpp:126 | 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.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ClientItemScriptMethods.cpp:39 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:201 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:180 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:164 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:86 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:26 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:97 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:144 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:13 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:155 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:108 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:192 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:135 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:126 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientItemScriptMethods.cpp:117 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:990 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1004 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:723 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:774 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:881 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1041 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:119 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:14 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:25 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:305 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:897 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:341 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:317 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:385 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:365 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:403 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:460 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:441 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:422 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:476 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:910 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:841 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:834 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1034 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:492 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:804 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:791 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:815 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1078 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:234 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:888 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:251 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:268 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:285 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:199 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:508 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:588 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:547 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:631 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:666 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1065 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:171 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:925 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:213 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:730 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:957 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:968 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:918 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:946 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:979 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:185 | Returns the map view's current scroll-check flag |
ident[] Map.LoadRuntimeStaticItems(hstring mapPid, mpos destHex, mpos sourceHex, msize sourceSize, int64 idOffset) |
script.method.client.Map.LoadRuntimeStaticItems#0971edd694992850 |
Map |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:143 | Load the static items of a prototype map area from its client bake as runtime static items so that the area's first hex lands at destHex, with baked ids plus idOffset, and return their ids |
ident[] Map.LoadRuntimeStaticItems(hstring mapPid, mpos destHex, int64 idOffset) |
script.method.client.Map.LoadRuntimeStaticItems#7af3f0c56f49e919 |
Map |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:136 | Load the static items of a prototype map's client bake as runtime static items so that its first hex lands at destHex, with baked ids plus idOffset, and return their ids |
bool Map.MoveHexByDir(mpos& hex, mdir dir) |
script.method.client.Map.MoveHexByDir#62392271e1b42030 |
Map |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:737 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:749 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:704 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:157 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:767 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1022 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:164 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:227 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:1058 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:206 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:178 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:192 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:848 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:855 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:220 | Replaces the set of layers visible in this map view |
void Map.UnloadRuntimeStaticItems(ident[] runtimeStaticItemIds) |
script.method.client.Map.UnloadRuntimeStaticItems |
Map |
client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ClientMapScriptMethods.cpp:150 | Remove runtime static items that LoadRuntimeStaticItems added to the map view and release the field blocks they leave empty |
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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:54 | 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:184 Development-only debugger trap; intentionally not an embedding-project compatibility contract |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:186 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:582 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:527 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:692 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:637 | Returns whether a map prototype with the supplied id is registered |
int32 Game.CountTimeEvent(callback(void) func, bool excludeExecuting = false) |
script.method.common.Game.CountTimeEvent#8ab623cddbdc14b4 |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:894 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Game.CountTimeEvent(callback(void,any[]) func, bool excludeExecuting = false) |
script.method.common.Game.CountTimeEvent#a4ca2eed35c3f8a4 |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:908 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Game.CountTimeEvent(callback(void,any) func, bool excludeExecuting = false) |
script.method.common.Game.CountTimeEvent#c565a82cf065f89e |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:901 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Game.CountTimeEvent(uint32 id, bool excludeExecuting = false) |
script.method.common.Game.CountTimeEvent#db3b98741c5df44b |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:922 | Counts matching registered time events; excludeExecuting omits executing callbacks |
int32 Game.CountTimeEvent(callback(void,TimeEventContext) func, bool excludeExecuting = false) |
script.method.common.Game.CountTimeEvent#fcb2bac4ef3be7f7 |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:915 | Counts matching registered time events; excludeExecuting omits executing callbacks |
string Game.CurrentLanguage() |
script.method.common.Game.CurrentLanguage |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:126 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:117 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:296 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:72 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:791 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:309 | 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.wipcontract source: Source/Scripting/CommonGlobalScriptMethods.cpp:151 Opt-in diagnostic snapshot; availability and allocator scope are not a whole-process memory contract |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:153 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:496 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:390 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:347 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:338 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:399 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:845 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:356 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:265 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:734 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:569 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:589 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:605 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:514 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:534 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:550 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:679 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:699 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:715 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:624 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:644 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:660 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:329 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:133 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:142 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:63 | Reports whether this binary targets iOS |
ImGui Game.ImGui() |
script.method.common.Game.ImGui |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonImGuiScriptMethods.cpp:84 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:101 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:231 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:36 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:195 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:213 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:204 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:45 | Reports whether this binary targets macOS |
int32 Game.MapDirCount() |
script.method.common.Game.MapDirCount |
Game |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:108 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:90 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:99 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:320 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:770 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:743 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:289 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:245 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:238 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:992 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:978 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:964 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:985 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:971 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:222 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:365 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:505 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:1013 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:1027 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:1034 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:1020 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:999 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:1006 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:803 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:866 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:887 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:824 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:838 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:859 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:873 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:852 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:880 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:817 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:810 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:831 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:936 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:950 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:943 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:929 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:957 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:81 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:408 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:451 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:777 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonGlobalScriptMethods.cpp:752 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:18 | 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.wipcontract source: Source/Common/Common.h:15 |
GlobalGetter |
Source/Scripting/CommonGlobalScriptMethods.cpp:27 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:285 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1194 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:111 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:122 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1092 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1081 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1850 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2281 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:636 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1407 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1880 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1540 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1568 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1554 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1446 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1479 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1497 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1488 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1468 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1457 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1738 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1756 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1767 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1597 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1421 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:467 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1914 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:569 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:608 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:277 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:650 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:661 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:672 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1513 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1110 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2110 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2034 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2053 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2072 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2091 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1861 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:754 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:776 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:795 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:815 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:765 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:836 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:855 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:875 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:615 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:133 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1103 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1873 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2288 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:643 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1891 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1547 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1579 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1561 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1506 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1749 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1778 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1611 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1428 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2295 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:499 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:506 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:513 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:520 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:527 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:299 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:320 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:327 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1307 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1300 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1314 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1377 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1321 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1328 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:411 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:418 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:383 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:390 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:306 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:313 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:292 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:485 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:376 | Returns the current window height |
fpos ImGui.GetWindowPos() |
script.method.common.ImGui.GetWindowPos |
ImGui |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:341 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:348 | Returns the current window's size |
float32 ImGui.GetWindowWidth() |
script.method.common.ImGui.GetWindowWidth |
ImGui |
server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:369 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:622 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2145 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2156 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2175 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2195 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:683 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:694 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:713 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:733 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2216 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2237 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2258 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1205 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:460 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1258 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:453 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1230 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1279 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1223 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1237 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1244 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1286 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1216 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1251 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1293 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1342 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1356 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1335 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1370 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1363 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1349 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1520 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:355 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:362 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:334 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1265 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1272 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2310 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2332 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1836 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1829 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1843 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1822 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1814 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1807 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1586 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1074 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1435 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1531 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1970 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1957 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:158 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:601 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:172 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:193 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:555 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1898 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1905 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:140 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:151 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:594 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:165 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:179 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:186 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:548 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1172 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1161 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1384 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:580 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2321 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2339 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1150 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1060 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:474 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2303 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2123 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:534 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:541 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1391 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1414 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:562 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:492 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:587 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:249 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:214 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:228 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:235 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:200 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:242 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:207 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:221 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:439 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:446 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:425 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:432 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:397 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:404 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1796 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1398 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:896 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:918 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:937 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:957 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:907 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:978 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:997 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1017 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1183 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1067 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1785 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1731 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1682 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1710 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1689 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1703 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1724 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1696 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1646 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1639 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1625 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1618 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1675 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1717 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1632 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1657 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1668 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:256 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1983 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:263 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1921 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1943 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1932 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:270 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1121 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1132 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1143 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:629 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1038 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1049 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:1990 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2001 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2012 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/CommonImGuiScriptMethods.cpp:2023 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:110 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:124 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:96 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:82 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:836 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:654 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:290 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:859 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:717 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:695 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:730 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:204 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:197 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:268 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:156 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:171 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:661 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:670 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:138 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:147 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:388 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:412 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:789 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:775 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:782 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:254 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:247 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:59 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:768 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:748 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:341 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:180 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:309 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:327 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:435 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:356 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:363 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:902 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:231 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:219 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:277 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:761 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:827 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:739 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:849 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:682 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:888 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:74 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:66 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:381 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:608 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:464 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:443 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:621 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:546 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:485 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:643 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/MapperGlobalScriptMethods.cpp:349 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:676 | Send and broadcast a critter action with an optional context item |
Item Critter.AddItem(ProtoItem proto) |
script.method.server.Critter.AddItem#6029176d1f44719d |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:444 | Create an inventory item from a prototype descriptor and attach it to a critter |
Item Critter.AddItem(hstring pid) |
script.method.server.Critter.AddItem#e8b1d5e540061d17 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:426 | Create an inventory item from a prototype id and attach it to a critter |
void Critter.AttachToCritter(Critter cr) |
script.method.server.Critter.AttachToCritter |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:893 | Attach this critter to a critter on the same map, detaching it from a previous master first |
void Critter.ChangeItemSlot(ident itemId, CritterItemSlot slot) |
script.method.server.Critter.ChangeItemSlot |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:560 | Move an inventory item to an enabled critter slot, swapping the occupant and firing item-moved events |
void Critter.ChangeMovingSpeed(int32 speed) |
script.method.server.Critter.ChangeMovingSpeed |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:882 | Change this critter's movement speed within the uint16_t range |
void Critter.DetachAllCritters() |
script.method.server.Critter.DetachAllCritters |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:945 | Detach all critters attached to this critter and refresh visibility |
void Critter.DetachFromCritter() |
script.method.server.Critter.DetachFromCritter |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:933 | Detach this critter from its master and refresh visibility |
void Critter.Disconnect() |
script.method.server.Critter.Disconnect |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:703 | Request graceful disconnection of the player controlling this critter |
Critter[] Critter.GetAttachedCritters() |
script.method.server.Critter.GetAttachedCritters |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:956 | Return critters attached to this critter |
Critter? Critter.GetCritter(ident id, CritterSeeType seeType) |
script.method.server.Critter.GetCritter |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:347 | Return a critter visible to this critter by id and visibility type |
Critter[] Critter.GetCritters(CritterSeeType seeType, CritterFindType findType) |
script.method.server.Critter.GetCritters |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:355 | Return critters visible to this critter, sorted by distance when it is on a map |
ident[] Critter.GetGlobalMapCritterIds(uint64& revision) |
script.method.server.Critter.GetGlobalMapCritterIds |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:79 | Return ids of this critter's global-map group and write its membership revision |
Item? Critter.GetItem(ItemProperty property, int32 propertyValue) |
script.method.server.Critter.GetItem#20907df3571a66a9 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:482 | Return the first inventory item whose integer property equals the value |
Item? Critter.GetItem(ident itemId) |
script.method.server.Critter.GetItem#3e4a8f273e418d3b |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:456 | Return an inventory item by id, or null when it is absent or the id is zero |
Item? Critter.GetItem(hstring protoId) |
script.method.server.Critter.GetItem#5042179ea08a430e |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:468 | Return the highest-priority inventory item with the given prototype id |
Item? Critter.GetItem(ProtoItem proto) |
script.method.server.Critter.GetItem#8eedde0030f87e84 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:475 | Return the highest-priority inventory item with the given prototype descriptor |
Item[] Critter.GetItems(ItemProperty property, int32 propertyValue) |
script.method.server.Critter.GetItems#83c145745774df22 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:505 | Return inventory items whose integer property equals the value |
Item[] Critter.GetItems(hstring protoId) |
script.method.server.Critter.GetItems#a6ae510092488b1e |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:524 | Return inventory items with the given prototype id |
Item[] Critter.GetItems() |
script.method.server.Critter.GetItems#b851260ade7c353c |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:497 | Return all inventory items of this critter |
Item[] Critter.GetItems(ProtoItem proto) |
script.method.server.Critter.GetItems#ef66ddcc26718dfe |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:542 | Return inventory items with the given prototype descriptor |
Map? Critter.GetMap() |
script.method.server.Critter.GetMap |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerCritterScriptMethods.cpp:70 | Return the parent map of this critter |
MovingContext? Critter.GetMovingContext() |
script.method.server.Critter.GetMovingContext |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:47 | Return the current movement context or the last retained context when movement has stopped |
MovingState Critter.GetMovingState() |
script.method.server.Critter.GetMovingState |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:868 | Return the current movement state of this critter |
uint32 Critter.GetMovingUid() |
script.method.server.Critter.GetMovingUid |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:55 | Return the current movement uid of this critter |
Player? Critter.GetPlayer() |
script.method.server.Critter.GetPlayer |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:62 | Return the player controlling this critter when one is attached |
timespan Critter.GetPlayerOfflineTime() |
script.method.server.Critter.GetPlayerOfflineTime |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:964 | Return the offline duration of this critter's player link |
CritterVisibilityMode Critter.GetVisibilityMode(Critter cr) |
script.method.server.Critter.GetVisibilityMode |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:404 | Return this critter's visibility mode for the critter, full for itself |
bool Critter.IsAlive() |
script.method.server.Critter.IsAlive |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:305 | Return whether this critter is alive |
bool Critter.IsDead() |
script.method.server.Critter.IsDead |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:319 | Return whether this critter is dead |
bool Critter.IsKnockout() |
script.method.server.Critter.IsKnockout |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:312 | Return whether this critter is knocked out |
bool Critter.IsMoving() |
script.method.server.Critter.IsMoving |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:40 | Return whether this critter is currently moving |
bool Critter.IsOnline() |
script.method.server.Critter.IsOnline |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:749 | Return whether this player-controlled critter has a live player |
bool Critter.IsSee(Critter cr) |
script.method.server.Critter.IsSee#11f3357f2df75c38 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:378 | Return whether this critter sees the critter, true for itself |
bool Critter.IsSee(Item item) |
script.method.server.Critter.IsSee#c05ec9ee4a1d9b41 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:417 | Return whether this critter's visible-item cache contains the item |
bool Critter.IsSeenBy(Critter cr) |
script.method.server.Critter.IsSeenBy |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:391 | Return whether the critter sees this critter, true for itself |
void Critter.MakeControllable(bool controllable) |
script.method.server.Critter.MakeControllable |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:716 | Mark or unmark this critter as player-controllable, detaching its player when disabling |
bool Critter.MapTransfersLocked() |
script.method.server.Critter.MapTransfersLocked |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Getter |
Source/Scripting/ServerCritterScriptMethods.cpp:109 | Return whether transfers between maps are currently locked for this critter |
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.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerCritterScriptMethods.cpp:840 | Start path movement to a hex and return 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.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerCritterScriptMethods.cpp:849 | Start path movement with an end hex offset and return 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.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerCritterScriptMethods.cpp:859 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:326 | Recompute this critter's visible critters and items |
void Critter.RefreshVisibility() |
script.method.server.Critter.RefreshVisibility |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:971 | Recompute this critter's visible critters and items |
void Critter.SendGlobalMapGroupInfo() |
script.method.server.Critter.SendGlobalMapGroupInfo |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:86 | Send the other members of this critter's global-map group to its player after validating every member |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:685 | Send the listed non-null items to this critter's player with ownership and inner-entity flags |
void Critter.SetCondition(CritterCondition cond, CritterActionAnim actionAnim, AbstractItem? contextItem) |
script.method.server.Critter.SetCondition |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:630 | Change this critter's condition, update its map field and broadcast the matching action |
void Critter.SetDir(mdir dir) |
script.method.server.Critter.SetDir |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:334 | Change this critter's direction and broadcast it when the direction differs |
void Critter.SetupScript(callback(void,Critter,bool) initFunc) |
script.method.server.Critter.SetupScript |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:14 | Run the init callback and store its name as the init script |
void Critter.SetupScriptEx(hstring initFunc) |
script.method.server.Critter.SetupScriptEx |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:29 | Run the named init script and store its name |
void Critter.StopMoving() |
script.method.server.Critter.StopMoving |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:875 | Stop this critter's current movement |
void Critter.TransferToGlobal() |
script.method.server.Critter.TransferToGlobal |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:210 | Move this critter from its current map to the global map |
void Critter.TransferToGlobalGroup(Critter globalCr) |
script.method.server.Critter.TransferToGlobalGroup |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:252 | Join this critter to a global-map critter's group, transferring it off the map when mapped |
void Critter.TransferToGlobalWithGroup(Critter[] group) |
script.method.server.Critter.TransferToGlobalWithGroup |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:227 | Move this critter to the global map, then move each live non-null group member |
void Critter.TransferToHex(mpos hex, mdir dir) |
script.method.server.Critter.TransferToHex#8438d509ef6a8651 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:138 | Move this critter to a valid hex on its current map, updating direction and broadcasting a direction-only change |
void Critter.TransferToHex(mpos hex) |
script.method.server.Critter.TransferToHex#a9a09ef8641e16c0 |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:116 | Move this critter to a valid hex on its current map, keeping its current direction |
void Critter.TransferToMap(Map map, mpos hex) |
script.method.server.Critter.TransferToMap#c9880f573836f54f |
Critter |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:169 | Transfer this critter to a valid hex on another map, keeping its direction |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerCritterScriptMethods.cpp:187 | Transfer this critter with the given direction, using exact placement or a search within radius two |
Entity (server)
| Signature | Symbol ID | Applies to | Runtime | Contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|
int32 Entity.CountTimeEvent(callback(void,Entity,any[]) func, bool excludeExecuting = false) |
script.method.server.Entity.CountTimeEvent#3032339c32e34b9d |
Player, Location, Map, Critter, Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:133 | Count registered time events for this entity and callback, optionally excluding executing callbacks |
int32 Entity.CountTimeEvent(callback(void,Entity,TimeEventContext) func, bool excludeExecuting = false) |
script.method.server.Entity.CountTimeEvent#417e7527b8152349 |
Player, Location, Map, Critter, Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:140 | Count registered time events for this entity and callback, optionally excluding executing callbacks |
int32 Entity.CountTimeEvent(callback(void,Entity,any) func, bool excludeExecuting = false) |
script.method.server.Entity.CountTimeEvent#45d21a68801eb4f0 |
Player, Location, Map, Critter, Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:126 | Count registered time events for this entity and callback, optionally excluding executing callbacks |
int32 Entity.CountTimeEvent(callback(void,Entity) func, bool excludeExecuting = false) |
script.method.server.Entity.CountTimeEvent#7ed3553b71048a0d |
Player, Location, Map, Critter, Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:119 | Count registered time events for this entity and callback, optionally excluding executing callbacks |
int32 Entity.CountTimeEvent(uint32 id, bool excludeExecuting = false) |
script.method.server.Entity.CountTimeEvent#db3b98741c5df44b |
Player, Location, Map, Critter, Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:147 | Count registered time events with the given event id, optionally excluding executing callbacks |
int32 Entity.GetRefCount() |
script.method.server.Entity.GetRefCount |
Game, Player, Location, Map, Critter, Item, ImGui |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerEntityScriptMethods.cpp:28 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerEntityScriptMethods.cpp:13 | Return whether this server entity is marked persistent |
void Entity.MakePersistent(bool persistent) |
script.method.server.Entity.MakePersistent |
Game, Player, Location, Map, Critter, Item, ImGui |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerEntityScriptMethods.cpp:20 | Apply the persistent flag and cascade it to 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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:217 | Update the repeat interval for the time event with the given id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:196 | Update the repeat interval for time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:203 | Update the repeat interval for time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:210 | Update the repeat interval for time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:189 | Update the repeat interval for time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:224 | Replace the data payload of time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:231 | Replace the data payload of time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:252 | Replace the data payload of the time event with the given id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:259 | Replace the data payload of the time event with the given id using a data list |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:245 | Replace the data payload of time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:238 | Replace the data payload of time events bound to this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:105 | Register a repeating time event with a context and one data argument and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:56 | Register a one-shot time event with a context argument and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:70 | Register a one-shot time event with a context and a data list and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:77 | Register a repeating time event and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:112 | Register a repeating time event with a context and a data list and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:91 | Register a repeating time event with a data list and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:84 | Register a repeating time event with one data argument and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:42 | Register a one-shot time event with one data argument and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:98 | Register a repeating time event with a context argument and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:49 | Register a one-shot time event with a data list and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:63 | Register a one-shot time event with a context and one data argument and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:35 | Register a one-shot time event and return its id |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:161 | Stop time events registered for this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:175 | Stop time events registered for this entity and callback |
void Entity.StopTimeEvent(uint32 id) |
script.method.server.Entity.StopTimeEvent#be90949683fff93d |
Player, Location, Map, Critter, Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:182 | Stop the time event with the given id for this entity |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:154 | Stop time events registered for this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
TimeEventRelated |
Source/Scripting/ServerEntityScriptMethods.cpp:168 | Stop time events registered for this entity and callback |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1529 | Call a static item script function for a critter and optional used item |
Item Game.CloneItem(Item item) |
script.method.server.Game.CloneItem |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:332 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:46 | Create a detached critter with property overrides |
Critter Game.CreateCritter(ProtoCritter proto, bool forPlayer) |
script.method.server.Game.CreateCritter#e68fa5ea3ffe3cc4 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:38 | Create a detached critter from a prototype descriptor |
Critter Game.CreateCritter(hstring protoId, bool forPlayer) |
script.method.server.Game.CreateCritter#e774d859a418b9da |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:30 | Create a detached critter from a prototype id |
Critter Game.CreateCritter(ProtoCritter proto, bool forPlayer, CritterProperty=>any props) |
script.method.server.Game.CreateCritter#e8d3f028fa79075f |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:67 | Create a detached critter from a prototype descriptor with property overrides |
Item Game.CreateItem(hstring protoId, ItemProperty=>int32 props) |
script.method.server.Game.CreateItem#27766bb940021b1f |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:293 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:286 | Creates an item from the supplied prototype descriptor and returns it with synchronization cover |
Item Game.CreateItem(hstring protoId, ItemProperty=>any props) |
script.method.server.Game.CreateItem#95d49151f6d1acf8 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:313 | Creates an item with mutable property overrides applied before OnItemInit 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:275 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:612 | Create a location with child map ids and property overrides |
Location Game.CreateLocation(ProtoLocation proto, LocationProperty=>any props) |
script.method.server.Game.CreateLocation#09335f3291c54d05 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:597 | Create a location from a prototype descriptor with property overrides |
Location Game.CreateLocation(ProtoLocation proto) |
script.method.server.Game.CreateLocation#392f59fecd72fe17 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:560 | Create a location from a prototype descriptor |
Location Game.CreateLocation(hstring protoId) |
script.method.server.Game.CreateLocation#4f3d2969824dd3bc |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:552 | Create a location from a prototype id |
Location Game.CreateLocation(hstring protoId, hstring[] map_pids) |
script.method.server.Game.CreateLocation#5a0f0539462eafe3 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:568 | Create a location with child maps from prototype ids |
Location Game.CreateLocation(hstring protoId, LocationProperty=>any props) |
script.method.server.Game.CreateLocation#c94de2fea30a1454 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:576 | Create a location with property overrides |
Player Game.CreateNotLoggedInPlayer() |
script.method.server.Game.CreateNotLoggedInPlayer |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:698 | Create a not-logged-in player session with a dummy connection |
bool Game.DbCompareExchangeRecordString(hstring collectionName, ident id, string key, string expected, string desired) |
script.method.server.Game.DbCompareExchangeRecordString#28dbc09a155eeea9 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1223 | Compare and exchange one string field of a database record with an integer id |
bool Game.DbCompareExchangeRecordString(hstring collectionName, string id, string key, string expected, string desired) |
script.method.server.Game.DbCompareExchangeRecordString#d7c0eb9e97e0795d |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1243 | Compare and exchange one string field of a database record with a string key |
ident[] Game.DbGetAllRecordIds(hstring collectionName) |
script.method.server.Game.DbGetAllRecordIds |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1038 | Return all integer record ids in a database collection |
string[] Game.DbGetAllRecordKeys(hstring collectionName) |
script.method.server.Game.DbGetAllRecordKeys |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1049 | Return all string record keys in a database collection |
string=>string Game.DbGetPlayerData(ident playerId) |
script.method.server.Game.DbGetPlayerData |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1069 | Return a player database record as string key-value pairs |
string=>string Game.DbGetRecord(hstring collectionName, string id) |
script.method.server.Game.DbGetRecord#86e082d9df76b104 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1136 | Return a database record by string key as string key-value pairs |
string=>string Game.DbGetRecord(hstring collectionName, ident id) |
script.method.server.Game.DbGetRecord#c524f7821136061a |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1115 | Return a database record by integer id as string key-value pairs |
bool Game.DbHasEntity(Entity entity) |
script.method.server.Game.DbHasEntity |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1060 | Return whether a entity has a database record |
bool Game.DbHasRecord(hstring collectionName, string id) |
script.method.server.Game.DbHasRecord#31a3ffa964f519b8 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1101 | Return whether a database collection contains the string record key |
bool Game.DbHasRecord(hstring collectionName, ident id) |
script.method.server.Game.DbHasRecord#e13466af940b3833 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1087 | Return whether a database collection contains the integer record id |
void Game.DbInsertRecord(hstring collectionName, ident id, string=>string keyValues) |
script.method.server.Game.DbInsertRecord#23ac03d711edaa50 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1263 | Insert a database record with an integer id, rejecting an existing record |
void Game.DbInsertRecord(hstring collectionName, string id, string=>string keyValues) |
script.method.server.Game.DbInsertRecord#27a079e12448f9d8 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1300 | Insert a database record with a string key, rejecting an existing record |
void Game.DbRemoveRecord(hstring collectionName, ident id) |
script.method.server.Game.DbRemoveRecord#2039b29db1a1d593 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1443 | Remove a database record with an integer id when it exists |
void Game.DbRemoveRecord(hstring collectionName, string id) |
script.method.server.Game.DbRemoveRecord#2749ed5b0c8482ba |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1459 | Remove a database record with a string key when it exists |
bool Game.DbTryInsertRecord(hstring collectionName, string id, string=>string keyValues) |
script.method.server.Game.DbTryInsertRecord#148cb7fe9d0c7284 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1190 | Try to insert a database record with a string key |
bool Game.DbTryInsertRecord(hstring collectionName, ident id, string=>string keyValues) |
script.method.server.Game.DbTryInsertRecord#5d786aff58d93d01 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1157 | Try to insert a database record with an integer id |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1429 | Update one bool field of an existing database record with an integer id |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1436 | Update one bool field of an existing database record with a string key |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1415 | Update one float64 field of an existing database record with an integer id |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1422 | Update one float64 field of an existing database record with a string key |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1408 | Update one int64 field of an existing database record with a string key |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1401 | Update one int64 field of an existing database record with an integer id |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1387 | Update one string field of an existing database record with an integer id |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1394 | Update one string field of an existing database record with a string key |
void Game.DestroyCritter(Critter? cr) |
script.method.server.Game.DestroyCritter |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:520 | Destroy a non-player critter subtree |
void Game.DestroyCritters(Critter[] critters) |
script.method.server.Game.DestroyCritters |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:535 | Destroy each non-null non-player critter subtree |
void Game.DestroyEntities(Entity[] entities) |
script.method.server.Game.DestroyEntities |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:480 | Destroy each non-null entity subtree |
void Game.DestroyEntity(Entity? entity) |
script.method.server.Game.DestroyEntity |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:468 | Destroy the entity subtree when the entity is non-null |
void Game.DestroyItem(Item? item) |
script.method.server.Game.DestroyItem |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:494 | Destroy the item subtree when the item is non-null |
void Game.DestroyItems(Item[] items) |
script.method.server.Game.DestroyItems |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:506 | Destroy each non-null item subtree |
void Game.DestroyLocation(Location? loc) |
script.method.server.Game.DestroyLocation |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:633 | Destroy a location subtree when the location is non-null |
void Game.DestroyMap(Map? map) |
script.method.server.Game.DestroyMap |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:645 | Destroy a map subtree when the map is non-null |
void Game.DestroyUnloadedCritter(ident crId) |
script.method.server.Game.DestroyUnloadedCritter |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:110 | Delete an unloaded critter record by id |
Item[] Game.GetAllItems(ProtoItem? proto) |
script.method.server.Game.GetAllItems#5f63b29e3fbd4374 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:989 | Return registered items matching the optional prototype descriptor |
Item[] Game.GetAllItems(hstring pid) |
script.method.server.Game.GetAllItems#986ac88634199639 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:969 | Return registered items matching the optional prototype id |
Critter[] Game.GetAllNpc(hstring pid) |
script.method.server.Game.GetAllNpc#568d2e4962ad093b |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1483 | Return non-player critters matching the optional prototype id |
Critter[] Game.GetAllNpc(ProtoCritter proto) |
script.method.server.Game.GetAllNpc#d318af6f5c78cd43 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1502 | Return non-player critters matching the given prototype descriptor |
Critter[] Game.GetAllNpc() |
script.method.server.Game.GetAllNpc#e7c595cfaf4c11a4 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1475 | Return all non-player critters |
int64 Game.GetAllocatorMemoryUsage() |
script.method.server.Game.GetAllocatorMemoryUsage |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1895 | Return the allocator's in-use memory in bytes |
Critter? Game.GetCritter(ident crId) |
script.method.server.Game.GetCritter |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:657 | Return a live critter by id, or null when the id is zero or the entity is missing or being destroyed |
int32 Game.GetCritterRegistryCount() |
script.method.server.Game.GetCritterRegistryCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1932 | Return the number of critters in the registry |
Critter[] Game.GetCritters(CritterFindType findType) |
script.method.server.Game.GetCritters |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:681 | Return registered critters matching the find type |
int32 Game.GetDistance(Item item1, Item item2) |
script.method.server.Game.GetDistance#1be05ad1508d9bdf |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:138 | Return the distance between two items on the same map |
int32 Game.GetDistance(Item item, Critter cr) |
script.method.server.Game.GetDistance#200d823fdf545d92 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:178 | Return the surface distance between a item and critter on the same map |
int32 Game.GetDistance(mpos hex, Critter cr) |
script.method.server.Game.GetDistance#33a4d51ef8eece2a |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:216 | Return the surface distance from a hex to a critter on a map |
int32 Game.GetDistance(Critter cr, Item item) |
script.method.server.Game.GetDistance#3dade8869ec8c0ac |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:157 | Return the surface distance between a critter and item on the same map |
int32 Game.GetDistance(Item item, mpos hex) |
script.method.server.Game.GetDistance#8298d537bb9c7c37 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:233 | Return the distance from a item on a map to a hex |
int32 Game.GetDistance(Critter cr, mpos hex) |
script.method.server.Game.GetDistance#8a80a760debf852d |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:199 | Return the surface distance from a critter on a map to a hex |
int32 Game.GetDistance(mpos hex, Item item) |
script.method.server.Game.GetDistance#b273c01749f73e8c |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:248 | Return the distance from a hex to a item on a map |
int32 Game.GetDistance(Critter cr1, Critter cr2) |
script.method.server.Game.GetDistance#dacea0c00ba4c5f1 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:117 | Return the surface distance between two critters on the same map |
Entity? Game.GetEntity(ident entityId) |
script.method.server.Game.GetEntity |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:669 | Return a live entity by id, or null when the id is zero or the entity is missing or being destroyed |
int32 Game.GetEntityRegistryCount() |
script.method.server.Game.GetEntityRegistryCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1904 | Return the number of entities in the registry |
Entity[] Game.GetHeldSyncEntities() |
script.method.server.Game.GetHeldSyncEntities |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1852 | Return the entities currently held in the synchronization cover |
Item? Game.GetItem(ident itemId) |
script.method.server.Game.GetItem |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:263 | Return a live item by id after rejecting a zero id, or null when it is missing or destroying |
int32 Game.GetItemRegistryCount() |
script.method.server.Game.GetItemRegistryCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1939 | Return the number of items in the registry |
hstring[] Game.GetItemRegistryProtoIds() |
script.method.server.Game.GetItemRegistryProtoIds |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1946 | Return the prototype ids of all registered items |
Location? Game.GetLocation(ident locId) |
script.method.server.Game.GetLocation#08a98bf7bce0a9bf |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:848 | Return a live location by id, or null for a missing or destroying location |
Location? Game.GetLocation(ProtoLocation locProto, int32 skipCount = 0) |
script.method.server.Game.GetLocation#2f5eccddea2f5dd1 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:864 | Return a live location by prototype descriptor and occurrence index, or null |
Location? Game.GetLocation(hstring locPid, int32 skipCount = 0) |
script.method.server.Game.GetLocation#4b1903ede1dd2fa2 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:856 | Return a live location by prototype id and occurrence index, or null |
Location? Game.GetLocation(LocationProperty property, int32 propertyValue) |
script.method.server.Game.GetLocation#8d03e18599ee2a1e |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:873 | Return the first live location whose integer property equals the value |
int32 Game.GetLocationRegistryCount() |
script.method.server.Game.GetLocationRegistryCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1918 | Return the number of locations in the registry |
Location[] Game.GetLocations() |
script.method.server.Game.GetLocations#53d313c4ee2358d8 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:889 | Return all registered locations |
Location[] Game.GetLocations(ProtoLocation? proto) |
script.method.server.Game.GetLocations#7e3ec9d90972cfaf |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:924 | Return registered locations matching the optional prototype descriptor |
Location[] Game.GetLocations(hstring pid) |
script.method.server.Game.GetLocations#8eb7a49e747de27a |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:904 | Return registered locations matching the optional prototype id |
Location[] Game.GetLocations(LocationProperty property, int32 propertyValue) |
script.method.server.Game.GetLocations#c590f9bbe1535ddd |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:951 | Return registered locations whose integer property equals the value |
Map? Game.GetMap(hstring mapPid, int32 skipCount = 0) |
script.method.server.Game.GetMap#28a9744f2e2f208e |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:772 | Return a live map by prototype id and occurrence index, or null |
Map? Game.GetMap(ident mapId) |
script.method.server.Game.GetMap#38ce2f11f2b9397e |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:764 | Return a live map by id, or null for a missing or destroying map |
Map? Game.GetMap(ProtoMap mapProto, int32 skipCount = 0) |
script.method.server.Game.GetMap#b7b3d34523400d1f |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:780 | Return a live map by prototype descriptor and occurrence index, or null |
int32 Game.GetMapRegistryCount() |
script.method.server.Game.GetMapRegistryCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1925 | Return the number of maps in the registry |
Map[] Game.GetMaps(hstring pid) |
script.method.server.Game.GetMaps#12174f7cc9f609d1 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:797 | Return registered maps matching the optional prototype id |
Map[] Game.GetMaps() |
script.method.server.Game.GetMaps#3cd2c62b701248d5 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:789 | Return all registered maps |
Map[] Game.GetMaps(ProtoMap? proto) |
script.method.server.Game.GetMaps#779d5c9f8b1fd466 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:819 | Return registered maps matching the optional prototype descriptor |
Player[] Game.GetOnlinePlayers() |
script.method.server.Game.GetOnlinePlayers |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:1016 | Return all online players |
Player? Game.GetPlayer(ident playerId) |
script.method.server.Game.GetPlayer |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerGlobalScriptMethods.cpp:752 | Return a live player by id, or null when the id is zero or the entity is missing or being destroyed |
int32 Game.GetPlayerRegistryCount() |
script.method.server.Game.GetPlayerRegistryCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1911 | Return the number of players in the registry |
int64 Game.GetProcessMemoryUsage() |
script.method.server.Game.GetProcessMemoryUsage |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1886 | Return the process memory usage in bytes |
ProtoCritter[] Game.GetProtoCrittersForProtoMap(ProtoMap proto) |
script.method.server.Game.GetProtoCrittersForProtoMap |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1615 | Return the critter prototypes placed in a prototype map |
ident[] Game.GetRegisteredPlayerIds() |
script.method.server.Game.GetRegisteredPlayerIds |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1031 | Return all player record ids from the database |
StaticItem[] Game.GetStaticItemsForProtoMap(ProtoMap proto) |
script.method.server.Game.GetStaticItemsForProtoMap |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1606 | Return the static items of a prototype map |
int32 Game.GetTextCount(TextPackKey textKey) |
script.method.server.Game.GetTextCount |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1640 | Return the number of language-pack texts for the key |
bool Game.IsEntityLocked(Entity? entity) |
script.method.server.Game.IsEntityLocked |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1861 | Return whether the entity is covered without emitting diagnostics |
bool Game.IsStaticMapLoaded(hstring mapPid) |
script.method.server.Game.IsStaticMapLoaded |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1580 | Return whether the baked content of a prototype map is cached |
bool Game.IsTextPresent(TextPackKey textKey) |
script.method.server.Game.IsTextPresent |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1633 | Return whether the language pack contains the text key |
Critter Game.LoadCritter(ident crId, bool forPlayer) |
script.method.server.Game.LoadCritter#e4b9bdc5bdeb7919 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:82 | Load a stored critter |
Critter Game.LoadCritter(ident crId, bool forPlayer, Map map) |
script.method.server.Game.LoadCritter#f50433829d33781c |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:90 | Load a stored critter onto a map |
void Game.LoadStaticMap(hstring mapPid, bool asyncLoad) |
script.method.server.Game.LoadStaticMap |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1547 | Read the baked content of a prototype map into the cache, now or on a worker thread; a request before that read ends waits for it |
void Game.LoadStaticMaps(hstring[] mapPids, bool asyncLoad) |
script.method.server.Game.LoadStaticMaps |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1560 | Read the baked content of prototype maps into the cache, now or on worker threads; a request for one of them waits for its read |
void Game.Lock() |
script.method.server.Game.Lock |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1870 | Lock the Game singleton bucket |
Player Game.LoginPlayerToExistentRecord(Player notLoggedInPlayer, ident playerId) |
script.method.server.Game.LoginPlayerToExistentRecord |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:735 | Log a non-logged-in player into an existing record and return the resulting player |
Player Game.LoginPlayerToNewRecord(Player notLoggedInPlayer) |
script.method.server.Game.LoginPlayerToNewRecord |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:707 | Log a non-logged-in player into a new record and return the resulting player |
Player Game.LoginPlayerToTempSession(Player notLoggedInPlayer) |
script.method.server.Game.LoginPlayerToTempSession |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:721 | Log a non-logged-in player into a temporary session and return the resulting player |
Item? Game.MoveItem(Item item, Item toCont, any stackId = any()) |
script.method.server.Game.MoveItem#2ed0d82a6f587a26 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:372 | Move the item into a container with an optional stack id and return it |
Item? Game.MoveItem(Item item, Map toMap, mpos toHex) |
script.method.server.Game.MoveItem#883528ad0763e772 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:356 | Move the item to a valid hex on a map and return it |
Item? Game.MoveItem(Item item, Critter toCr) |
script.method.server.Game.MoveItem#c26f82c316789816 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:345 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:383 | Move each non-null live item to a critter |
void Game.MoveItems(Item[] items, Item toCont, any stackId = any()) |
script.method.server.Game.MoveItems#8a09125d1c5aeacb |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:441 | Move each non-null live item into a container with an optional stack id |
void Game.MoveItems(Item[] items, Map toMap, mpos toHex) |
script.method.server.Game.MoveItems#efe80393199559d9 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:410 | Move each non-null live item to a valid hex on a map |
void Game.SetSynchronizedTime(synctime time) |
script.method.server.Game.SetSynchronizedTime |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1521 | Set the global synchronized game time |
void Game.Sync(Entity entity) |
script.method.server.Game.Sync#3a28adb1be02af8c |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Async |
Source/Scripting/ServerGlobalScriptMethods.cpp:1733 | Replace the current cover with one live entity and its 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.wipcontract source: Source/Common/Common.h:15 |
Async, AllowDestroyedEntityArgs |
Source/Scripting/ServerGlobalScriptMethods.cpp:1765 | Replace the current cover with three live entities and their auto-widen partners |
void Game.Sync(Entity[] entities) |
script.method.server.Game.Sync#a0c5737d3ba111b8 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Async, AllowDestroyedEntityArgs |
Source/Scripting/ServerGlobalScriptMethods.cpp:1787 | Replace the current cover with all non-null live entities and their auto-widen partners |
void Game.Sync(Entity entity1, Entity entity2) |
script.method.server.Game.Sync#b42b6f6d6b684d2a |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Async, AllowDestroyedEntityArgs |
Source/Scripting/ServerGlobalScriptMethods.cpp:1747 | Replace the current cover with two live entities and their auto-widen partners |
void Game.SyncRelease() |
script.method.server.Game.SyncRelease |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1836 | Release the held entity cover and Game singleton locks |
void Game.SyncWiden(Entity[] entities) |
script.method.server.Game.SyncWiden |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Async, AllowDestroyedEntityArgs |
Source/Scripting/ServerGlobalScriptMethods.cpp:1812 | 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.wipcontract source: Source/Common/Common.h:15 |
Async |
Source/Scripting/ServerGlobalScriptMethods.cpp:1844 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1699 | Run an external command, capture its output lines and return the exit code |
int32 Game.SystemCall(string command) |
script.method.server.Game.SystemCall#bc91017a887fc615 |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1689 | Run an external command, log its output and return the exit code |
bool Game.TrySyncEntity(ident entity_id) |
script.method.server.Game.TrySyncEntity |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
Async |
Source/Scripting/ServerGlobalScriptMethods.cpp:1716 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:100 | Unload a critter from simulation |
bool Game.UnloadStaticMap(hstring mapPid) |
script.method.server.Game.UnloadStaticMap |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1593 | Free the cached baked content of a prototype map and return whether it is unloaded; it stays while being read or used by a map |
void Game.Unlock() |
script.method.server.Game.Unlock |
Game |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerGlobalScriptMethods.cpp:1878 | Unlock the Game singleton bucket while keeping entity cover |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerItemScriptMethods.cpp:58 | Create an item from a prototype descriptor and add it to a container |
Item Item.AddItem(hstring pid, any stackId = any()) |
script.method.server.Item.AddItem#c6fbcb98959420b1 |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerItemScriptMethods.cpp:43 | Create an item from a prototype id and add it to a container |
Critter? Item.GetCritter() |
script.method.server.Item.GetCritter |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerItemScriptMethods.cpp:97 | Resolve the critter holding this item through container ownership, or null when map-owned |
Item[] Item.GetItems(any stackId = any()) |
script.method.server.Item.GetItems |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerItemScriptMethods.cpp:70 | Return inner items of this container, optionally limited to a stack id |
Map? Item.GetMap() |
script.method.server.Item.GetMap |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerItemScriptMethods.cpp:79 | Resolve the map containing this item through its critter or container ownership chain |
Map? Item.GetMapPosition(mpos& hex) |
script.method.server.Item.GetMapPosition |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
PassOwnership |
Source/Scripting/ServerItemScriptMethods.cpp:88 | Resolve the containing map and write the item's map hex through the output argument |
void Item.RefreshVisibility() |
script.method.server.Item.RefreshVisibility |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerItemScriptMethods.cpp:106 | Refresh map visibility and blocking caches for an item owned by a map hex |
void Item.SetupScript(callback(void,Item,bool) initFunc) |
script.method.server.Item.SetupScript |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerItemScriptMethods.cpp:17 | Run the init callback and store its name as the init script |
void Item.SetupScriptEx(hstring initFunc) |
script.method.server.Item.SetupScriptEx |
Item |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerItemScriptMethods.cpp:32 | Run the named init script and store its name |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:50 | Create a child map from a prototype descriptor and attach it to a location |
Map Location.AddMap(hstring mapPid) |
script.method.server.Location.AddMap#f4dae4b3925387ad |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:38 | Create a child map from a prototype id and attach it to a location |
Map? Location.GetMap(ProtoMap mapProto) |
script.method.server.Location.GetMap#102f60993beb7009 |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:86 | Return the first child map with the given prototype descriptor, or null |
Map? Location.GetMap(hstring mapPid) |
script.method.server.Location.GetMap#c71a7456cd1c7874 |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:71 | Return the first child map with the given prototype id, or null |
Map Location.GetMapByIndex(int32 index) |
script.method.server.Location.GetMapByIndex |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:102 | Return the child map at the given index, or throw when it is missing |
int32 Location.GetMapCount() |
script.method.server.Location.GetMapCount |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:64 | Return the number of child maps attached to this location |
Map[] Location.GetMaps() |
script.method.server.Location.GetMaps |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:111 | Return all child maps attached to this location |
void Location.Regenerate() |
script.method.server.Location.Regenerate |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:120 | Regenerate every child map of a location that is not being destroyed |
void Location.SetupScript(callback(void,Location,bool) initFunc) |
script.method.server.Location.SetupScript |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:12 | Run the init callback and store its name as the init script |
void Location.SetupScriptEx(hstring initFunc) |
script.method.server.Location.SetupScriptEx |
Location |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerLocationScriptMethods.cpp:27 | Run the named init script and store its name |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1201 | Create a critter from a prototype descriptor with property overrides on a valid map hex and direction |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1153 | Create a critter from a prototype descriptor with integer property overrides on a valid map hex |
Critter Map.AddCritter(hstring protoId, mpos hex, mdir dir) |
script.method.server.Map.AddCritter#469abe60680fae4e |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1096 | Create a critter from a prototype id on a valid map hex and direction |
Critter Map.AddCritter(ProtoCritter proto, mpos hex, mdir dir) |
script.method.server.Map.AddCritter#4bf2d1bf57efc238 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1111 | Create a critter from a prototype descriptor on a valid map hex and direction |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1126 | Create a critter with integer property overrides on a valid map hex and direction |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1174 | Create a critter with property overrides on a valid map hex and direction |
Item Map.AddItem(mpos hex, hstring protoId, ItemProperty=>int32 props) |
script.method.server.Map.AddItem#3b5f3b7a0ad0569d |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:76 | Create a map item with integer property overrides on a valid hex |
Item Map.AddItem(mpos hex, ProtoItem proto) |
script.method.server.Map.AddItem#4c836c86ebb331f9 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:61 | Create a map item from a prototype descriptor on a valid hex |
Item Map.AddItem(mpos hex, hstring protoId) |
script.method.server.Map.AddItem#93da72a5ec69c371 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:46 | Create a map item from a prototype id on a valid hex |
Item Map.AddItem(mpos hex, ProtoItem proto, ItemProperty=>int32 props) |
script.method.server.Map.AddItem#dd69e509a0195144 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:103 | Create a map item from a prototype descriptor with integer property overrides on a valid hex |
void Map.BlockHex(mpos hex, bool full) |
script.method.server.Map.BlockHex |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1296 | Set manual blocking for a valid map hex with optional full blocking |
bool Map.CheckPlaceForItem(mpos hex, hstring pid) |
script.method.server.Map.CheckPlaceForItem#7df5c41f5f61890c |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1276 | Check whether an item of this prototype can be placed on the hex |
bool Map.CheckPlaceForItem(mpos hex, ProtoItem proto) |
script.method.server.Map.CheckPlaceForItem#f95a6f1b9e4a1b61 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1289 | Check whether an item of this prototype can be placed on the hex |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1040 | Find a path for a critter to any target and write its length and chosen target |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1006 | Find a path from a valid hex to any target and write its length and chosen target |
mpos[] Map.FindReachableHexes(mpos fromHex, mpos[] targetHexes, callback(bool,Item) gagCallback) |
script.method.server.Map.FindReachableHexes |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1073 | Answers which target hexes are reachable from the start within the configured path-length limit |
ident[] Map.GenerateContent(hstring mapPid, mpos destHex) |
script.method.server.Map.GenerateContent |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:508 | Create the critters and dynamic items of a prototype map so that its first hex lands at destHex and return the created critter and map item ids |
Critter? Map.GetCritter(ident crid) |
script.method.server.Map.GetCritter#beaf90ce99481bb9 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:691 | Return a map critter by id |
Critter? Map.GetCritter(CritterProperty property, int32 propertyValue, CritterFindType findType) |
script.method.server.Map.GetCritter#cc2efc7ac9caf8b7 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:716 | Return the first critter matching an integer property and find type |
Critter? Map.GetCritterOnHex(mpos hex) |
script.method.server.Map.GetCritterOnHex |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:699 | Return a living critter on a valid hex, or a dead one when no living critter is present |
Critter[] Map.GetCritters(CritterFindType findType) |
script.method.server.Map.GetCritters#81d4328569cd9426 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:787 | Return map critters matching the find type |
Critter[] Map.GetCritters(hstring pid, CritterFindType findType) |
script.method.server.Map.GetCritters#addc705539406d44 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:804 | Return map critters matching the optional prototype id and find type |
Critter[] Map.GetCritters(CritterProperty property, int32 propertyValue, CritterFindType findType) |
script.method.server.Map.GetCritters#d9bfa22ace1ec9d4 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:840 | Return map critters matching an integer property and find type |
Critter[] Map.GetCritters(ProtoCritter proto, CritterFindType findType) |
script.method.server.Map.GetCritters#e79de6b56cb9f3b3 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:822 | Return map critters matching the given prototype descriptor and find type |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:859 | Trace a path and return its critters matching the find type |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:868 | Trace a path, write pre-block and block hexes, and return its critters |
Critter[] Map.GetCrittersInRadius(mpos hex, int32 radius, CritterFindType findType) |
script.method.server.Map.GetCrittersInRadius |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:750 | Return critters within a non-negative radius of a valid hex sorted by distance |
Critter[] Map.GetCrittersOnHex(mpos hex, CritterFindType findType) |
script.method.server.Map.GetCrittersOnHex |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:731 | Return critters on a valid hex sorted by distance including multihex |
Critter[] Map.GetCrittersWhoSeeHex(mpos hex, CritterFindType findType) |
script.method.server.Map.GetCrittersWhoSeeHex#331d6938741ba331 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:879 | Return critters whose look distance covers the hex |
Critter[] Map.GetCrittersWhoSeeHex(mpos hex, int32 radius, CritterFindType findType) |
script.method.server.Map.GetCrittersWhoSeeHex#6295b4bbbc256992 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:894 | Return critters whose look distance plus radius covers the hex |
Critter[] Map.GetCrittersWhoSeePath(mpos fromHex, mpos toHex, CritterFindType findType) |
script.method.server.Map.GetCrittersWhoSeePath |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:909 | Return critters whose look circle intersects the path |
void Map.GetHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist) |
script.method.server.Map.GetHexInPath |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:926 | Trace a path and write the last hex before the first blocker |
Item? Map.GetItem(ident itemId) |
script.method.server.Map.GetItem |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:124 | Return a map item by id, or null when it is absent or the id is zero |
Item? Map.GetItemInRadius(mpos hex, int32 radius, hstring pid) |
script.method.server.Map.GetItemInRadius#2c45a3b349bce706 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:180 | Return the first item with the given prototype id within a non-negative radius |
Item? Map.GetItemInRadius(mpos hex, int32 radius, ProtoItem proto) |
script.method.server.Map.GetItemInRadius#43a0e23b140b9e9a |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:202 | Return the first item with the given prototype descriptor within a non-negative radius |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:224 | Return the first item within a non-negative radius whose integer property equals the value |
Item? Map.GetItemOnHex(mpos hex, ProtoItem proto) |
script.method.server.Map.GetItemOnHex#6ece718d14bda9df |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:148 | Return the first map item with the given prototype descriptor on a valid hex |
Item? Map.GetItemOnHex(mpos hex, hstring pid) |
script.method.server.Map.GetItemOnHex#bde72d72df216ffd |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:136 | Return the first map item with the given prototype id on a valid hex |
Item? Map.GetItemOnHex(mpos hex, ItemProperty property, int32 propertyValue) |
script.method.server.Map.GetItemOnHex#fd531ae0c65b5f38 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:160 | Return the first item on a valid hex whose integer property equals the value |
Item[] Map.GetItems(ItemProperty property, int32 propertyValue) |
script.method.server.Map.GetItems#83c145745774df22 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:367 | Return dynamic map items whose integer property equals the value |
Item[] Map.GetItems(hstring pid) |
script.method.server.Map.GetItems#986ac88634199639 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:255 | Return dynamic map items with the given prototype id |
Item[] Map.GetItems() |
script.method.server.Map.GetItems#b851260ade7c353c |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:247 | Return all dynamic map items |
Item[] Map.GetItems(ProtoItem proto) |
script.method.server.Map.GetItems#ef66ddcc26718dfe |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:273 | Return dynamic map items with the given prototype descriptor |
Item[] Map.GetItemsInRadius(mpos hex, int32 radius, ProtoItem proto) |
script.method.server.Map.GetItemsInRadius#1b2344cf4e6a8ad6 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:342 | Return dynamic map items with the given prototype descriptor within a non-negative radius |
Item[] Map.GetItemsInRadius(mpos hex, int32 radius) |
script.method.server.Map.GetItemsInRadius#2c10a43df574d95a |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:303 | Return dynamic map items within a non-negative radius of a valid hex |
Item[] Map.GetItemsInRadius(mpos hex, int32 radius, hstring pid) |
script.method.server.Map.GetItemsInRadius#71e75da3d8138709 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:317 | Return dynamic map items with the given prototype id within a non-negative radius |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:410 | Return dynamic map items within a non-negative radius whose integer property equals the value |
Item[] Map.GetItemsOnHex(mpos hex) |
script.method.server.Map.GetItemsOnHex#2becb51a4793de35 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:291 | Return dynamic map items on a valid hex |
Item[] Map.GetItemsOnHex(mpos hex, ItemProperty property, int32 propertyValue) |
script.method.server.Map.GetItemsOnHex#5db3ed64fff8551d |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:386 | Return dynamic map items on a valid hex whose integer property equals the value |
Location Map.GetLocation() |
script.method.server.Map.GetLocation |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:38 | Return the parent location of this map |
mpos[] Map.GetMovableHexesInSight(mpos origin, int32 radius) |
script.method.server.Map.GetMovableHexesInSight |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:948 | Returns movable cells within the radius that have an unobstructed line of sight from the origin |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:981 | Return the path length in steps for a critter to a valid hex, or zero when no path exists |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:955 | Returns the path length in steps between two cells, or zero when no path exists |
int32 Map.GetPlayerCritterCount() |
script.method.server.Map.GetPlayerCritterCount |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:779 | Return the number of player critters currently on the map |
Player[] Map.GetSpectatorPlayers() |
script.method.server.Map.GetSpectatorPlayers |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:794 | Return a snapshot of the players spectating this map |
StaticItem? Map.GetStaticItem(ident id) |
script.method.server.Map.GetStaticItem |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:525 | Return a static map item by id |
StaticItem? Map.GetStaticItemOnHex(mpos hex, ProtoItem proto) |
script.method.server.Map.GetStaticItemOnHex#2ff535bb81b4c46e |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:545 | Return a static item with the given prototype descriptor on a valid hex |
StaticItem? Map.GetStaticItemOnHex(mpos hex, hstring pid) |
script.method.server.Map.GetStaticItemOnHex#8f12443105465e0c |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:533 | Return a static item with the given prototype id on a valid hex |
StaticItem[] Map.GetStaticItems(ItemProperty property, int32 propertyValue) |
script.method.server.Map.GetStaticItems#05085759f098a103 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:664 | Return static items whose integer property equals the value |
StaticItem[] Map.GetStaticItems(ProtoItem proto) |
script.method.server.Map.GetStaticItems#3d6e192e1648eca6 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:656 | Return static items with the given prototype descriptor |
StaticItem[] Map.GetStaticItems(hstring pid) |
script.method.server.Map.GetStaticItems#ba60a4d88539cc01 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:648 | Return static items with the given prototype id |
StaticItem[] Map.GetStaticItems() |
script.method.server.Map.GetStaticItems#e35ab59d1c820445 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:683 | Return all static items of this map |
StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, ProtoItem proto) |
script.method.server.Map.GetStaticItemsInRadius#9fcecfdd954f2f40 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:584 | Return static items with the given prototype descriptor within a non-negative radius |
StaticItem[] Map.GetStaticItemsInRadius(mpos hex, int32 radius, hstring pid) |
script.method.server.Map.GetStaticItemsInRadius#b716f83c2f22af43 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:569 | Return static items with the given prototype id within a non-negative radius |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:622 | Return static items within a non-negative radius whose integer property equals the value |
StaticItem[] Map.GetStaticItemsOnHex(mpos hex) |
script.method.server.Map.GetStaticItemsOnHex#4a9a56826105ef2b |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:557 | Return static items on a valid hex |
StaticItem[] Map.GetStaticItemsOnHex(mpos hex, ItemProperty property, int32 propertyValue) |
script.method.server.Map.GetStaticItemsOnHex#5d15ee5943a3edd0 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:599 | Return static items on a valid hex whose integer property equals the value |
void Map.GetWallHexInPath(mpos fromHex, mpos& toHex, float32 angle, int32 dist) |
script.method.server.Map.GetWallHexInPath |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:934 | Trace a wall-only path and write the last movable hex, or the start hex when none |
bool Map.IsHexMovable(mpos hex) |
script.method.server.Map.IsHexMovable |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1229 | Return whether a valid map hex is movable |
bool Map.IsHexShootable(mpos hex) |
script.method.server.Map.IsHexShootable |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1254 | Return whether a valid map hex is shootable |
bool Map.IsHexValid(mpos hex) |
script.method.server.Map.IsHexValid |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1222 | Return whether the hex lies inside the map bounds |
bool Map.IsHexesMovable(mpos hex, int32 radius) |
script.method.server.Map.IsHexesMovable |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1240 | Return whether the hex and its neighborhood within the given radius are free for movement |
bool Map.IsOutsideArea(mpos hex) |
script.method.server.Map.IsOutsideArea |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1265 | Return whether a valid map hex lies outside an indoor area |
ident[] Map.LoadRuntimeStaticItems(hstring mapPid, mpos destHex, mpos sourceHex, msize sourceSize, int64 idOffset) |
script.method.server.Map.LoadRuntimeStaticItems#0971edd694992850 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:484 | Load the static items of a prototype map area as runtime static items so that the area's first hex lands at destHex, with baked ids plus idOffset, and return their ids |
ident[] Map.LoadRuntimeStaticItems(hstring mapPid, mpos destHex, int64 idOffset) |
script.method.server.Map.LoadRuntimeStaticItems#7af3f0c56f49e919 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:467 | Load the static items of a prototype map as runtime static items so that its first hex lands at destHex, with baked ids plus idOffset, and return their ids |
bool Map.MoveHexByDir(mpos& hex, mdir dir) |
script.method.server.Map.MoveHexByDir#62392271e1b42030 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1331 | Move a hex one step in a direction using map bounds and return whether it moved |
int32 Map.MoveHexByDir(mpos& hex, mdir dir, int32 steps) |
script.method.server.Map.MoveHexByDir#b39016610645244b |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1343 | Move a hex up to the given steps in a direction and return the completed steps |
void Map.Regenerate() |
script.method.server.Map.Regenerate |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1324 | Regenerate map content and placement caches |
bool Map.RemoveStaticItem(ident staticItemId) |
script.method.server.Map.RemoveStaticItem#7b30d7a907ece580 |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:439 | 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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:453 | Remove a static item belonging to this map, rejecting items from another map |
void Map.SetupScript(callback(void,Map,bool) initFunc) |
script.method.server.Map.SetupScript |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:13 | Run the init callback and store its name as the init script |
void Map.SetupScriptEx(hstring initFunc) |
script.method.server.Map.SetupScriptEx |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:27 | Run the named init script and store its name |
void Map.UnblockHex(mpos hex) |
script.method.server.Map.UnblockHex |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1310 | Clear manual blocking for a valid map hex |
void Map.UnloadRuntimeStaticItems(ident[] runtimeStaticItemIds) |
script.method.server.Map.UnloadRuntimeStaticItems |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:501 | Remove runtime static items that LoadRuntimeStaticItems added to the map |
void Map.VerifyTrigger(Critter cr, mpos hex, mdir dir) |
script.method.server.Map.VerifyTrigger |
Map |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerMapScriptMethods.cpp:1361 | Verify map triggers for a critter crossing into a valid hex from the previous direction |
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.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:26 | Request graceful disconnection of this player's connection |
Critter? Player.GetControlledCritter() |
script.method.server.Player.GetControlledCritter |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:73 | Return the critter controlled by this player, or null when none is controlled |
DisconnectReason Player.GetDisconnectReason() |
script.method.server.Player.GetDisconnectReason |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:40 | Return the reason this player's connection was closed |
string Player.GetHost() |
script.method.server.Player.GetHost |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:12 | Return this player's connection host |
int32 Player.GetPort() |
script.method.server.Player.GetPort |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:19 | Return this player's connection port |
Map? Player.GetViewMapTarget() |
script.method.server.Player.GetViewMapTarget |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:107 | Return the map this player currently spectates |
void Player.HardDisconnect() |
script.method.server.Player.HardDisconnect |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:33 | Force-close this player's connection with the script request reason |
void Player.RefreshCritterMoving(Critter cr) |
script.method.server.Player.RefreshCritterMoving |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:81 | Send movement state for a critter on the player's current map |
void Player.RefreshViewMapVisibility(Map map) |
script.method.server.Player.RefreshViewMapVisibility |
Player |
server | experimental (explicit)since 2026.1.83-devcontract source: Source/Scripting/ServerPlayerScriptMethods.cpp:161 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:163 | Recomputes visible subjects for the retained view context without reloading the map |
void Player.ResetViewMap() |
script.method.server.Player.ResetViewMap |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:185 | Clear view-map state without reparenting any entity |
void Player.ReturnFromViewMap() |
script.method.server.Player.ReturnFromViewMap |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:171 | Restores the controlled critter's ordinary display and its initial visible subjects |
void Player.SetName(string name) |
script.method.server.Player.SetName |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:47 | Set the player name after rejecting empty, untrimmed or invalid UTF-8 input |
void Player.SwitchCritter(Critter? cr) |
script.method.server.Player.SwitchCritter |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:64 | Switch the player to the specified critter, or detach control when the argument is null |
void Player.UnloadMap() |
script.method.server.Player.UnloadMap |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:192 | Clear view-map state and send a map unload when the player controls no critter |
void Player.ViewMap(Map map, mpos hex) |
script.method.server.Player.ViewMap |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:114 | Load the map for a player without a controlled critter and open a full map view |
void Player.ViewMapArea(Map map, mpos hex, int32 radius, Entity? context) |
script.method.server.Player.ViewMapArea |
Player |
server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:15 |
- | Source/Scripting/ServerPlayerScriptMethods.cpp:142 | Open a bounded view of the map after validating the player, hex and positive int16_t radius |