Documentation
Docs/en/reference/script-api/properties.md
Entity Properties
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 132 generated entity properties.
Critter
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
ident Critter.AttachMaster |
script.property.Critter.AttachMaster |
common | read-only | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:363 | Identifier of the attachment master; zero when the critter is not attached |
CritterCondition Critter.Condition |
script.property.Critter.Condition |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:377 | Current life-state condition used by animation, filtering, and gameplay queries |
bool Critter.ControlledByPlayer |
script.property.Critter.ControlledByPlayer |
common | read-only | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:351 | Classifies the critter as player-controllable independently of its current online state |
hstring Critter.CustomHolderEntry |
script.property.Critter.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident Critter.CustomHolderId |
script.property.Critter.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
bool Critter.DeadDrawNoFlatten |
script.property.Critter.DeadDrawNoFlatten |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:388 | Keeps a dead critter in the normal critter draw order instead of the flattened dead-critter order |
mdir Critter.Dir |
script.property.Critter.Dir |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:322 | Current facing direction on the map grid |
int16 Critter.Elevation |
script.property.Critter.Elevation |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:319 | Vertical rendering elevation of the critter |
bool Critter.ExplicitlyPersistent |
script.property.Critter.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
uint32 Critter.GlobalMapTripId |
script.property.Critter.GlobalMapTripId |
server | read-only | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:310 | Server-assigned identifier shared by members of the same current global-map trip |
mpos Critter.Hex |
script.property.Critter.Hex |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:313 | Origin hex currently occupied by the critter on its map |
ipos16 Critter.HexOffset |
script.property.Critter.HexOffset |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:316 | Sub-hex map-space offset used by movement interpolation and rendering |
bool Critter.HideSprite |
script.property.Critter.HideSprite |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:366 | Hides the current client map sprite without removing the critter's map presence |
hstring Critter.InitScript |
script.property.Critter.InitScript |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, ScriptFuncType, =, CritterInit, CoreProperty |
Source/Common/EntityProperties.h:304 | Server initialization function called after the critter-init event for a newly created or restored critter |
bool Critter.IsAttached |
script.property.Critter.IsAttached |
common | read-only | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:360 | Reports that this critter currently follows another critter as an attachment |
bool Critter.IsChosen |
script.property.Critter.IsChosen |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:354 | Reports that this critter is the locally chosen critter on the current client |
bool Critter.IsPlayerOffline |
script.property.Critter.IsPlayerOffline |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:357 | Client-side connection state reported for a player-controlled critter |
ident[] Critter.ItemIds |
script.property.Critter.ItemIds |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:325 | Persistent identifiers of the items directly held in the critter's inventory |
ucolor Critter.LightColor |
script.property.Critter.LightColor |
client | mutable | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, CoreProperty |
Source/Common/EntityProperties.h:403 | RGBA color emitted by the critter's client-side light source |
int16 Critter.LightDistance |
script.property.Critter.LightDistance |
client | mutable | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, CoreProperty |
Source/Common/EntityProperties.h:397 | Radius in hexes reached by the critter's client-side light source |
uint16 Critter.LightFlags |
script.property.Critter.LightFlags |
client | mutable | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, CoreProperty |
Source/Common/EntityProperties.h:400 | Bit mask controlling global, inverse, and direction-blocking behavior of the light source |
int8 Critter.LightIntensity |
script.property.Critter.LightIntensity |
client | mutable | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, CoreProperty |
Source/Common/EntityProperties.h:394 | Signed percentage intensity of the critter's client-side light source |
bool Critter.LightSource |
script.property.Critter.LightSource |
client | mutable | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, CoreProperty |
Source/Common/EntityProperties.h:391 | Enables a client-side map light source centered on this critter |
int32 Critter.LookDistance |
script.property.Critter.LookDistance |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, OwnerSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:383 | Maximum map-view distance in hexes used by server visibility processing |
ident Critter.MapId |
script.property.Critter.MapId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:307 | Identifier of the map currently containing the critter; zero while it is on the global map |
int32[] Critter.ModelLayers |
script.property.Critter.ModelLayers |
client | mutable | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, CoreProperty |
Source/Common/EntityProperties.h:346 | Fixed-size client values passed to the 3D model layer and animation resolver |
hstring Critter.ModelName |
script.property.Critter.ModelName |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, Resource, CoreProperty |
Source/Common/EntityProperties.h:328 | Sprite or 3D model resource used to present the critter |
int32 Critter.MovingSpeed |
script.property.Critter.MovingSpeed |
server | read-only | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:369 | Current server movement speed published for active movement |
int32 Critter.Multihex |
script.property.Critter.Multihex |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:331 | Radius in hexes occupied by the critter in movement, pathfinding, and distance checks |
int16 Critter.NameOffset |
script.property.Critter.NameOffset |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:380 | Vertical pixel adjustment applied to the critter name label |
int32 Critter.ScaleFactor |
script.property.Critter.ScaleFactor |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:334 | 3D model scale in thousandths; zero selects the default scale of 1000 |
int32 Critter.ShowCritterDist1 |
script.property.Critter.ShowCritterDist1 |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h:337 | Optional first visibility-event distance in hexes; zero disables this distance group |
int32 Critter.ShowCritterDist2 |
script.property.Critter.ShowCritterDist2 |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h:340 | Optional second visibility-event distance in hexes; zero disables this distance group |
int32 Critter.ShowCritterDist3 |
script.property.Critter.ShowCritterDist3 |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h:343 | Optional third visibility-event distance in hexes; zero disables this distance group |
CritterVisibilityMode Critter.VisibilityMode |
script.property.Critter.VisibilityMode |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:372 | Visibility detail mode assigned to this critter from the current client's viewpoint |
Game
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
hstring Game.CustomHolderEntry |
script.property.Game.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident Game.CustomHolderId |
script.property.Game.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
bool Game.ExplicitlyPersistent |
script.property.Game.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
timespan Game.FrameDeltaTime |
script.property.Game.FrameDeltaTime |
common | read-only | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:66 | Elapsed monotonic time between the current and previous frame advances |
nanotime Game.FrameTime |
script.property.Game.FrameTime |
common | read-only | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:63 | Monotonic engine time captured for the current frame |
int32 Game.FramesPerSecond |
script.property.Game.FramesPerSecond |
common | read-only | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:69 | Frame count measured during the most recently completed one-second sampling interval |
int32 Game.GlobalDayTime |
script.property.Game.GlobalDayTime |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:75 | Current position of the global day-light cycle, measured in minutes and controlled by game scripts |
ident Game.HistoryRecordsId |
script.property.Game.HistoryRecordsId |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:60 | Persistent high-water mark used to allocate server history-record identifiers |
ident Game.LastEntityId |
script.property.Game.LastEntityId |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:57 | Persistent high-water mark used to allocate durable entity identifiers |
uint32 Game.LastGlobalMapTripId |
script.property.Game.LastGlobalMapTripId |
server | read-only | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:72 | Last server-assigned identifier for a global-map trip |
synctime Game.SynchronizedTime |
script.property.Game.SynchronizedTime |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:54 | Current synchronized game time shared by the server and clients and persisted by the server |
ImGui
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
hstring ImGui.CustomHolderEntry |
script.property.ImGui.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident ImGui.CustomHolderId |
script.property.ImGui.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
bool ImGui.ExplicitlyPersistent |
script.property.ImGui.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
Item
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
bool Item.AlwaysHideSprite |
script.property.Item.AlwaysHideSprite |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:197 | Prevents the item sprite from being drawn at runtime and hides it by default in Mapper |
bool Item.Colorize |
script.property.Item.Colorize |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:287 | Enables ColorizeColor tinting for the item's map sprite |
ucolor Item.ColorizeColor |
script.property.Item.ColorizeColor |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:232 | RGBA tint applied when Colorize is enabled; alpha also supplies the default sprite opacity |
ident Item.ContainerId |
script.property.Item.ContainerId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:147 | Identifier of the parent item while Ownership is ItemContainer; zero otherwise |
any Item.ContainerStack |
script.property.Item.ContainerStack |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:150 | Project-defined grouping key used to select and merge items inside a container |
CornerType Item.Corner |
script.property.Item.Corner |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:164 | Wall-corner orientation used by map lighting and transparent-foreground behavior |
ident Item.CritterId |
script.property.Item.CritterId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:137 | Identifier of the owning critter while Ownership is CritterInventory; zero otherwise |
CritterItemSlot Item.CritterSlot |
script.property.Item.CritterSlot |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:144 | Inventory or equipment slot occupied while the item belongs to a critter |
hstring Item.CustomHolderEntry |
script.property.Item.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident Item.CustomHolderId |
script.property.Item.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
bool Item.DisableEgg |
script.property.Item.DisableEgg |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:167 | Disables transparent-foreground egg processing for the item's map sprite |
bool Item.DrawFlatten |
script.property.Item.DrawFlatten |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:266 | Renders the item in a flat map pass instead of the normal depth-sorted item pass |
bool Item.DrawMultihexLines |
script.property.Item.DrawMultihexLines |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:181 | Draws repeated item sprites on footprint hexes generated by MultihexLines |
bool Item.DrawMultihexMesh |
script.property.Item.DrawMultihexMesh |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:184 | Draws repeated item sprites on the explicit MultihexMesh hexes |
int8 Item.DrawOrderSubLayer |
script.property.Item.DrawOrderSubLayer |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:269 | Fine ordering inside the item's primary draw-order layer; synchronized when changed at runtime |
int16 Item.Elevation |
script.property.Item.Elevation |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:132 | Vertical rendering elevation of the map item |
bool Item.ExplicitlyPersistent |
script.property.Item.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
mpos Item.Hex |
script.property.Item.Hex |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:129 | Origin map hex used while the item is placed on a map |
bool Item.Hidden |
script.property.Item.Hidden |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h:189 | Server visibility flag that suppresses a dynamic item from client views while set |
bool Item.HideSprite |
script.property.Item.HideSprite |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:192 | Hides the current client map sprite without removing the item's map presence |
hstring Item.InitScript |
script.property.Item.InitScript |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, ScriptFuncType, =, ItemInit, CoreProperty |
Source/Common/EntityProperties.h:113 | Server initialization function called after the item-init event for a newly created or restored item |
ident[] Item.InnerItemIds |
script.property.Item.InnerItemIds |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:155 | Persistent identifiers of the items directly contained by this item |
bool Item.IsGag |
script.property.Item.IsGag |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:282 | Marks a blocking item as conditionally passable through the map gag callback |
bool Item.IsRoofTile |
script.property.Item.IsRoofTile |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:258 | Selects roof rendering instead of ground-tile rendering when IsTile is enabled |
bool Item.IsScenery |
script.property.Item.IsScenery |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:249 | Classifies the item as scenery for Mapper filtering and flat-render lighting rules |
bool Item.IsTile |
script.property.Item.IsTile |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:255 | Classifies the item as a ground or roof tile rendered in a tile layer |
bool Item.IsTrigger |
script.property.Item.IsTrigger |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:243 | Includes the item in map trigger lookup and movement-trigger processing |
bool Item.IsWall |
script.property.Item.IsWall |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:252 | Classifies the item as a wall for Mapper filtering and map presentation |
ucolor Item.LightColor |
script.property.Item.LightColor |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:229 | RGBA color emitted by the item's light source |
int16 Item.LightDistance |
script.property.Item.LightDistance |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:223 | Radius in hexes reached by the item's light source |
uint16 Item.LightFlags |
script.property.Item.LightFlags |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:226 | Bit mask controlling global, inverse, and direction-blocking behavior of the light source |
int8 Item.LightIntensity |
script.property.Item.LightIntensity |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:220 | Signed percentage intensity of the item's light source |
bool Item.LightSource |
script.property.Item.LightSource |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:217 | Enables a map light source centered on this item |
bool Item.LightThru |
script.property.Item.LightThru |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:212 | Allows map light propagation through every hex occupied by the item |
ident Item.MapId |
script.property.Item.MapId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:126 | Identifier of the owning map while Ownership is MapHex; zero otherwise |
MultihexGenerationType Item.MultihexGeneration |
script.property.Item.MultihexGeneration |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:178 | Mapper coalescing strategy used to build MultihexMesh from compatible item placements |
uint8[] Item.MultihexLines |
script.property.Item.MultihexLines |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:172 | Direction and step-count pairs that trace additional footprint hexes from each mesh origin |
mpos[] Item.MultihexMesh |
script.property.Item.MultihexMesh |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:175 | Explicit map hexes that share this item's footprint and optional repeated sprite |
bool Item.NoBlock |
script.property.Item.NoBlock |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:202 | Allows movement through every hex occupied by the item |
bool Item.NoHighlight |
script.property.Item.NoHighlight |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:274 | Prevents the client from applying normal item highlight presentation |
bool Item.NoLightInfluence |
script.property.Item.NoLightInfluence |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:279 | Prevents ambient map lighting from tinting the item's sprite |
ipos16 Item.Offset |
script.property.Item.Offset |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:161 | Pixel offset applied to the item's map sprite from its origin hex |
ItemOwnership Item.Ownership |
script.property.Item.Ownership |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:123 | Current placement category: map hex, critter inventory, item container, or nowhere |
hstring Item.PicInv |
script.property.Item.PicInv |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, Resource, CoreProperty |
Source/Common/EntityProperties.h:246 | Sprite resource used to present the item in inventory interfaces |
hstring Item.PicMap |
script.property.Item.PicMap |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, Resource, CoreProperty |
Source/Common/EntityProperties.h:158 | Sprite resource used to render the item on a map |
bool Item.ShootThru |
script.property.Item.ShootThru |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:207 | Allows projectile traces through every hex occupied by the item |
bool Item.Static |
script.property.Item.Static |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:118 | Marks map-authored item data as static scenery rather than a dynamic item entity |
hstring Item.StaticScript |
script.property.Item.StaticScript |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, ScriptFuncType, =, ItemStatic, CoreProperty |
Source/Common/EntityProperties.h:237 | Server callback invoked when a critter interacts with this static item |
uint8 Item.TileLayer |
script.property.Item.TileLayer |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:261 | Zero-based ground- or roof-tile draw layer selected for a tile item |
hstring Item.TriggerScript |
script.property.Item.TriggerScript |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, ScriptFuncType, =, ItemTrigger, CoreProperty |
Source/Common/EntityProperties.h:240 | Server callback invoked when a critter enters or leaves this trigger item |
Location
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
hstring Location.CustomHolderEntry |
script.property.Location.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident Location.CustomHolderId |
script.property.Location.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
bool Location.ExplicitlyPersistent |
script.property.Location.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
hstring Location.InitScript |
script.property.Location.InitScript |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, ScriptFuncType, =, LocationInit, CoreProperty |
Source/Common/EntityProperties.h:495 | Server initialization function called after the location-init event for a newly created or restored location |
ident[] Location.MapIds |
script.property.Location.MapIds |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:498 | Persistent identifiers of the maps owned by this location, in location-map order |
Map
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
ident[] Map.CritterIds |
script.property.Map.CritterIds |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:429 | Persistent identifiers of the non-player critters owned by this map |
hstring Map.CustomHolderEntry |
script.property.Map.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident Map.CustomHolderId |
script.property.Map.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
uint8[] Map.DayColor |
script.property.Map.DayColor |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:466 | Channel-major RGB values for the map's corresponding daylight color keyframes |
int32[] Map.DayColorTime |
script.property.Map.DayColorTime |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:463 | Map-specific daylight color keyframe times expressed in minutes of the day cycle |
bool Map.ExplicitlyPersistent |
script.property.Map.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
int32 Map.FixedDayTime |
script.property.Map.FixedDayTime |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:458 | Map-local day-time override value, conventionally expressed in minutes and interpreted by game scripts |
ucolor Map.GlobalDayColor |
script.property.Map.GlobalDayColor |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:472 | Current client-side global daylight color supplied through SetDayColors for scripts and effects |
int32 Map.GlobalDayLightCapacity |
script.property.Map.GlobalDayLightCapacity |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:478 | Current daylight capacity percentage for light sources flagged as global, clamped to 0 through 100 |
hstring Map.InitScript |
script.property.Map.InitScript |
server | mutable, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, Persistent, ScriptFuncType, =, MapInit, CoreProperty |
Source/Common/EntityProperties.h:420 | Server initialization function called after the map-init event for a newly created or restored map |
ident[] Map.ItemIds |
script.property.Map.ItemIds |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:432 | Persistent identifiers of the dynamic items placed directly on this map |
ident Map.LocId |
script.property.Map.LocId |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:423 | Identifier of the location that owns this map |
int32 Map.LocMapIndex |
script.property.Map.LocMapIndex |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:426 | Zero-based position of this map in its owning location's map list |
ucolor Map.MapDayColor |
script.property.Map.MapDayColor |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:469 | Current client-side map tint supplied through SetDayColors and consumed by map rendering |
int32 Map.MapDayLightCapacity |
script.property.Map.MapDayLightCapacity |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:475 | Current daylight capacity percentage for ordinary map light sources, clamped to 0 through 100 |
ident[] Map.RemovedStaticItemIds |
script.property.Map.RemovedStaticItemIds |
common | mutable, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h:435 | Identifiers of the baked static items this map instance has dropped; removal is one-way for the life of the instance |
irect Map.ScrollAxialArea |
script.property.Map.ScrollAxialArea |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:447 | Axial-coordinate rectangle that bounds map scrolling; a zero rectangle leaves the full map available |
ipos Map.ScrollOffset |
script.property.Map.ScrollOffset |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:444 | Rounded client viewport offset in map-space pixels |
msize Map.Size |
script.property.Map.Size |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:438 | Width and height of the map grid in hexes |
float32 Map.SpritesZoom |
script.property.Map.SpritesZoom |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:450 | Current client map-sprite zoom factor |
float32 Map.SpritesZoomTarget |
script.property.Map.SpritesZoomTarget |
client | read-only | client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:453 | Target zoom factor toward which the client map view is interpolating |
mpos Map.WorkHex |
script.property.Map.WorkHex |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:441 | Authoring work hex used as the initial Mapper view center |
Player
| Signature | Symbol ID | Access | Property contract | Runtime | API contract | Flags | Source | Description |
|---|---|---|---|---|---|---|---|---|
ident Player.ControlledCritterId |
script.property.Player.ControlledCritterId |
server | read-only | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:93 | Identifier of the critter currently controlled by this player; zero when none is attached |
hstring Player.CustomHolderEntry |
script.property.Player.CustomHolderEntry |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
ident Player.CustomHolderId |
script.property.Player.CustomHolderId |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:86 | For a custom entity, stores the persistent identifier of its owning holder; zero when the holder has no persistent identifier |
bool Player.ExplicitlyPersistent |
script.property.Player.ExplicitlyPersistent |
common | read-only, persistent | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
ident Player.LastControlledCritterId |
script.property.Player.LastControlledCritterId |
server | read-only, persistent | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Persistent, CoreProperty |
Source/Common/EntityProperties.h:96 | Persistent identifier of the most recently controlled critter, retained after detachment for restoration |
bool Player.LoggedIn |
script.property.Player.LoggedIn |
server | read-only | server | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
CoreProperty |
Source/Common/EntityProperties.h:90 | Reports whether this player connection has completed server login |