Documentation
Docs/en/reference/script-api/types.md
Script Types
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 997 type and member symbols.
Entities
| Entity | Symbol ID | Capabilities | Runtime | Contract | Source | Description |
|---|---|---|---|---|---|---|
entity Critter |
script.entity.Critter |
prototypes, time-events | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:48 | Prototype-backed character entity used for player bodies and NPCs, with inventory, movement, and map or global-map state. |
entity Game |
script.entity.Game |
global | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:44 | Global singleton script receiver for the current server, client, or Mapper engine; it exposes engine services, events, and game properties rather than a persistent world object. |
entity ImGui |
script.entity.ImGui |
global | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:54 | Global script receiver bound to the current engine's Dear ImGui context; individual methods define their active-frame and balanced-scope requirements. |
entity Item |
script.entity.Item |
prototypes, statics, abstract, time-events | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:49 | Prototype-backed item entity that can belong to a map, critter inventory, container, or custom holder and also exposes static and abstract variants. |
entity Location |
script.entity.Location |
prototypes, time-events | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:46 | Prototype-backed world-location entity that owns instantiated maps on the server and is represented by LocationView on clients. |
entity Map |
script.entity.Map |
prototypes, time-events | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:47 | Prototype-backed instantiated map entity containing runtime critters and items; clients operate on its replicated MapView. |
entity Player |
script.entity.Player |
time-events | server, client, mapper | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:45 | Player account and connection-session entity, distinct from the Critter it may control; clients receive its replicated PlayerView. |
Enums
CornerType
enum CornerType : uint8
Symbol ID: script.enum.CornerType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1068
Wall-corner orientation used by map geometry and corner-aware rendering
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
East |
2 |
2 | script.enum-value.CornerType.East |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1073 | Selects the east-facing wall-corner orientation |
EastWest |
5 |
5 | script.enum-value.CornerType.EastWest |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1076 | Selects the combined east-west wall-corner orientation |
North |
4 |
4 | script.enum-value.CornerType.North |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1075 | Selects the north-facing wall-corner orientation |
NorthSouth |
0 |
0 | script.enum-value.CornerType.NorthSouth |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1071 | Selects the combined north-south wall-corner orientation |
South |
3 |
3 | script.enum-value.CornerType.South |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1074 | Selects the south-facing wall-corner orientation |
West |
1 |
1 | script.enum-value.CornerType.West |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1072 | Selects the west-facing wall-corner orientation |
CritterAction
enum CritterAction : uint16
Symbol ID: script.enum.CritterAction
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:981
Engine-originated critter action notifications such as item movement, knockout, death, connection, and respawn.
Some actions have hardcoded local or server dispatch rules; project code should consume the symbolic action
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Connect |
20 |
20 | script.enum-value.CritterAction.Connect |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:991 | Notifies observers that the player-controlled critter connected |
Dead |
19 |
19 | script.enum-value.CritterAction.Dead |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:990 | Notifies observers that the critter entered the dead condition |
Disconnect |
21 |
21 | script.enum-value.CritterAction.Disconnect |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:992 | Notifies observers that the player-controlled critter disconnected |
DropItem |
5 |
5 | script.enum-value.CritterAction.DropItem |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:987 | Notifies observers that the critter dropped an item from a slot |
Knockout |
16 |
16 | script.enum-value.CritterAction.Knockout |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:988 | Notifies observers that the critter entered the knockout condition |
MoveItem |
2 |
2 | script.enum-value.CritterAction.MoveItem |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:985 | Notifies observers that an item moved between critter slots |
None |
0 |
0 | script.enum-value.CritterAction.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:984 | No critter action notification is selected |
Refresh |
23 |
23 | script.enum-value.CritterAction.Refresh |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:994 | Requests observers to refresh the critter's visual action state |
Respawn |
22 |
22 | script.enum-value.CritterAction.Respawn |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:993 | Notifies observers that the critter returned to the alive condition outside knockout recovery |
StandUp |
17 |
17 | script.enum-value.CritterAction.StandUp |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:989 | Notifies observers that the critter recovered from knockout and stood up |
SwapItems |
3 |
3 | script.enum-value.CritterAction.SwapItems |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:986 | Notifies observers about the second item participating in a slot swap |
CritterActionAnim
enum CritterActionAnim : uint16
Symbol ID: script.enum.CritterActionAnim
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1006
Requested critter movement or pose animation passed to model animation resolution
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
DeadFront |
102 |
102 | script.enum-value.CritterActionAnim.DeadFront |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1022 | Requests the front-facing death animation |
Idle |
1 |
1 | script.enum-value.CritterActionAnim.Idle |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1010 | Requests the standing idle animation |
IdleProneFront |
86 |
86 | script.enum-value.CritterActionAnim.IdleProneFront |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1021 | Requests the front-facing prone idle animation |
Limp |
4 |
4 | script.enum-value.CritterActionAnim.Limp |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1013 | Requests the limping movement animation |
None |
0 |
0 | script.enum-value.CritterActionAnim.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1009 | No action animation is requested |
PanicRun |
6 |
6 | script.enum-value.CritterActionAnim.PanicRun |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1018 | Requests the panic-running animation |
Run |
5 |
5 | script.enum-value.CritterActionAnim.Run |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1014 | Requests forward running |
RunBack |
16 |
16 | script.enum-value.CritterActionAnim.RunBack |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1015 | Requests backward running |
SneakRun |
8 |
8 | script.enum-value.CritterActionAnim.SneakRun |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1020 | Requests running in the sneaking posture |
SneakWalk |
7 |
7 | script.enum-value.CritterActionAnim.SneakWalk |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1019 | Requests walking in the sneaking posture |
TurnLeft |
18 |
18 | script.enum-value.CritterActionAnim.TurnLeft |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1017 | Requests an in-place left turn |
TurnRight |
17 |
17 | script.enum-value.CritterActionAnim.TurnRight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1016 | Requests an in-place right turn |
Walk |
3 |
3 | script.enum-value.CritterActionAnim.Walk |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1011 | Requests forward walking |
WalkBack |
15 |
15 | script.enum-value.CritterActionAnim.WalkBack |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1012 | Requests backward walking |
CritterCondition
enum CritterCondition : uint8
Symbol ID: script.enum.CritterCondition
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:971
High-level life condition of a critter
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Alive |
0 |
0 | script.enum-value.CritterCondition.Alive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:974 | Critter is alive and may perform normal gameplay actions |
Dead |
2 |
2 | script.enum-value.CritterCondition.Dead |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:976 | Critter is dead and uses death-state handling and animation |
Knockout |
1 |
1 | script.enum-value.CritterCondition.Knockout |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:975 | Critter is alive but incapacitated until it stands up or changes condition |
CritterFindType
enum CritterFindType : uint8
Symbol ID: script.enum.CritterFindType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1043
Composable filters for selecting critters by life state and player-or-NPC ownership
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Any |
0 |
0 | script.enum-value.CritterFindType.Any |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1046 | Selects critters without filtering life state or player ownership |
Dead |
0x02 |
2 | script.enum-value.CritterFindType.Dead |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1048 | Selects dead critters regardless of player ownership |
DeadNpc |
0x22 |
34 | script.enum-value.CritterFindType.DeadNpc |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1054 | Selects dead non-player critters |
DeadPlayers |
0x12 |
18 | script.enum-value.CritterFindType.DeadPlayers |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1052 | Selects dead player-controlled critters |
NonDead |
0x01 |
1 | script.enum-value.CritterFindType.NonDead |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1047 | Selects alive and knocked-out critters while excluding dead critters |
NonDeadNpc |
0x21 |
33 | script.enum-value.CritterFindType.NonDeadNpc |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1053 | Selects non-player critters that are not dead |
NonDeadPlayers |
0x11 |
17 | script.enum-value.CritterFindType.NonDeadPlayers |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1051 | Selects player-controlled critters that are not dead |
Npc |
0x20 |
32 | script.enum-value.CritterFindType.Npc |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1050 | Selects non-player critters regardless of life state |
Players |
0x10 |
16 | script.enum-value.CritterFindType.Players |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1049 | Selects player-controlled critters regardless of life state |
CritterItemSlot
enum CritterItemSlot : uint8
Symbol ID: script.enum.CritterItemSlot
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:962
Logical critter item destinations used for inventory, equipped-main-slot, and outside-item transfers
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Inventory |
0 |
0 | script.enum-value.CritterItemSlot.Inventory |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:965 | Places the item in the critter's unequipped inventory |
Main |
1 |
1 | script.enum-value.CritterItemSlot.Main |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:966 | Places the item in the critter's main equipped slot |
Outside |
255 |
255 | script.enum-value.CritterItemSlot.Outside |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:967 | Marks the item as outside the critter's owned inventory slots |
CritterProperty
enum CritterProperty : uint16
Symbol ID: script.enum.CritterProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the Critter script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AttachMaster |
23 |
23 | script.enum-value.CritterProperty.AttachMaster |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:363 | Identifier of the attachment master; zero when the critter is not attached |
Condition |
27 |
27 | script.enum-value.CritterProperty.Condition |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:377 | Current life-state condition used by animation, filtering, and gameplay queries |
ControlledByPlayer |
19 |
19 | script.enum-value.CritterProperty.ControlledByPlayer |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:351 | Classifies the critter as player-controllable independently of its current online state |
CustomHolderEntry |
2 |
2 | script.enum-value.CritterProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.CritterProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
DeadDrawNoFlatten |
30 |
30 | script.enum-value.CritterProperty.DeadDrawNoFlatten |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:388 | Keeps a dead critter in the normal critter draw order instead of the flattened dead-critter order |
Dir |
10 |
10 | script.enum-value.CritterProperty.Dir |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:322 | Current facing direction on the map grid |
Elevation |
9 |
9 | script.enum-value.CritterProperty.Elevation |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:319 | Vertical rendering elevation of the critter |
ExplicitlyPersistent |
3 |
3 | script.enum-value.CritterProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
GlobalMapTripId |
6 |
6 | script.enum-value.CritterProperty.GlobalMapTripId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:310 | Server-assigned identifier shared by members of the same current global-map trip |
Hex |
7 |
7 | script.enum-value.CritterProperty.Hex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:313 | Origin hex currently occupied by the critter on its map |
HexOffset |
8 |
8 | script.enum-value.CritterProperty.HexOffset |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:316 | Sub-hex map-space offset used by movement interpolation and rendering |
HideSprite |
24 |
24 | script.enum-value.CritterProperty.HideSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:366 | Hides the current client map sprite without removing the critter's map presence |
InitScript |
4 |
4 | script.enum-value.CritterProperty.InitScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:304 | Server initialization function called after the critter-init event for a newly created or restored critter |
IsAttached |
22 |
22 | script.enum-value.CritterProperty.IsAttached |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:360 | Reports that this critter currently follows another critter as an attachment |
IsChosen |
20 |
20 | script.enum-value.CritterProperty.IsChosen |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:354 | Reports that this critter is the locally chosen critter on the current client |
IsPlayerOffline |
21 |
21 | script.enum-value.CritterProperty.IsPlayerOffline |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:357 | Client-side connection state reported for a player-controlled critter |
ItemIds |
11 |
11 | script.enum-value.CritterProperty.ItemIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:325 | Persistent identifiers of the items directly held in the critter's inventory |
LightColor |
35 |
35 | script.enum-value.CritterProperty.LightColor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:403 | RGBA color emitted by the critter's client-side light source |
LightDistance |
33 |
33 | script.enum-value.CritterProperty.LightDistance |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:397 | Radius in hexes reached by the critter's client-side light source |
LightFlags |
34 |
34 | script.enum-value.CritterProperty.LightFlags |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:400 | Bit mask controlling global, inverse, and direction-blocking behavior of the light source |
LightIntensity |
32 |
32 | script.enum-value.CritterProperty.LightIntensity |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:394 | Signed percentage intensity of the critter's client-side light source |
LightSource |
31 |
31 | script.enum-value.CritterProperty.LightSource |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:391 | Enables a client-side map light source centered on this critter |
LookDistance |
29 |
29 | script.enum-value.CritterProperty.LookDistance |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:383 | Maximum map-view distance in hexes used by server visibility processing |
MapId |
5 |
5 | script.enum-value.CritterProperty.MapId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:307 | Identifier of the map currently containing the critter; zero while it is on the global map |
ModelLayers |
18 |
18 | script.enum-value.CritterProperty.ModelLayers |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:346 | Fixed-size client values passed to the 3D model layer and animation resolver |
ModelName |
12 |
12 | script.enum-value.CritterProperty.ModelName |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:328 | Sprite or 3D model resource used to present the critter |
MovingSpeed |
25 |
25 | script.enum-value.CritterProperty.MovingSpeed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:369 | Current server movement speed published for active movement |
Multihex |
13 |
13 | script.enum-value.CritterProperty.Multihex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:331 | Radius in hexes occupied by the critter in movement, pathfinding, and distance checks |
NameOffset |
28 |
28 | script.enum-value.CritterProperty.NameOffset |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:380 | Vertical pixel adjustment applied to the critter name label |
None |
0 |
0 | script.enum-value.CritterProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no Critter property identifier is selected. |
ScaleFactor |
14 |
14 | script.enum-value.CritterProperty.ScaleFactor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:334 | 3D model scale in thousandths; zero selects the default scale of 1000 |
ShowCritterDist1 |
15 |
15 | script.enum-value.CritterProperty.ShowCritterDist1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:337 | Optional first visibility-event distance in hexes; zero disables this distance group |
ShowCritterDist2 |
16 |
16 | script.enum-value.CritterProperty.ShowCritterDist2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:340 | Optional second visibility-event distance in hexes; zero disables this distance group |
ShowCritterDist3 |
17 |
17 | script.enum-value.CritterProperty.ShowCritterDist3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:343 | Optional third visibility-event distance in hexes; zero disables this distance group |
VisibilityMode |
26 |
26 | script.enum-value.CritterProperty.VisibilityMode |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:372 | Visibility detail mode assigned to this critter from the current client's viewpoint |
CritterSeeType
enum CritterSeeType : uint8
Symbol ID: script.enum.CritterSeeType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1026
Perspective used by critter visibility queries: either direction or their union
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Any |
0 |
0 | script.enum-value.CritterSeeType.Any |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1029 | Returns the union of incoming and outgoing critter visibility relations |
WhoISee |
2 |
2 | script.enum-value.CritterSeeType.WhoISee |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1031 | Selects critters currently visible to this critter |
WhoSeeMe |
1 |
1 | script.enum-value.CritterSeeType.WhoSeeMe |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1030 | Selects critters whose visibility relation currently includes this critter |
CritterStateAnim
enum CritterStateAnim : uint16
Symbol ID: script.enum.CritterStateAnim
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:998
Persistent critter animation posture passed to model animation resolution
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
None |
0 |
0 | script.enum-value.CritterStateAnim.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1001 | No persistent critter animation posture is selected |
Unarmed |
1 |
1 | script.enum-value.CritterStateAnim.Unarmed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1002 | Selects the unarmed persistent animation posture |
CritterVisibilityMode
enum CritterVisibilityMode : uint8
Symbol ID: script.enum.CritterVisibilityMode
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1035
Visibility override applied to a critter independently of normal perception checks
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Full |
1 |
1 | script.enum-value.CritterVisibilityMode.Full |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1039 | Forces the target into full visibility for the selected relation |
None |
0 |
0 | script.enum-value.CritterVisibilityMode.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1038 | Applies no full-visibility override and uses normal perception rules |
DisconnectReason
enum DisconnectReason : uint8
Symbol ID: script.enum.DisconnectReason
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Server/ServerConnection.h:46
Why a connection was closed. Recorded on the connection itself so the reason outlives the code path
that ended it and is still readable while scripts run their logout handlers
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
ClientClosed |
1 |
1 | script.enum-value.DisconnectReason.ClientClosed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:50 | Indicates that the transport reported the peer disappearing; voluntary quit and network loss are indistinguishable |
InactivityTimeout |
2 |
2 | script.enum-value.DisconnectReason.InactivityTimeout |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:51 | Indicates that no inbound message arrived before the configured inactivity deadline |
LoginFailed |
9 |
9 | script.enum-value.DisconnectReason.LoginFailed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:58 | Indicates that login was rolled back after a server-side failure |
LoginTimeout |
4 |
4 | script.enum-value.DisconnectReason.LoginTimeout |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:53 | Indicates that a pre-login connection made no progress before the configured login deadline |
None |
0 |
0 | script.enum-value.DisconnectReason.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:49 | Indicates that the connection has not recorded a close cause |
PingTimeout |
3 |
3 | script.enum-value.DisconnectReason.PingTimeout |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:52 | Indicates that the peer did not answer the previous server ping |
ProtocolError |
5 |
5 | script.enum-value.DisconnectReason.ProtocolError |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:54 | Indicates malformed or unexpected protocol data or failed connection publication |
ReplacedByReconnect |
10 |
10 | script.enum-value.DisconnectReason.ReplacedByReconnect |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:59 | Indicates that a new login for the same account replaced this session |
ScriptRequest |
8 |
8 | script.enum-value.DisconnectReason.ScriptRequest |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:57 | Indicates that server script called Player.HardDisconnect() |
ServerShutdown |
7 |
7 | script.enum-value.DisconnectReason.ServerShutdown |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:56 | Indicates an orderly server shutdown |
UpdaterError |
6 |
6 | script.enum-value.DisconnectReason.UpdaterError |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Server/ServerConnection.h:55 | Indicates that the client requested an invalid updater file or range |
DrawOrderType
enum DrawOrderType : uint8
Symbol ID: script.enum.DrawOrderType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/MapSprite.h:50
Ordered map-render layers spanning flat sprites, lighting, normal objects, particles, and roofs
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AfterLight |
11 |
11 | script.enum-value.DrawOrderType.AfterLight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:64 | Primitive layer rendered immediately after map light accumulation |
Critter |
25 |
25 | script.enum-value.DrawOrderType.Critter |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:72 | Depth-sorted critter layer |
DeadCritter |
13 |
13 | script.enum-value.DrawOrderType.DeadCritter |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:66 | Flat dead-critter layer rendered after lighting |
FlatEnd |
18 |
18 | script.enum-value.DrawOrderType.FlatEnd |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:68 | Upper ordering boundary for flat post-light sprites |
FlatItemAfterLight |
16 |
16 | script.enum-value.DrawOrderType.FlatItemAfterLight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:67 | Flat item layer rendered after map lighting |
FlatItemPreLight |
6 |
6 | script.enum-value.DrawOrderType.FlatItemPreLight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:59 | Flat item layer rendered before map lighting |
HexGrid |
8 |
8 | script.enum-value.DrawOrderType.HexGrid |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:60 | Hex-grid overlay layer rendered before lighting primitives |
Item |
22 |
22 | script.enum-value.DrawOrderType.Item |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:71 | Depth-sorted normal item layer |
Last |
39 |
39 | script.enum-value.DrawOrderType.Last |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:83 | Highest valid draw-order marker reserved by the map-sprite sorter |
Light |
10 |
10 | script.enum-value.DrawOrderType.Light |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:63 | Map light accumulation layer |
NormalBegin |
19 |
19 | script.enum-value.DrawOrderType.NormalBegin |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:70 | Lower ordering boundary for depth-sorted normal sprites |
NormalEnd |
31 |
31 | script.enum-value.DrawOrderType.NormalEnd |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:74 | Upper ordering boundary for depth-sorted normal sprites |
Particles |
28 |
28 | script.enum-value.DrawOrderType.Particles |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:73 | Depth-sorted map-particle layer |
PreLight |
9 |
9 | script.enum-value.DrawOrderType.PreLight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:62 | Primitive layer rendered immediately before map light accumulation |
Roof |
33 |
33 | script.enum-value.DrawOrderType.Roof |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:76 | Base roof-sprite layer |
Roof1 |
34 |
34 | script.enum-value.DrawOrderType.Roof1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:77 | First additional roof-sprite layer |
Roof2 |
35 |
35 | script.enum-value.DrawOrderType.Roof2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:78 | Second additional roof-sprite layer |
Roof3 |
36 |
36 | script.enum-value.DrawOrderType.Roof3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:79 | Third additional roof-sprite layer |
Roof4 |
37 |
37 | script.enum-value.DrawOrderType.Roof4 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:80 | Fourth additional roof-sprite layer |
RoofParticles |
38 |
38 | script.enum-value.DrawOrderType.RoofParticles |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:81 | Particle layer rendered with roof sprites |
Tile |
0 |
0 | script.enum-value.DrawOrderType.Tile |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:54 | Base flat tile layer rendered before map lighting |
Tile1 |
1 |
1 | script.enum-value.DrawOrderType.Tile1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:55 | First additional flat tile layer rendered before map lighting |
Tile2 |
2 |
2 | script.enum-value.DrawOrderType.Tile2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:56 | Second additional flat tile layer rendered before map lighting |
Tile3 |
3 |
3 | script.enum-value.DrawOrderType.Tile3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:57 | Third additional flat tile layer rendered before map lighting |
Tile4 |
4 |
4 | script.enum-value.DrawOrderType.Tile4 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:58 | Fourth additional flat tile layer rendered before map lighting |
EffectType
enum EffectType : uint32
Symbol ID: script.enum.EffectType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/EffectManager.h:50
Bit mask selecting the render pipeline or flush stage served by an effect
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CritterSprite |
0x00000002 |
2 | script.enum-value.EffectType.CritterSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:55 | Replaces the default critter-sprite effect or one map critter's draw effect |
FlushFog |
0x20000000 |
536870912 | script.enum-value.EffectType.FlushFog |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:69 | Replaces the effect used to composite the fog buffer |
FlushLight |
0x10000000 |
268435456 | script.enum-value.EffectType.FlushLight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:68 | Replaces the effect used to composite the light buffer |
FlushMap |
0x08000000 |
134217728 | script.enum-value.EffectType.FlushMap |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:67 | Replaces the effect used to composite the rendered map |
FlushPrimitive |
0x04000000 |
67108864 | script.enum-value.EffectType.FlushPrimitive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:66 | Replaces the effect used to flush primitive rendering |
FlushRenderTarget |
0x01000000 |
16777216 | script.enum-value.EffectType.FlushRenderTarget |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:65 | Replaces the effect used to flush a render-target texture |
Fog |
0x00400000 |
4194304 | script.enum-value.EffectType.Fog |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:64 | Replaces the primitive effect used for map fog rendering |
Font |
0x00010000 |
65536 | script.enum-value.EffectType.Font |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:61 | Replaces the default font effect or the effect of one font slot selected by subtype |
GenericSprite |
0x00000001 |
1 | script.enum-value.EffectType.GenericSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:54 | Replaces the default generic-sprite effect or one map item's draw effect |
Interface |
0x00001000 |
4096 | script.enum-value.EffectType.Interface |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:60 | Replaces the default interface-sprite effect |
Light |
0x00200000 |
2097152 | script.enum-value.EffectType.Light |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:63 | Replaces the primitive effect used for map light accumulation |
None |
0 |
0 | script.enum-value.EffectType.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:53 | Selects no effect category |
Offscreen |
0x40000000 |
1073741824 | script.enum-value.EffectType.Offscreen |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:70 | Registers the effect in an indexed offscreen-effect subtype slot |
Primitive |
0x00100000 |
1048576 | script.enum-value.EffectType.Primitive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:62 | Replaces the default generic primitive effect |
RainSprite |
0x00000010 |
16 | script.enum-value.EffectType.RainSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:58 | Replaces the default rain-sprite effect |
RoofSprite |
0x00000008 |
8 | script.enum-value.EffectType.RoofSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:57 | Replaces the default roof-sprite effect |
SkinnedMesh |
0x00000400 |
1024 | script.enum-value.EffectType.SkinnedMesh |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:59 | Replaces the default skinned-model effect when 3D rendering is enabled |
TileSprite |
0x00000004 |
4 | script.enum-value.EffectType.TileSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/EffectManager.h:56 | Replaces the default flat tile-sprite effect |
EggAppearenceType
enum EggAppearenceType : uint8
Symbol ID: script.enum.EggAppearenceType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/MapSprite.h:87
Conditions under which a map sprite participates in the transparency-egg cutout around the player
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Always |
1 |
1 | script.enum-value.EggAppearenceType.Always |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:91 | Applies a valid transparency-egg mask regardless of relative map hex |
ByX |
2 |
2 | script.enum-value.EggAppearenceType.ByX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:92 | Applies the mask when the sprite hex X is at or beyond the egg hex X |
ByXAndY |
4 |
4 | script.enum-value.EggAppearenceType.ByXAndY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:94 | Applies the mask when either adjusted X or Y is at or beyond the corresponding egg coordinate |
ByXOrY |
5 |
5 | script.enum-value.EggAppearenceType.ByXOrY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:95 | Applies the mask only when both adjusted X and Y are at or beyond the corresponding egg coordinates |
ByY |
3 |
3 | script.enum-value.EggAppearenceType.ByY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:93 | Applies the mask when the sprite hex Y is at or beyond the egg hex Y |
None |
0 |
0 | script.enum-value.EggAppearenceType.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:90 | Never applies a transparency-egg mask to this sprite |
EngineInfoMessage
enum EngineInfoMessage : uint16
Symbol ID: script.enum.EngineInfoMessage
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:410
Stable text-message identifiers for connection, authentication, loading, and runtime status feedback. The generic info-message transport treats them as opaque values; embedding projects own their text and dispatch policy
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
KickedFromGame |
5000 |
5000 | script.enum-value.EngineInfoMessage.KickedFromGame |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:453 | Identifies forced removal of the player from the active game session |
NetBan |
1046 |
1046 | script.enum-value.EngineInfoMessage.NetBan |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:448 | Identifies the primary notification that the player or account has been banned |
NetBanReason |
1047 |
1047 | script.enum-value.EngineInfoMessage.NetBanReason |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:449 | Identifies detailed ban metadata such as issuer, duration, and reason supplied by the project |
NetBanned |
1034 |
1034 | script.enum-value.EngineInfoMessage.NetBanned |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:439 | Identifies an account that is blocked from logging in |
NetBannedIp |
1043 |
1043 | script.enum-value.EngineInfoMessage.NetBannedIp |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:446 | Identifies a connection rejected because its source IP address is blocked |
NetBdError |
1023 |
1023 | script.enum-value.EngineInfoMessage.NetBdError |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:428 | Identifies a backend database failure while processing the requested account or game operation |
NetBeginEndSpaces |
1032 |
1032 | script.enum-value.EngineInfoMessage.NetBeginEndSpaces |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:437 | Identifies a name rejected because it begins or ends with whitespace |
NetConnError |
1008 |
1008 | script.enum-value.EngineInfoMessage.NetConnError |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:420 | Identifies a generic connection error after a connection attempt or active session failure |
NetConnFail |
1018 |
1018 | script.enum-value.EngineInfoMessage.NetConnFail |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:424 | Identifies failure to establish a connection to the game server |
NetConnSuccess |
1010 |
1010 | script.enum-value.EngineInfoMessage.NetConnSuccess |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:421 | Identifies successful transport connection before or during authentication |
NetConnection |
1007 |
1007 | script.enum-value.EngineInfoMessage.NetConnection |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:419 | Identifies the client status while it is initiating a server connection |
NetDataTransErr |
1025 |
1025 | script.enum-value.EngineInfoMessage.NetDataTransErr |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:430 | Identifies an error while transferring or decoding connection data |
NetDifferentLang |
1030 |
1030 | script.enum-value.EngineInfoMessage.NetDifferentLang |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:435 | Identifies a name rejected for mixing characters from different language alphabets |
NetDisconnByDemand |
1013 |
1013 | script.enum-value.EngineInfoMessage.NetDisconnByDemand |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:423 | Identifies a disconnect requested explicitly by the player or client |
NetFailRunStartScript |
1038 |
1038 | script.enum-value.EngineInfoMessage.NetFailRunStartScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:443 | Identifies client startup failure while executing the project's start script |
NetFailToLoadIface |
1037 |
1037 | script.enum-value.EngineInfoMessage.NetFailToLoadIface |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:442 | Identifies client startup failure while loading the user interface |
NetHexesBusy |
1012 |
1012 | script.enum-value.EngineInfoMessage.NetHexesBusy |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:422 | Identifies entry or spawning rejected because the required destination hexes are occupied |
NetKnockKnock |
1041 |
1041 | script.enum-value.EngineInfoMessage.NetKnockKnock |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:445 | Reserves the legacy knock-knock informational slot; embedding scripts define its concrete liveness or status use |
NetLanguageNotSupported |
1039 |
1039 | script.enum-value.EngineInfoMessage.NetLanguageNotSupported |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:444 | Identifies an unsupported selected language and the need to use a project-defined fallback |
NetLoginOk |
1028 |
1028 | script.enum-value.EngineInfoMessage.NetLoginOk |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:433 | Identifies successful authentication and transition to game-state or map loading |
NetLoginScriptFail |
1048 |
1048 | script.enum-value.EngineInfoMessage.NetLoginScriptFail |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:450 | Identifies authentication rejected because a project login script failed |
NetManySymbols |
1031 |
1031 | script.enum-value.EngineInfoMessage.NetManySymbols |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:436 | Identifies a name rejected because too much of it consists of non-letter symbols |
NetNameWrongChars |
1035 |
1035 | script.enum-value.EngineInfoMessage.NetNameWrongChars |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:440 | Identifies a name containing characters forbidden by the project's account policy |
NetNetMsgErr |
1026 |
1026 | script.enum-value.EngineInfoMessage.NetNetMsgErr |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:431 | Identifies a malformed, invalid, or otherwise unacceptable network message |
NetPassWrongChars |
1036 |
1036 | script.enum-value.EngineInfoMessage.NetPassWrongChars |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:441 | Identifies a password containing characters forbidden by the project's account policy |
NetPermanentDeath |
1049 |
1049 | script.enum-value.EngineInfoMessage.NetPermanentDeath |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:451 | Identifies a project-defined permanent-death state that prevents continuing with the affected character or account |
NetPlayerAlready |
1003 |
1003 | script.enum-value.EngineInfoMessage.NetPlayerAlready |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:417 | Identifies account creation rejected because the requested login already exists |
NetPlayerInGame |
1004 |
1004 | script.enum-value.EngineInfoMessage.NetPlayerInGame |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:418 | Identifies login rejected because the account already has an active game session |
NetSetProtoErr |
1027 |
1027 | script.enum-value.EngineInfoMessage.NetSetProtoErr |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:432 | Identifies an internal server failure while assigning or initializing required prototype state |
NetStartCoordFail |
1022 |
1022 | script.enum-value.EngineInfoMessage.NetStartCoordFail |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:427 | Identifies failure to resolve starting map coordinates during player entry or creation |
NetStartLocFail |
1020 |
1020 | script.enum-value.EngineInfoMessage.NetStartLocFail |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:425 | Identifies failure to resolve the starting location during player entry or creation |
NetStartMapFail |
1021 |
1021 | script.enum-value.EngineInfoMessage.NetStartMapFail |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:426 | Identifies failure to resolve the starting map during player entry or creation |
NetTimeLeft |
1045 |
1045 | script.enum-value.EngineInfoMessage.NetTimeLeft |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:447 | Identifies a temporary restriction or session timer whose remaining duration is supplied by project text or extra data |
NetTwoSpace |
1033 |
1033 | script.enum-value.EngineInfoMessage.NetTwoSpace |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:438 | Identifies a name rejected because it contains consecutive spaces |
NetWrongLogin |
1001 |
1001 | script.enum-value.EngineInfoMessage.NetWrongLogin |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:415 | Identifies a login rejection caused by an invalid account or login identifier |
NetWrongNetProto |
1024 |
1024 | script.enum-value.EngineInfoMessage.NetWrongNetProto |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:429 | Identifies a client/server network-protocol version mismatch |
NetWrongPass |
1002 |
1002 | script.enum-value.EngineInfoMessage.NetWrongPass |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:416 | Identifies a login rejection caused by an invalid password or equivalent authentication secret |
NetWrongTagSkill |
1029 |
1029 | script.enum-value.EngineInfoMessage.NetWrongTagSkill |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:434 | Identifies character creation rejected because the required tagged-skill selection is invalid |
None |
0 |
0 | script.enum-value.EngineInfoMessage.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:413 | Selects no conventional engine information-message slot |
ServerLog |
5001 |
5001 | script.enum-value.EngineInfoMessage.ServerLog |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:454 | Identifies a server-log message whose reader-facing payload is carried in extraText |
EventPriority
enum EventPriority : int32
Symbol ID: script.enum.EventPriority
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Entity.h:155
Relative ordering assigned to callbacks subscribed to the same entity event
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
High |
3000000 |
3000000 | script.enum-value.EventPriority.High |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:161 | Runs after the highest callback and before normal-priority callbacks |
Highest |
4000000 |
4000000 | script.enum-value.EventPriority.Highest |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:162 | Runs before callbacks with lower numeric priority; only one callback may occupy the highest band |
Low |
1000000 |
1000000 | script.enum-value.EventPriority.Low |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:159 | Runs after normal-priority callbacks and before the lowest callback |
Lowest |
0 |
0 | script.enum-value.EventPriority.Lowest |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:158 | Runs after callbacks with higher numeric priority; only one callback may occupy the lowest band |
Normal |
2000000 |
2000000 | script.enum-value.EventPriority.Normal |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:160 | Default callback priority between the low and high bands |
EventResult
enum EventResult : int32
Symbol ID: script.enum.EventResult
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Entity.h:145
Controls whether an entity event callback allows lower-priority callbacks to run
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
ContinueChain |
0 |
0 | script.enum-value.EventResult.ContinueChain |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:148 | Continues dispatching callbacks with lower priority |
StopChain |
1 |
1 | script.enum-value.EventResult.StopChain |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:149 | Stops the current event callback chain immediately |
FontFlag
enum FontFlag : uint32
Symbol ID: script.enum.FontFlag
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/FontManager.h:64
Font flags
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AlignBottom |
0x0020 |
32 | script.enum-value.FontFlag.AlignBottom |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:73 | Aligns the text block to the bottom and makes SkipLines count from the trailing lines |
AlignRight |
0x0010 |
16 | script.enum-value.FontFlag.AlignRight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:72 | Right-aligns each rendered line within the target rectangle |
Bordered |
0x0200 |
512 | script.enum-value.FontFlag.Bordered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:77 | Uses the bordered or outlined font-texture variant for glyph rendering |
CenterX |
0x0004 |
4 | script.enum-value.FontFlag.CenterX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:70 | Horizontally centers each rendered line within the target rectangle |
CenterY |
0x0008 |
8 | script.enum-value.FontFlag.CenterY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:71 | Vertically centers the complete text block within the target rectangle |
Justify |
0x0100 |
256 | script.enum-value.FontFlag.Justify |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:76 | Distributes extra spacing between words to fill each line's target width |
KeepTail |
0x0040 |
64 | script.enum-value.FontFlag.KeepTail |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:74 | Renders the tail of a text block that is taller than the target rectangle |
NoColorize |
0x0080 |
128 | script.enum-value.FontFlag.NoColorize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:75 | Removes inline color tags while retaining the supplied base text color |
NoWrap |
0x0001 |
1 | script.enum-value.FontFlag.NoWrap |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:68 | Truncates the remaining text at rectangle-width overflow instead of wrapping it |
None |
0 |
0 | script.enum-value.FontFlag.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:67 | Applies no optional text-layout or glyph-rendering flags |
TruncateLine |
0x0002 |
2 | script.enum-value.FontFlag.TruncateLine |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:69 | Skips overflowing glyphs through the next newline instead of wrapping the current line |
FontType
enum FontType : int32
Symbol ID: script.enum.FontType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/FontManager.h:57
Font slot index. Engine ships a single named slot (Default = 0); scripts may add more entries via the codegen Enum annotation
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Default |
0 |
0 | script.enum-value.FontType.Default |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:60 | Built-in default font slot used when no project-defined slot is selected |
GameProperty
enum GameProperty : uint16
Symbol ID: script.enum.GameProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the Game script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CustomHolderEntry |
2 |
2 | script.enum-value.GameProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.GameProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
ExplicitlyPersistent |
3 |
3 | script.enum-value.GameProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
FrameDeltaTime |
8 |
8 | script.enum-value.GameProperty.FrameDeltaTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:66 | Elapsed monotonic time between the current and previous frame advances |
FrameTime |
7 |
7 | script.enum-value.GameProperty.FrameTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:63 | Monotonic engine time captured for the current frame |
FramesPerSecond |
9 |
9 | script.enum-value.GameProperty.FramesPerSecond |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:69 | Frame count measured during the most recently completed one-second sampling interval |
GlobalDayTime |
11 |
11 | script.enum-value.GameProperty.GlobalDayTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:75 | Current position of the global day-light cycle, measured in minutes and controlled by game scripts |
HistoryRecordsId |
6 |
6 | script.enum-value.GameProperty.HistoryRecordsId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:60 | Persistent high-water mark used to allocate server history-record identifiers |
LastEntityId |
5 |
5 | script.enum-value.GameProperty.LastEntityId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:57 | Persistent high-water mark used to allocate durable entity identifiers |
LastGlobalMapTripId |
10 |
10 | script.enum-value.GameProperty.LastGlobalMapTripId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:72 | Last server-assigned identifier for a global-map trip |
None |
0 |
0 | script.enum-value.GameProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no Game property identifier is selected. |
SynchronizedTime |
4 |
4 | script.enum-value.GameProperty.SynchronizedTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:54 | Current synchronized game time shared by the server and clients and persisted by the server |
ImGuiProperty
enum ImGuiProperty : uint16
Symbol ID: script.enum.ImGuiProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the ImGui script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CustomHolderEntry |
2 |
2 | script.enum-value.ImGuiProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.ImGuiProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
ExplicitlyPersistent |
3 |
3 | script.enum-value.ImGuiProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
None |
0 |
0 | script.enum-value.ImGuiProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no ImGui property identifier is selected. |
ImGui_ButtonFlags
enum ImGui_ButtonFlags : uint32
Symbol ID: script.enum.ImGui_ButtonFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:404
Mouse-button, overlap, and activation behavior for low-level Dear ImGui buttons
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
EnableNav |
8 |
8 | script.enum-value.ImGui_ButtonFlags.EnableNav |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:411 | InvisibleButton(): do not disable navigation/tabbing. Otherwise disabled by default |
MouseButtonLeft |
1 |
1 | script.enum-value.ImGui_ButtonFlags.MouseButtonLeft |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:408 | React on left mouse button (default) |
MouseButtonMiddle |
4 |
4 | script.enum-value.ImGui_ButtonFlags.MouseButtonMiddle |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:410 | React on center mouse button |
MouseButtonRight |
2 |
2 | script.enum-value.ImGui_ButtonFlags.MouseButtonRight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:409 | React on right mouse button |
None |
0 |
0 | script.enum-value.ImGui_ButtonFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:407 | Applies no optional low-level button behavior flags |
ImGui_ChildFlags
enum ImGui_ChildFlags : uint32
Symbol ID: script.enum.ImGui_ChildFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:103
Child-window sizing, framing, padding, and navigation flags forwarded to Dear ImGui
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AlwaysAutoResize |
64 |
64 | script.enum-value.ImGui_ChildFlags.AlwaysAutoResize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:113 | With automatic sizing enabled, measures hidden content, always reports the child as visible, and disables clipping optimization; this expensive mode is not recommended for routine use |
AlwaysUseWindowPadding |
2 |
2 | script.enum-value.ImGui_ChildFlags.AlwaysUseWindowPadding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:108 | Uses style.WindowPadding even when the child window has no border |
AutoResizeX |
16 |
16 | script.enum-value.ImGui_ChildFlags.AutoResizeX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:111 | Derives the child-window width from its measured content |
AutoResizeY |
32 |
32 | script.enum-value.ImGui_ChildFlags.AutoResizeY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:112 | Derives the child-window height from its measured content |
Border |
1 |
1 | script.enum-value.ImGui_ChildFlags.Border |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:107 | Draws an outer border and enables the child window's standard window padding |
FrameStyle |
128 |
128 | script.enum-value.ImGui_ChildFlags.FrameStyle |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:114 | Styles the child window as a framed item by using frame colors, rounding, border size, and padding |
NavFlattened |
256 |
256 | script.enum-value.ImGui_ChildFlags.NavFlattened |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:115 | Beta behavior that shares focus scope and allows keyboard or gamepad navigation across the parent border and sibling child windows |
None |
0 |
0 | script.enum-value.ImGui_ChildFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:106 | Applies no optional child-window behavior flags |
ResizeX |
4 |
4 | script.enum-value.ImGui_ChildFlags.ResizeX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:109 | Allows resizing from the right layout border and persists the width unless window settings are disabled |
ResizeY |
8 |
8 | script.enum-value.ImGui_ChildFlags.ResizeY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:110 | Allows resizing from the bottom layout border and persists the height unless window settings are disabled |
ImGui_Col
enum ImGui_Col : int32
Symbol ID: script.enum.ImGui_Col
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:447
Indexed Dear ImGui style-color slots used by scripted theme customization
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Border |
5 |
5 | script.enum-value.ImGui_Col.Border |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:455 | Selects the border color slot for windows, child windows, popups, and framed widgets |
Button |
22 |
22 | script.enum-value.ImGui_Col.Button |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:467 | Selects the normal button color slot |
ButtonActive |
24 |
24 | script.enum-value.ImGui_Col.ButtonActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:469 | Selects the active button color slot |
ButtonHovered |
23 |
23 | script.enum-value.ImGui_Col.ButtonHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:468 | Selects the hovered button color slot |
CheckMark |
18 |
18 | script.enum-value.ImGui_Col.CheckMark |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:464 | Checkbox tick and RadioButton circle |
ChildBg |
3 |
3 | script.enum-value.ImGui_Col.ChildBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:453 | Background of child windows |
FrameBg |
7 |
7 | script.enum-value.ImGui_Col.FrameBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:456 | Background of checkbox, radio button, plot, slider, text input |
FrameBgActive |
9 |
9 | script.enum-value.ImGui_Col.FrameBgActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:458 | Selects the frame background color slot while the frame is active |
FrameBgHovered |
8 |
8 | script.enum-value.ImGui_Col.FrameBgHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:457 | Selects the frame background color slot while the frame is hovered |
Header |
25 |
25 | script.enum-value.ImGui_Col.Header |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:470 | Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem |
HeaderActive |
27 |
27 | script.enum-value.ImGui_Col.HeaderActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:472 | Selects the active header color slot used by headers, tree nodes, and selectables |
HeaderHovered |
26 |
26 | script.enum-value.ImGui_Col.HeaderHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:471 | Selects the hovered header color slot used by headers, tree nodes, and selectables |
MenuBarBg |
13 |
13 | script.enum-value.ImGui_Col.MenuBarBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:461 | Selects the menu-bar background color slot |
PopupBg |
4 |
4 | script.enum-value.ImGui_Col.PopupBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:454 | Background of popups, menus, tooltips windows |
ResizeGrip |
31 |
31 | script.enum-value.ImGui_Col.ResizeGrip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:476 | Resize grip in lower-right and lower-left corners of windows |
ResizeGripActive |
33 |
33 | script.enum-value.ImGui_Col.ResizeGripActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:478 | Selects the active resize-grip color slot |
ResizeGripHovered |
32 |
32 | script.enum-value.ImGui_Col.ResizeGripHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:477 | Selects the hovered resize-grip color slot |
ScrollbarBg |
14 |
14 | script.enum-value.ImGui_Col.ScrollbarBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:462 | Selects the scrollbar-track background color slot |
ScrollbarGrab |
15 |
15 | script.enum-value.ImGui_Col.ScrollbarGrab |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:463 | Selects the normal scrollbar-grab color slot |
Separator |
28 |
28 | script.enum-value.ImGui_Col.Separator |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:473 | Selects the normal separator color slot |
SeparatorActive |
30 |
30 | script.enum-value.ImGui_Col.SeparatorActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:475 | Selects the active separator color slot |
SeparatorHovered |
29 |
29 | script.enum-value.ImGui_Col.SeparatorHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:474 | Selects the hovered separator color slot |
SliderGrab |
20 |
20 | script.enum-value.ImGui_Col.SliderGrab |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:465 | Selects the normal slider-grab color slot |
SliderGrabActive |
21 |
21 | script.enum-value.ImGui_Col.SliderGrabActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:466 | Selects the active slider-grab color slot |
Tab |
36 |
36 | script.enum-value.ImGui_Col.Tab |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:479 | Tab background, when tab-bar is focused & tab is unselected |
TabDimmed |
39 |
39 | script.enum-value.ImGui_Col.TabDimmed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:482 | Tab background, when tab-bar is unfocused & tab is unselected |
TabDimmedSelected |
40 |
40 | script.enum-value.ImGui_Col.TabDimmedSelected |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:483 | Tab background, when tab-bar is unfocused & tab is selected |
TabHovered |
35 |
35 | script.enum-value.ImGui_Col.TabHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:480 | Tab background, when hovered |
TabSelected |
37 |
37 | script.enum-value.ImGui_Col.TabSelected |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:481 | Tab background, when tab-bar is focused & tab is selected |
TableHeaderBg |
46 |
46 | script.enum-value.ImGui_Col.TableHeaderBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:484 | Table header background |
TableRowBg |
49 |
49 | script.enum-value.ImGui_Col.TableRowBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:485 | Table row background (even rows) |
TableRowBgAlt |
50 |
50 | script.enum-value.ImGui_Col.TableRowBgAlt |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:486 | Table row background (odd rows) |
Text |
0 |
0 | script.enum-value.ImGui_Col.Text |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:450 | Selects the primary text color slot |
TextDisabled |
1 |
1 | script.enum-value.ImGui_Col.TextDisabled |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:451 | Selects the disabled-text color slot |
TitleBg |
10 |
10 | script.enum-value.ImGui_Col.TitleBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:459 | Title bar |
TitleBgActive |
11 |
11 | script.enum-value.ImGui_Col.TitleBgActive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:460 | Title bar when focused |
WindowBg |
2 |
2 | script.enum-value.ImGui_Col.WindowBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:452 | Background of normal windows |
ImGui_ColorEditFlags
enum ImGui_ColorEditFlags : uint32
Symbol ID: script.enum.ImGui_ColorEditFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:415
Picker mode, channel visibility, data format, preview, and input behavior for Dear ImGui color editors
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AlphaBar |
262144 |
262144 | script.enum-value.ImGui_ColorEditFlags.AlphaBar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:432 | ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker |
AlphaNoBg |
8192 |
8192 | script.enum-value.ImGui_ColorEditFlags.AlphaNoBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:430 | ColorEdit, ColorPicker, ColorButton: disable rendering a checkerboard background behind transparent color |
AlphaOpaque |
4096 |
4096 | script.enum-value.ImGui_ColorEditFlags.AlphaOpaque |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:429 | Hides alpha in the preview while still allowing ColorEdit4 and ColorPicker4 to edit it; for ColorButton this is equivalent to NoAlpha |
AlphaPreviewHalf |
16384 |
16384 | script.enum-value.ImGui_ColorEditFlags.AlphaPreviewHalf |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:431 | ColorEdit, ColorPicker, ColorButton: display half opaque / half transparent preview |
DefaultOptions |
311427072 |
311427072 | script.enum-value.ImGui_ColorEditFlags.DefaultOptions |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:443 | Selects 8-bit RGB display and input with the hue-bar picker as the default color-editor options |
DisplayHSV |
2097152 |
2097152 | script.enum-value.ImGui_ColorEditFlags.DisplayHSV |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:435 | Displays and edits color components in HSV form |
DisplayHex |
4194304 |
4194304 | script.enum-value.ImGui_ColorEditFlags.DisplayHex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:436 | Displays and edits the color as a hexadecimal value |
DisplayRGB |
1048576 |
1048576 | script.enum-value.ImGui_ColorEditFlags.DisplayRGB |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:434 | ColorEdit: override display type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex |
Float |
16777216 |
16777216 | script.enum-value.ImGui_ColorEditFlags.Float |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:438 | ColorEdit, ColorPicker, ColorButton: display values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers |
HDR |
524288 |
524288 | script.enum-value.ImGui_ColorEditFlags.HDR |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:433 | (WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well) |
InputHSV |
536870912 |
536870912 | script.enum-value.ImGui_ColorEditFlags.InputHSV |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:442 | ColorEdit, ColorPicker: input and output data in HSV format |
InputRGB |
268435456 |
268435456 | script.enum-value.ImGui_ColorEditFlags.InputRGB |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:441 | ColorEdit, ColorPicker: input and output data in RGB format |
NoAlpha |
2 |
2 | script.enum-value.ImGui_ColorEditFlags.NoAlpha |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:419 | ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer) |
NoBorder |
1024 |
1024 | script.enum-value.ImGui_ColorEditFlags.NoBorder |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:428 | ColorButton: disable border (which is enforced by default) |
NoDragDrop |
512 |
512 | script.enum-value.ImGui_ColorEditFlags.NoDragDrop |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:427 | ColorEdit: disable drag and drop target/source. ColorButton: disable drag and drop source |
NoInputs |
32 |
32 | script.enum-value.ImGui_ColorEditFlags.NoInputs |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:423 | ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square) |
NoLabel |
128 |
128 | script.enum-value.ImGui_ColorEditFlags.NoLabel |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:425 | ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker) |
NoOptions |
8 |
8 | script.enum-value.ImGui_ColorEditFlags.NoOptions |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:421 | ColorEdit: disable toggling options menu when right-clicking on inputs/small preview |
NoPicker |
4 |
4 | script.enum-value.ImGui_ColorEditFlags.NoPicker |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:420 | ColorEdit: disable picker when clicking on color square |
NoSidePreview |
256 |
256 | script.enum-value.ImGui_ColorEditFlags.NoSidePreview |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:426 | ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead |
NoSmallPreview |
16 |
16 | script.enum-value.ImGui_ColorEditFlags.NoSmallPreview |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:422 | ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs) |
NoTooltip |
64 |
64 | script.enum-value.ImGui_ColorEditFlags.NoTooltip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:424 | ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview |
None |
0 |
0 | script.enum-value.ImGui_ColorEditFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:418 | Applies no optional color-editor behavior flags |
PickerHueBar |
33554432 |
33554432 | script.enum-value.ImGui_ColorEditFlags.PickerHueBar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:439 | ColorPicker: bar for Hue, rectangle for Sat/Value |
PickerHueWheel |
67108864 |
67108864 | script.enum-value.ImGui_ColorEditFlags.PickerHueWheel |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:440 | ColorPicker: wheel for Hue, triangle for Sat/Value |
Uint8 |
8388608 |
8388608 | script.enum-value.ImGui_ColorEditFlags.Uint8 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:437 | ColorEdit, ColorPicker, ColorButton: display values formatted as 0..255 |
ImGui_ComboFlags
enum ImGui_ComboFlags : uint32
Symbol ID: script.enum.ImGui_ComboFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:320
Popup height, alignment, and preview behavior for Dear ImGui combo boxes
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
HeightLarge |
8 |
8 | script.enum-value.ImGui_ComboFlags.HeightLarge |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:327 | Max ~20 items visible |
HeightLargest |
16 |
16 | script.enum-value.ImGui_ComboFlags.HeightLargest |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:328 | As many fitting items as possible |
HeightRegular |
4 |
4 | script.enum-value.ImGui_ComboFlags.HeightRegular |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:326 | Max ~8 items visible (default) |
HeightSmall |
2 |
2 | script.enum-value.ImGui_ComboFlags.HeightSmall |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:325 | Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo() |
NoArrowButton |
32 |
32 | script.enum-value.ImGui_ComboFlags.NoArrowButton |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:329 | Display on the preview box without the square arrow button |
NoPreview |
64 |
64 | script.enum-value.ImGui_ComboFlags.NoPreview |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:330 | Display only a square arrow button |
None |
0 |
0 | script.enum-value.ImGui_ComboFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:323 | Applies no optional combo-box behavior flags |
PopupAlignLeft |
1 |
1 | script.enum-value.ImGui_ComboFlags.PopupAlignLeft |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:324 | Align the popup toward the left by default |
WidthFitPreview |
128 |
128 | script.enum-value.ImGui_ComboFlags.WidthFitPreview |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:331 | Width dynamically calculated from preview contents |
ImGui_Cond
enum ImGui_Cond : uint32
Symbol ID: script.enum.ImGui_Cond
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:119
Conditions controlling when a queued Dear ImGui state assignment takes effect
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Always |
1 |
1 | script.enum-value.ImGui_Cond.Always |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:123 | No condition (always set the variable), same as _None |
Appearing |
8 |
8 | script.enum-value.ImGui_Cond.Appearing |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:126 | Set the variable if the object/window is appearing after being hidden/inactive (or the first time) |
FirstUseEver |
4 |
4 | script.enum-value.ImGui_Cond.FirstUseEver |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:125 | Set the variable if the object/window has no persistently saved data (no entry in .ini file) |
None |
0 |
0 | script.enum-value.ImGui_Cond.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:122 | No condition (always set the variable), same as _Always |
Once |
2 |
2 | script.enum-value.ImGui_Cond.Once |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:124 | Set the variable once per runtime session (only the first call will succeed) |
ImGui_Dir
enum ImGui_Dir : int32
Symbol ID: script.enum.ImGui_Dir
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:378
Cardinal directions and the no-direction sentinel used by Dear ImGui navigation and layout APIs
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Down |
3 |
3 | script.enum-value.ImGui_Dir.Down |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:385 | Selects the downward cardinal direction |
Left |
0 |
0 | script.enum-value.ImGui_Dir.Left |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:382 | Selects the left cardinal direction |
None |
-1 |
-1 | script.enum-value.ImGui_Dir.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:381 | Indicates that no cardinal direction is selected |
Right |
1 |
1 | script.enum-value.ImGui_Dir.Right |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:383 | Selects the right cardinal direction |
Up |
2 |
2 | script.enum-value.ImGui_Dir.Up |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:384 | Selects the upward cardinal direction |
ImGui_FocusedFlags
enum ImGui_FocusedFlags : uint32
Symbol ID: script.enum.ImGui_FocusedFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:165
Scope and hierarchy filters used by Dear ImGui focus queries
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AnyWindow |
4 |
4 | script.enum-value.ImGui_FocusedFlags.AnyWindow |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:171 | Return true if any window is focused. Important: If you are trying to tell how to dispatch your low-level inputs, do NOT use this. Use 'io.WantCaptureMouse' instead! Please read the FAQ! |
ChildWindows |
1 |
1 | script.enum-value.ImGui_FocusedFlags.ChildWindows |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:169 | Return true if any children of the window is focused |
NoPopupHierarchy |
8 |
8 | script.enum-value.ImGui_FocusedFlags.NoPopupHierarchy |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:172 | Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow) |
None |
0 |
0 | script.enum-value.ImGui_FocusedFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:168 | Tests focus only for the current window without expanding the query scope |
RootAndChildWindows |
3 |
3 | script.enum-value.ImGui_FocusedFlags.RootAndChildWindows |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:173 | Tests the root window and all of its child windows for focus |
RootWindow |
2 |
2 | script.enum-value.ImGui_FocusedFlags.RootWindow |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:170 | Test from root window (top most parent of the current hierarchy) |
ImGui_HoveredFlags
enum ImGui_HoveredFlags : uint32
Symbol ID: script.enum.ImGui_HoveredFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:177
Blocking, overlap, timing, and hierarchy filters used by Dear ImGui hover queries
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AllowWhenBlockedByActiveItem |
128 |
128 | script.enum-value.ImGui_HoveredFlags.AllowWhenBlockedByActiveItem |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:186 | Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns |
AllowWhenBlockedByPopup |
32 |
32 | script.enum-value.ImGui_HoveredFlags.AllowWhenBlockedByPopup |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:185 | Return true even if a popup window is normally blocking access to this item/window |
AllowWhenDisabled |
1024 |
1024 | script.enum-value.ImGui_HoveredFlags.AllowWhenDisabled |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:189 | IsItemHovered() only: Return true even if the item is disabled |
AllowWhenOverlapped |
768 |
768 | script.enum-value.ImGui_HoveredFlags.AllowWhenOverlapped |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:191 | Allows a hover result when another item or window overlaps the tested rectangle |
AllowWhenOverlappedByItem |
256 |
256 | script.enum-value.ImGui_HoveredFlags.AllowWhenOverlappedByItem |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:187 | IsItemHovered() only: Return true even if the item uses AllowOverlap mode and is overlapped by another hoverable item |
AllowWhenOverlappedByWindow |
512 |
512 | script.enum-value.ImGui_HoveredFlags.AllowWhenOverlappedByWindow |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:188 | IsItemHovered() only: Return true even if the position is obstructed or overlapped by another window |
AnyWindow |
4 |
4 | script.enum-value.ImGui_HoveredFlags.AnyWindow |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:183 | IsWindowHovered() only: Return true if any window is hovered |
ChildWindows |
1 |
1 | script.enum-value.ImGui_HoveredFlags.ChildWindows |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:181 | IsWindowHovered() only: Return true if any children of the window is hovered |
ForTooltip |
4096 |
4096 | script.enum-value.ImGui_HoveredFlags.ForTooltip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:193 | Shortcut for standard flags when using IsItemHovered() + SetTooltip() sequence |
NoNavOverride |
2048 |
2048 | script.enum-value.ImGui_HoveredFlags.NoNavOverride |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:190 | IsItemHovered() only: Disable using keyboard/gamepad navigation state when active, always query mouse |
NoPopupHierarchy |
8 |
8 | script.enum-value.ImGui_HoveredFlags.NoPopupHierarchy |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:184 | IsWindowHovered() only: Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow) |
None |
0 |
0 | script.enum-value.ImGui_HoveredFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:180 | Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them |
RectOnly |
928 |
928 | script.enum-value.ImGui_HoveredFlags.RectOnly |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:192 | Uses the item or window rectangle while ignoring popup, active-item, and overlap blocking |
RootWindow |
2 |
2 | script.enum-value.ImGui_HoveredFlags.RootWindow |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:182 | IsWindowHovered() only: Test from root window (top most parent of the current hierarchy) |
ImGui_InputTextFlags
enum ImGui_InputTextFlags : uint32
Symbol ID: script.enum.ImGui_InputTextFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:335
Editing, filtering, submission, callback, and read-only behavior for Dear ImGui text input
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AutoSelectAll |
4096 |
4096 | script.enum-value.ImGui_InputTextFlags.AutoSelectAll |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:347 | Select entire text when first taking mouse focus |
CharsDecimal |
1 |
1 | script.enum-value.ImGui_InputTextFlags.CharsDecimal |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:339 | Allow 0123456789.+-*/ |
CharsHexadecimal |
2 |
2 | script.enum-value.ImGui_InputTextFlags.CharsHexadecimal |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:340 | Allow 0123456789ABCDEFabcdef |
CharsNoBlank |
16 |
16 | script.enum-value.ImGui_InputTextFlags.CharsNoBlank |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:343 | Filter out spaces, tabs |
CharsScientific |
4 |
4 | script.enum-value.ImGui_InputTextFlags.CharsScientific |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:341 | Allow 0123456789.+-*/eE (Scientific notation input) |
CharsUppercase |
8 |
8 | script.enum-value.ImGui_InputTextFlags.CharsUppercase |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:342 | Turn a..z into A..Z |
DisplayEmptyRefVal |
16384 |
16384 | script.enum-value.ImGui_InputTextFlags.DisplayEmptyRefVal |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:349 | InputFloat(), InputInt(), InputScalar() etc. only: when value is zero, do not display it. Generally used with ImGuiInputTextFlags_ParseEmptyRefVal |
EnterReturnsTrue |
64 |
64 | script.enum-value.ImGui_InputTextFlags.EnterReturnsTrue |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:344 | Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider disabling LiveEdit! or using IsItemDeactivatedAfterEdit() instead! |
None |
0 |
0 | script.enum-value.ImGui_InputTextFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:338 | Applies no optional text-input behavior flags |
ParseEmptyRefVal |
8192 |
8192 | script.enum-value.ImGui_InputTextFlags.ParseEmptyRefVal |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:348 | InputFloat(), InputInt(), InputScalar() etc. only: parse empty string as zero value |
Password |
1024 |
1024 | script.enum-value.ImGui_InputTextFlags.Password |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:346 | Password mode, display all characters as '*', disable copy |
ReadOnly |
512 |
512 | script.enum-value.ImGui_InputTextFlags.ReadOnly |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:345 | Read-only mode |
ImGui_MouseButton
enum ImGui_MouseButton : int32
Symbol ID: script.enum.ImGui_MouseButton
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:369
Mouse-button identifiers accepted by the Dear ImGui script bindings
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Left |
0 |
0 | script.enum-value.ImGui_MouseButton.Left |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:372 | Identifies the left mouse button |
Middle |
2 |
2 | script.enum-value.ImGui_MouseButton.Middle |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:374 | Identifies the middle mouse button |
Right |
1 |
1 | script.enum-value.ImGui_MouseButton.Right |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:373 | Identifies the right mouse button |
ImGui_PopupFlags
enum ImGui_PopupFlags : uint32
Symbol ID: script.enum.ImGui_PopupFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:353
Mouse-button selection and popup-stack policies for opening or closing Dear ImGui popups
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AnyPopup |
3072 |
3072 | script.enum-value.ImGui_PopupFlags.AnyPopup |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:365 | Tests any popup identifier at any level of the popup stack |
AnyPopupId |
1024 |
1024 | script.enum-value.ImGui_PopupFlags.AnyPopupId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:363 | For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup |
AnyPopupLevel |
2048 |
2048 | script.enum-value.ImGui_PopupFlags.AnyPopupLevel |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:364 | For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level) |
MouseButtonLeft |
4 |
4 | script.enum-value.ImGui_PopupFlags.MouseButtonLeft |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:357 | For BeginPopupContext*(): open on Left Mouse release. Only one button allowed! |
MouseButtonMiddle |
12 |
12 | script.enum-value.ImGui_PopupFlags.MouseButtonMiddle |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:359 | For BeginPopupContext*(): open on Middle Mouse release. Only one button allowed! |
MouseButtonRight |
8 |
8 | script.enum-value.ImGui_PopupFlags.MouseButtonRight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:358 | For BeginPopupContext*(): open on Right Mouse release. Only one button allowed! (default) |
NoOpenOverExistingPopup |
128 |
128 | script.enum-value.ImGui_PopupFlags.NoOpenOverExistingPopup |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:361 | For OpenPopup(), BeginPopupContext(): don't open if there's already a popup at the same level of the popup stack |
NoOpenOverItems |
256 |
256 | script.enum-value.ImGui_PopupFlags.NoOpenOverItems |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:362 | For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space |
NoReopen |
32 |
32 | script.enum-value.ImGui_PopupFlags.NoReopen |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:360 | For OpenPopup(), BeginPopupContext(): don't reopen same popup if already open (won't reposition, won't reinitialize navigation) |
None |
0 |
0 | script.enum-value.ImGui_PopupFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:356 | Applies the default popup mouse-button and stack-level behavior |
ImGui_SelectableFlags
enum ImGui_SelectableFlags : uint32
Symbol ID: script.enum.ImGui_SelectableFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:130
Selection, spanning, overlap, and activation behavior for Dear ImGui selectable items
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AllowDoubleClick |
4 |
4 | script.enum-value.ImGui_SelectableFlags.AllowDoubleClick |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:136 | Generate press events on double clicks too |
AllowOverlap |
16 |
16 | script.enum-value.ImGui_SelectableFlags.AllowOverlap |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:138 | Hit testing will allow subsequent widgets to overlap this one. Require previous frame HoveredId to match before being usable. Shortcut to calling SetNextItemAllowOverlap() |
Disabled |
8 |
8 | script.enum-value.ImGui_SelectableFlags.Disabled |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:137 | Cannot be selected, display grayed out text |
NoAutoClosePopups |
1 |
1 | script.enum-value.ImGui_SelectableFlags.NoAutoClosePopups |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:134 | Clicking this doesn't close parent popup window (overrides ImGuiItemFlags_AutoClosePopups) |
None |
0 |
0 | script.enum-value.ImGui_SelectableFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:133 | Applies no optional selectable-item behavior flags |
SpanAllColumns |
2 |
2 | script.enum-value.ImGui_SelectableFlags.SpanAllColumns |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:135 | Frame will span all columns of its container table (text will still fit in current column) |
ImGui_SliderFlags
enum ImGui_SliderFlags : uint32
Symbol ID: script.enum.ImGui_SliderFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:389
Clamping and input behavior for Dear ImGui sliders and drag controls
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AlwaysClamp |
1536 |
1536 | script.enum-value.ImGui_SliderFlags.AlwaysClamp |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:400 | Clamps manual input and also clamps a zero-width range where minimum and maximum are both zero |
ClampOnInput |
512 |
512 | script.enum-value.ImGui_SliderFlags.ClampOnInput |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:397 | Clamp value to min/max bounds when input manually with Ctrl+Click. By default Ctrl+Click allows going out of bounds |
ClampZeroRange |
1024 |
1024 | script.enum-value.ImGui_SliderFlags.ClampZeroRange |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:398 | Clamp even if min==max==0.0f. Otherwise due to legacy reason DragXXX functions don't clamp with those values. When your clamping limits are dynamic you almost always want to use it |
Logarithmic |
32 |
32 | script.enum-value.ImGui_SliderFlags.Logarithmic |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:393 | Make the widget logarithmic (linear otherwise). Consider using ImGuiSliderFlags_NoRoundToFormat with this if using a format-string with small amount of digits |
NoInput |
128 |
128 | script.enum-value.ImGui_SliderFlags.NoInput |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:395 | Disable Ctrl+Click or Enter key allowing to input text directly into the widget |
NoRoundToFormat |
64 |
64 | script.enum-value.ImGui_SliderFlags.NoRoundToFormat |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:394 | Disable rounding underlying value to match precision of the display format string (e.g. %.3f values are rounded to those 3 digits) |
NoSpeedTweaks |
2048 |
2048 | script.enum-value.ImGui_SliderFlags.NoSpeedTweaks |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:399 | Disable keyboard modifiers altering tweak speed. Useful if you want to alter tweak speed yourself based on your own logic |
None |
0 |
0 | script.enum-value.ImGui_SliderFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:392 | Applies no optional slider or drag-control behavior flags |
WrapAround |
256 |
256 | script.enum-value.ImGui_SliderFlags.WrapAround |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:396 | Enable wrapping around from max to min and from min to max. Only supported by DragXXX() functions for now |
ImGui_StyleVar
enum ImGui_StyleVar : int32
Symbol ID: script.enum.ImGui_StyleVar
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:490
Indexed scalar and vector Dear ImGui style variables accepted by style-stack operations
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Alpha |
0 |
0 | script.enum-value.ImGui_StyleVar.Alpha |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:493 | Global alpha applies to everything in Dear ImGui |
ButtonTextAlign |
38 |
38 | script.enum-value.ImGui_StyleVar.ButtonTextAlign |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:510 | Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered) |
CellPadding |
17 |
17 | script.enum-value.ImGui_StyleVar.CellPadding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:504 | Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows |
DisabledAlpha |
1 |
1 | script.enum-value.ImGui_StyleVar.DisabledAlpha |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:494 | Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha |
FrameBorderSize |
13 |
13 | script.enum-value.ImGui_StyleVar.FrameBorderSize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:500 | Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly) |
FramePadding |
11 |
11 | script.enum-value.ImGui_StyleVar.FramePadding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:498 | Padding within a framed rectangle (used by most widgets) |
FrameRounding |
12 |
12 | script.enum-value.ImGui_StyleVar.FrameRounding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:499 | Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets) |
GrabMinSize |
21 |
21 | script.enum-value.ImGui_StyleVar.GrabMinSize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:507 | Minimum width/height of a grab box for slider/scrollbar |
GrabRounding |
22 |
22 | script.enum-value.ImGui_StyleVar.GrabRounding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:508 | Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs |
IndentSpacing |
16 |
16 | script.enum-value.ImGui_StyleVar.IndentSpacing |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:503 | Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2) |
ItemInnerSpacing |
15 |
15 | script.enum-value.ImGui_StyleVar.ItemInnerSpacing |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:502 | Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label) |
ItemSpacing |
14 |
14 | script.enum-value.ImGui_StyleVar.ItemSpacing |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:501 | Horizontal and vertical spacing between widgets/lines |
ScrollbarRounding |
19 |
19 | script.enum-value.ImGui_StyleVar.ScrollbarRounding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:506 | Radius of grab corners for scrollbar |
ScrollbarSize |
18 |
18 | script.enum-value.ImGui_StyleVar.ScrollbarSize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:505 | Width of the vertical scrollbar, Height of the horizontal scrollbar |
SelectableTextAlign |
39 |
39 | script.enum-value.ImGui_StyleVar.SelectableTextAlign |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:511 | Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line |
TabRounding |
25 |
25 | script.enum-value.ImGui_StyleVar.TabRounding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:509 | Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs |
WindowBorderSize |
4 |
4 | script.enum-value.ImGui_StyleVar.WindowBorderSize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:497 | Thickness of border around windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly) |
WindowPadding |
2 |
2 | script.enum-value.ImGui_StyleVar.WindowPadding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:495 | Padding within a window |
WindowRounding |
3 |
3 | script.enum-value.ImGui_StyleVar.WindowRounding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:496 | Radius of window corners rounding. Set to 0.0f to have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended |
ImGui_TabBarFlags
enum ImGui_TabBarFlags : uint32
Symbol ID: script.enum.ImGui_TabBarFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:287
Reordering, fitting, selection, and tooltip behavior for Dear ImGui tab bars
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AutoSelectNewTabs |
2 |
2 | script.enum-value.ImGui_TabBarFlags.AutoSelectNewTabs |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:292 | Automatically select new tabs when they appear |
DrawSelectedOverline |
64 |
64 | script.enum-value.ImGui_TabBarFlags.DrawSelectedOverline |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:297 | Draw selected overline markers over selected tab |
FittingPolicyMixed |
128 |
128 | script.enum-value.ImGui_TabBarFlags.FittingPolicyMixed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:298 | Shrink down tabs when they don't fit, until width is style.TabMinWidthShrink, then enable scrolling. Setting TabMinWidthShrink to FLT_MAX makes this behave like ImGuiTabBarFlags_FittingPolicyScroll |
FittingPolicyScroll |
512 |
512 | script.enum-value.ImGui_TabBarFlags.FittingPolicyScroll |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:300 | Enable scrolling buttons when tabs don't fit |
FittingPolicyShrink |
256 |
256 | script.enum-value.ImGui_TabBarFlags.FittingPolicyShrink |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:299 | Shrink down tabs when they don't fit |
NoCloseWithMiddleMouseButton |
8 |
8 | script.enum-value.ImGui_TabBarFlags.NoCloseWithMiddleMouseButton |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:294 | Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false |
NoTabListScrollingButtons |
16 |
16 | script.enum-value.ImGui_TabBarFlags.NoTabListScrollingButtons |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:295 | Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll) |
NoTooltip |
32 |
32 | script.enum-value.ImGui_TabBarFlags.NoTooltip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:296 | Disable tooltips when hovering a tab |
None |
0 |
0 | script.enum-value.ImGui_TabBarFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:290 | Applies no optional tab-bar behavior flags |
Reorderable |
1 |
1 | script.enum-value.ImGui_TabBarFlags.Reorderable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:291 | Allow manually dragging tabs to re-order them + New tabs are appended at the end of list |
TabListPopupButton |
4 |
4 | script.enum-value.ImGui_TabBarFlags.TabListPopupButton |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:293 | Shows a button that opens the tab-list popup and lets the user select a tab |
ImGui_TabItemFlags
enum ImGui_TabItemFlags : uint32
Symbol ID: script.enum.ImGui_TabItemFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:304
Visibility, closure, ordering, and tooltip behavior for individual Dear ImGui tabs
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Leading |
64 |
64 | script.enum-value.ImGui_TabItemFlags.Leading |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:314 | Enforce the tab position to the left of the tab bar (after the tab list popup button) |
NoAssumedClosure |
256 |
256 | script.enum-value.ImGui_TabItemFlags.NoAssumedClosure |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:316 | Tab is selected when trying to close + closure is not immediately assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar |
NoCloseWithMiddleMouseButton |
4 |
4 | script.enum-value.ImGui_TabItemFlags.NoCloseWithMiddleMouseButton |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:310 | Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false |
NoPushId |
8 |
8 | script.enum-value.ImGui_TabItemFlags.NoPushId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:311 | Don't call PushID()/PopID() on BeginTabItem()/EndTabItem() |
NoReorder |
32 |
32 | script.enum-value.ImGui_TabItemFlags.NoReorder |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:313 | Disable reordering this tab or having another tab cross over this tab |
NoTooltip |
16 |
16 | script.enum-value.ImGui_TabItemFlags.NoTooltip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:312 | Disable tooltip for the given tab |
None |
0 |
0 | script.enum-value.ImGui_TabItemFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:307 | Applies no optional tab-item behavior flags |
SetSelected |
2 |
2 | script.enum-value.ImGui_TabItemFlags.SetSelected |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:309 | Trigger flag to programmatically make the tab selected when calling BeginTabItem() |
Trailing |
128 |
128 | script.enum-value.ImGui_TabItemFlags.Trailing |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:315 | Enforce the tab position to the right of the tab bar (before the scrolling buttons) |
UnsavedDocument |
1 |
1 | script.enum-value.ImGui_TabItemFlags.UnsavedDocument |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:308 | Display a dot next to the title + set ImGuiTabItemFlags_NoAssumedClosure |
ImGui_TableBgTarget
enum ImGui_TableBgTarget : uint32
Symbol ID: script.enum.ImGui_TableBgTarget
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:277
Table background channel targeted by a Dear ImGui cell or row color assignment
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CellBg |
3 |
3 | script.enum-value.ImGui_TableBgTarget.CellBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:283 | Set cell background color (top-most color) |
None |
0 |
0 | script.enum-value.ImGui_TableBgTarget.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:280 | Selects no table background color target |
RowBg0 |
1 |
1 | script.enum-value.ImGui_TableBgTarget.RowBg0 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:281 | Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used) |
RowBg1 |
2 |
2 | script.enum-value.ImGui_TableBgTarget.RowBg1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:282 | Set row background color 1 (generally used for selection marking) |
ImGui_TableColumnFlags
enum ImGui_TableColumnFlags : uint32
Symbol ID: script.enum.ImGui_TableColumnFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:239
Per-column visibility, sizing, ordering, sorting, and status flags for Dear ImGui tables
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AngledHeader |
262144 |
262144 | script.enum-value.ImGui_TableColumnFlags.AngledHeader |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:261 | TableHeadersRow() will submit an angled header row for this column. Note this will add an extra row |
DefaultHide |
2 |
2 | script.enum-value.ImGui_TableColumnFlags.DefaultHide |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:244 | Default as a hidden/disabled column |
DefaultSort |
4 |
4 | script.enum-value.ImGui_TableColumnFlags.DefaultSort |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:245 | Default as a sorting column |
Disabled |
1 |
1 | script.enum-value.ImGui_TableColumnFlags.Disabled |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:243 | Overriding/master disable flag: hide column, won't show in context menu (unlike calling TableSetColumnEnabled() which manipulates the user accessible state) |
IndentDisable |
131072 |
131072 | script.enum-value.ImGui_TableColumnFlags.IndentDisable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:260 | Ignore current Indent value when entering cell (default for columns > 0). Indentation changes within the cell will still be honored |
IndentEnable |
65536 |
65536 | script.enum-value.ImGui_TableColumnFlags.IndentEnable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:259 | Use current Indent value when entering cell (default for column 0) |
IsEnabled |
16777216 |
16777216 | script.enum-value.ImGui_TableColumnFlags.IsEnabled |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:262 | Status: is enabled == not hidden by user/api (referred to as "Hide" in _DefaultHide and _NoHide) flags |
IsHovered |
134217728 |
134217728 | script.enum-value.ImGui_TableColumnFlags.IsHovered |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:265 | Status: is hovered by mouse |
IsSorted |
67108864 |
67108864 | script.enum-value.ImGui_TableColumnFlags.IsSorted |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:264 | Status: is currently part of the sort specs |
IsVisible |
33554432 |
33554432 | script.enum-value.ImGui_TableColumnFlags.IsVisible |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:263 | Status: is visible == is enabled AND not clipped by scrolling |
NoClip |
256 |
256 | script.enum-value.ImGui_TableColumnFlags.NoClip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:251 | Disable clipping for this column (all NoClip columns will render in a same draw command) |
NoHeaderLabel |
4096 |
4096 | script.enum-value.ImGui_TableColumnFlags.NoHeaderLabel |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:255 | TableHeadersRow() will submit an empty label for this column. Convenient for some small columns. Name will still appear in context menu or in angled headers. You may append into this cell by calling TableSetColumnIndex() right after the TableHeadersRow() call |
NoHeaderWidth |
8192 |
8192 | script.enum-value.ImGui_TableColumnFlags.NoHeaderWidth |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:256 | Disable header text width contribution to automatic column width |
NoHide |
128 |
128 | script.enum-value.ImGui_TableColumnFlags.NoHide |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:250 | Disable ability to hide/disable this column |
NoReorder |
64 |
64 | script.enum-value.ImGui_TableColumnFlags.NoReorder |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:249 | Disable manual reordering this column, this will also prevent other columns from crossing over this column |
NoResize |
32 |
32 | script.enum-value.ImGui_TableColumnFlags.NoResize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:248 | Disable manual resizing |
NoSort |
512 |
512 | script.enum-value.ImGui_TableColumnFlags.NoSort |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:252 | Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table) |
NoSortAscending |
1024 |
1024 | script.enum-value.ImGui_TableColumnFlags.NoSortAscending |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:253 | Disable ability to sort in the ascending direction |
NoSortDescending |
2048 |
2048 | script.enum-value.ImGui_TableColumnFlags.NoSortDescending |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:254 | Disable ability to sort in the descending direction |
None |
0 |
0 | script.enum-value.ImGui_TableColumnFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:242 | Applies no optional table-column behavior flags |
PreferSortAscending |
16384 |
16384 | script.enum-value.ImGui_TableColumnFlags.PreferSortAscending |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:257 | Make the initial sort direction Ascending when first sorting on this column (default) |
PreferSortDescending |
32768 |
32768 | script.enum-value.ImGui_TableColumnFlags.PreferSortDescending |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:258 | Make the initial sort direction Descending when first sorting on this column |
WidthFixed |
16 |
16 | script.enum-value.ImGui_TableColumnFlags.WidthFixed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:247 | Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable) |
WidthStretch |
8 |
8 | script.enum-value.ImGui_TableColumnFlags.WidthStretch |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:246 | Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp) |
ImGui_TableFlags
enum ImGui_TableFlags : uint32
Symbol ID: script.enum.ImGui_TableFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:197
Layout, borders, sizing, scrolling, sorting, and clipping behavior for Dear ImGui tables
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Borders |
1920 |
1920 | script.enum-value.ImGui_TableFlags.Borders |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:216 | Draw all borders |
BordersH |
384 |
384 | script.enum-value.ImGui_TableFlags.BordersH |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:212 | Draw horizontal borders |
BordersInner |
640 |
640 | script.enum-value.ImGui_TableFlags.BordersInner |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:214 | Draw inner borders |
BordersInnerH |
128 |
128 | script.enum-value.ImGui_TableFlags.BordersInnerH |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:208 | Draw horizontal borders between rows |
BordersInnerV |
512 |
512 | script.enum-value.ImGui_TableFlags.BordersInnerV |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:210 | Draw vertical borders between columns |
BordersOuter |
1280 |
1280 | script.enum-value.ImGui_TableFlags.BordersOuter |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:215 | Draw outer borders |
BordersOuterH |
256 |
256 | script.enum-value.ImGui_TableFlags.BordersOuterH |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:209 | Draw horizontal borders at the top and bottom |
BordersOuterV |
1024 |
1024 | script.enum-value.ImGui_TableFlags.BordersOuterV |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:211 | Draw vertical borders on the left and right sides |
BordersV |
1536 |
1536 | script.enum-value.ImGui_TableFlags.BordersV |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:213 | Draw vertical borders |
ContextMenuInBody |
32 |
32 | script.enum-value.ImGui_TableFlags.ContextMenuInBody |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:206 | Right-click on columns body/contents will also display table context menu. By default it is available in TableHeadersRow() |
Hideable |
4 |
4 | script.enum-value.ImGui_TableFlags.Hideable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:203 | Enable hiding/disabling columns in context menu |
HighlightHoveredColumn |
268435456 |
268435456 | script.enum-value.ImGui_TableFlags.HighlightHoveredColumn |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:235 | Highlight column headers when hovered (may evolve into a fuller highlight) |
NoBordersInBody |
2048 |
2048 | script.enum-value.ImGui_TableFlags.NoBordersInBody |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:217 | [ALPHA] Disable vertical borders in columns Body (borders will always appear in Headers). -> May move to style |
NoBordersInBodyUntilResize |
4096 |
4096 | script.enum-value.ImGui_TableFlags.NoBordersInBodyUntilResize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:218 | [ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appear in Headers). -> May move to style |
NoClip |
1048576 |
1048576 | script.enum-value.ImGui_TableFlags.NoClip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:227 | Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze() |
NoHostExtendX |
65536 |
65536 | script.enum-value.ImGui_TableFlags.NoHostExtendX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:223 | Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used |
NoHostExtendY |
131072 |
131072 | script.enum-value.ImGui_TableFlags.NoHostExtendY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:224 | Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible |
NoKeepColumnsVisible |
262144 |
262144 | script.enum-value.ImGui_TableFlags.NoKeepColumnsVisible |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:225 | Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable |
NoPadInnerX |
8388608 |
8388608 | script.enum-value.ImGui_TableFlags.NoPadInnerX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:230 | Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off) |
NoPadOuterX |
4194304 |
4194304 | script.enum-value.ImGui_TableFlags.NoPadOuterX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:229 | Default if BordersOuterV is off. Disable outermost padding |
NoSavedSettings |
16 |
16 | script.enum-value.ImGui_TableFlags.NoSavedSettings |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:205 | Disable persisting columns order, width, visibility and sort settings in the .ini file |
None |
0 |
0 | script.enum-value.ImGui_TableFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:200 | Applies no optional table behavior flags |
PadOuterX |
2097152 |
2097152 | script.enum-value.ImGui_TableFlags.PadOuterX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:228 | Default if BordersOuterV is on. Enable outermost padding. Generally desirable if you have headers |
PreciseWidths |
524288 |
524288 | script.enum-value.ImGui_TableFlags.PreciseWidths |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:226 | Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth |
Reorderable |
2 |
2 | script.enum-value.ImGui_TableFlags.Reorderable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:202 | Enable reordering columns in header row. (Need calling TableSetupColumn() + TableHeadersRow() to display headers, or using ImGuiTableFlags_ContextMenuInBody to access context-menu without headers) |
Resizable |
1 |
1 | script.enum-value.ImGui_TableFlags.Resizable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:201 | Enable resizing columns |
RowBg |
64 |
64 | script.enum-value.ImGui_TableFlags.RowBg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:207 | Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually) |
ScrollX |
16777216 |
16777216 | script.enum-value.ImGui_TableFlags.ScrollX |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:231 | Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this creates a child window, ScrollY is currently generally recommended when using ScrollX |
ScrollY |
33554432 |
33554432 | script.enum-value.ImGui_TableFlags.ScrollY |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:232 | Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size |
SizingFixedFit |
8192 |
8192 | script.enum-value.ImGui_TableFlags.SizingFixedFit |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:219 | Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width |
SizingFixedSame |
16384 |
16384 | script.enum-value.ImGui_TableFlags.SizingFixedSame |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:220 | Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible |
SizingStretchProp |
24576 |
24576 | script.enum-value.ImGui_TableFlags.SizingStretchProp |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:221 | Columns default to _WidthStretch with default weights proportional to each columns contents widths |
SizingStretchSame |
32768 |
32768 | script.enum-value.ImGui_TableFlags.SizingStretchSame |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:222 | Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn() |
SortMulti |
67108864 |
67108864 | script.enum-value.ImGui_TableFlags.SortMulti |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:233 | Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1) |
SortTristate |
134217728 |
134217728 | script.enum-value.ImGui_TableFlags.SortTristate |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:234 | Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0) |
Sortable |
8 |
8 | script.enum-value.ImGui_TableFlags.Sortable |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:204 | Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate |
ImGui_TableRowFlags
enum ImGui_TableRowFlags : uint32
Symbol ID: script.enum.ImGui_TableRowFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:269
Per-row header and background behavior for Dear ImGui tables
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Headers |
1 |
1 | script.enum-value.ImGui_TableRowFlags.Headers |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:273 | Identify header row (set default background color + width of its contents accounted differently for auto column width) |
None |
0 |
0 | script.enum-value.ImGui_TableRowFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:272 | Applies no optional table-row behavior flags |
ImGui_TreeNodeFlags
enum ImGui_TreeNodeFlags : uint32
Symbol ID: script.enum.ImGui_TreeNodeFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:142
Expansion, framing, selection, spanning, and navigation flags for Dear ImGui tree nodes
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AllowOverlap |
4 |
4 | script.enum-value.ImGui_TreeNodeFlags.AllowOverlap |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:148 | Hit testing will allow subsequent widgets to overlap this one. Require previous frame HoveredId to match before being usable. Shortcut to calling SetNextItemAllowOverlap() |
Bullet |
512 |
512 | script.enum-value.ImGui_TreeNodeFlags.Bullet |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:155 | Display a bullet instead of arrow. IMPORTANT: node can still be marked open/close if you don't set the _Leaf flag! |
CollapsingHeader |
26 |
26 | script.enum-value.ImGui_TreeNodeFlags.CollapsingHeader |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:161 | Combines framing with no tree-stack push and no automatic opening during logging |
DefaultOpen |
32 |
32 | script.enum-value.ImGui_TreeNodeFlags.DefaultOpen |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:151 | Default node to be open |
FramePadding |
1024 |
1024 | script.enum-value.ImGui_TreeNodeFlags.FramePadding |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:156 | Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding() before the node |
Framed |
2 |
2 | script.enum-value.ImGui_TreeNodeFlags.Framed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:147 | Draw frame with background (e.g. for CollapsingHeader) |
Leaf |
256 |
256 | script.enum-value.ImGui_TreeNodeFlags.Leaf |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:154 | No collapsing, no arrow (use as a convenience for leaf nodes). Note: will always open a tree/id scope and return true. If you never use that scope, add ImGuiTreeNodeFlags_NoTreePushOnOpen |
NoAutoOpenOnLog |
16 |
16 | script.enum-value.ImGui_TreeNodeFlags.NoAutoOpenOnLog |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:150 | Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes) |
NoTreePushOnOpen |
8 |
8 | script.enum-value.ImGui_TreeNodeFlags.NoTreePushOnOpen |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:149 | Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack |
None |
0 |
0 | script.enum-value.ImGui_TreeNodeFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:145 | Applies no optional tree-node behavior flags |
OpenOnArrow |
128 |
128 | script.enum-value.ImGui_TreeNodeFlags.OpenOnArrow |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:153 | Open when clicking on the arrow part (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined |
OpenOnDoubleClick |
64 |
64 | script.enum-value.ImGui_TreeNodeFlags.OpenOnDoubleClick |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:152 | Open on double-click instead of simple click (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined |
Selected |
1 |
1 | script.enum-value.ImGui_TreeNodeFlags.Selected |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:146 | Draw as selected |
SpanAllColumns |
16384 |
16384 | script.enum-value.ImGui_TreeNodeFlags.SpanAllColumns |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:160 | Frame will span all columns of its container table (label will still fit in current column) |
SpanAvailWidth |
2048 |
2048 | script.enum-value.ImGui_TreeNodeFlags.SpanAvailWidth |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:157 | Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line without using AllowOverlap mode |
SpanFullWidth |
4096 |
4096 | script.enum-value.ImGui_TreeNodeFlags.SpanFullWidth |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:158 | Extend hit box to the left-most and right-most edges (cover the indent area) |
SpanLabelWidth |
8192 |
8192 | script.enum-value.ImGui_TreeNodeFlags.SpanLabelWidth |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:159 | Narrow hit box + narrow hovering highlight, will only cover the label text |
ImGui_WindowFlags
enum ImGui_WindowFlags : uint32
Symbol ID: script.enum.ImGui_WindowFlags
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/ImGuiExt/ImGuiStuff.h:74
Window creation and interaction flags forwarded to the embedded Dear ImGui runtime
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AlwaysAutoResize |
64 |
64 | script.enum-value.ImGui_WindowFlags.AlwaysAutoResize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:84 | Resize every window to its content every frame |
AlwaysHorizontalScrollbar |
32768 |
32768 | script.enum-value.ImGui_WindowFlags.AlwaysHorizontalScrollbar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:93 | Always show horizontal scrollbar (even if ContentSize.x < Size.x) |
AlwaysVerticalScrollbar |
16384 |
16384 | script.enum-value.ImGui_WindowFlags.AlwaysVerticalScrollbar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:92 | Always show vertical scrollbar (even if ContentSize.y < Size.y) |
HorizontalScrollbar |
2048 |
2048 | script.enum-value.ImGui_WindowFlags.HorizontalScrollbar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:89 | Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the "Horizontal Scrolling" section |
MenuBar |
1024 |
1024 | script.enum-value.ImGui_WindowFlags.MenuBar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:88 | Has a menu-bar |
NoBackground |
128 |
128 | script.enum-value.ImGui_WindowFlags.NoBackground |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:85 | Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f) |
NoBringToFrontOnFocus |
8192 |
8192 | script.enum-value.ImGui_WindowFlags.NoBringToFrontOnFocus |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:91 | Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus) |
NoCollapse |
32 |
32 | script.enum-value.ImGui_WindowFlags.NoCollapse |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:83 | Disable user collapsing window by double-clicking on it. Also referred to as Window Menu Button (e.g. within a docking node) |
NoDecoration |
43 |
43 | script.enum-value.ImGui_WindowFlags.NoDecoration |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:98 | Disables the title bar, resizing, scrollbars, and collapsing controls |
NoFocusOnAppearing |
4096 |
4096 | script.enum-value.ImGui_WindowFlags.NoFocusOnAppearing |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:90 | Disable taking focus when transitioning from hidden to visible state |
NoInputs |
197120 |
197120 | script.enum-value.ImGui_WindowFlags.NoInputs |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:99 | Disables mouse input, navigation input, and navigation focus for the window |
NoMouseInputs |
512 |
512 | script.enum-value.ImGui_WindowFlags.NoMouseInputs |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:87 | Disable catching mouse, hovering test with pass through |
NoMove |
4 |
4 | script.enum-value.ImGui_WindowFlags.NoMove |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:80 | Disable user moving the window |
NoNav |
196608 |
196608 | script.enum-value.ImGui_WindowFlags.NoNav |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:97 | Disables both navigation input within the window and navigation focus toward it |
NoNavFocus |
131072 |
131072 | script.enum-value.ImGui_WindowFlags.NoNavFocus |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:95 | No focusing toward this window with keyboard/gamepad navigation (e.g. skipped by Ctrl+Tab) |
NoNavInputs |
65536 |
65536 | script.enum-value.ImGui_WindowFlags.NoNavInputs |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:94 | No keyboard/gamepad navigation within the window |
NoResize |
2 |
2 | script.enum-value.ImGui_WindowFlags.NoResize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:79 | Disable user resizing with the lower-right grip |
NoSavedSettings |
256 |
256 | script.enum-value.ImGui_WindowFlags.NoSavedSettings |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:86 | Never load/save settings in .ini file |
NoScrollWithMouse |
16 |
16 | script.enum-value.ImGui_WindowFlags.NoScrollWithMouse |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:82 | Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set |
NoScrollbar |
8 |
8 | script.enum-value.ImGui_WindowFlags.NoScrollbar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:81 | Disable scrollbars (window can still scroll with mouse or programmatically) |
NoTitleBar |
1 |
1 | script.enum-value.ImGui_WindowFlags.NoTitleBar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:78 | Disable title-bar |
None |
0 |
0 | script.enum-value.ImGui_WindowFlags.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:77 | Applies no optional window behavior flags |
UnsavedDocument |
262144 |
262144 | script.enum-value.ImGui_WindowFlags.UnsavedDocument |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/ImGuiExt/ImGuiStuff.h:96 | Display a dot next to the title. When used in a tab/docking context, tab is selected when clicking the X + closure is not assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar |
ItemOwnership
enum ItemOwnership : uint8
Symbol ID: script.enum.ItemOwnership
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1058
Current ownership location of an item: map hex, critter inventory, item container, or no owner
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CritterInventory |
1 |
1 | script.enum-value.ItemOwnership.CritterInventory |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1062 | Item is owned by a critter inventory or equipped slot |
ItemContainer |
2 |
2 | script.enum-value.ItemOwnership.ItemContainer |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1063 | Item is nested inside another item used as a container |
MapHex |
0 |
0 | script.enum-value.ItemOwnership.MapHex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1061 | Item is placed directly on a map hex |
Nowhere |
3 |
3 | script.enum-value.ItemOwnership.Nowhere |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1064 | Item has no map, critter, or item-container owner |
ItemProperty
enum ItemProperty : uint16
Symbol ID: script.enum.ItemProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the Item script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AlwaysHideSprite |
26 |
26 | script.enum-value.ItemProperty.AlwaysHideSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:197 | Prevents the item sprite from being drawn at runtime and hides it by default in Mapper |
Colorize |
50 |
50 | script.enum-value.ItemProperty.Colorize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:287 | Enables ColorizeColor tinting for the item's map sprite |
ColorizeColor |
35 |
35 | script.enum-value.ItemProperty.ColorizeColor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:232 | RGBA tint applied when Colorize is enabled; alpha also supplies the default sprite opacity |
ContainerId |
12 |
12 | script.enum-value.ItemProperty.ContainerId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:147 | Identifier of the parent item while Ownership is ItemContainer; zero otherwise |
ContainerStack |
13 |
13 | script.enum-value.ItemProperty.ContainerStack |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:150 | Project-defined grouping key used to select and merge items inside a container |
Corner |
17 |
17 | script.enum-value.ItemProperty.Corner |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:164 | Wall-corner orientation used by map lighting and transparent-foreground behavior |
CritterId |
10 |
10 | script.enum-value.ItemProperty.CritterId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:137 | Identifier of the owning critter while Ownership is CritterInventory; zero otherwise |
CritterSlot |
11 |
11 | script.enum-value.ItemProperty.CritterSlot |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:144 | Inventory or equipment slot occupied while the item belongs to a critter |
CustomHolderEntry |
2 |
2 | script.enum-value.ItemProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.ItemProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
DisableEgg |
18 |
18 | script.enum-value.ItemProperty.DisableEgg |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:167 | Disables transparent-foreground egg processing for the item's map sprite |
DrawFlatten |
45 |
45 | script.enum-value.ItemProperty.DrawFlatten |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:266 | Renders the item in a flat map pass instead of the normal depth-sorted item pass |
DrawMultihexLines |
22 |
22 | script.enum-value.ItemProperty.DrawMultihexLines |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:181 | Draws repeated item sprites on footprint hexes generated by MultihexLines |
DrawMultihexMesh |
23 |
23 | script.enum-value.ItemProperty.DrawMultihexMesh |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:184 | Draws repeated item sprites on the explicit MultihexMesh hexes |
DrawOrderSubLayer |
46 |
46 | script.enum-value.ItemProperty.DrawOrderSubLayer |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:269 | Fine ordering inside the item's primary draw-order layer; synchronized when changed at runtime |
Elevation |
9 |
9 | script.enum-value.ItemProperty.Elevation |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:132 | Vertical rendering elevation of the map item |
ExplicitlyPersistent |
3 |
3 | script.enum-value.ItemProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
Hex |
8 |
8 | script.enum-value.ItemProperty.Hex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:129 | Origin map hex used while the item is placed on a map |
Hidden |
24 |
24 | script.enum-value.ItemProperty.Hidden |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:189 | Server visibility flag that suppresses a dynamic item from client views while set |
HideSprite |
25 |
25 | script.enum-value.ItemProperty.HideSprite |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:192 | Hides the current client map sprite without removing the item's map presence |
InitScript |
4 |
4 | script.enum-value.ItemProperty.InitScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:113 | Server initialization function called after the item-init event for a newly created or restored item |
InnerItemIds |
14 |
14 | script.enum-value.ItemProperty.InnerItemIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:155 | Persistent identifiers of the items directly contained by this item |
IsGag |
49 |
49 | script.enum-value.ItemProperty.IsGag |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:282 | Marks a blocking item as conditionally passable through the map gag callback |
IsRoofTile |
43 |
43 | script.enum-value.ItemProperty.IsRoofTile |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:258 | Selects roof rendering instead of ground-tile rendering when IsTile is enabled |
IsScenery |
40 |
40 | script.enum-value.ItemProperty.IsScenery |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:249 | Classifies the item as scenery for Mapper filtering and flat-render lighting rules |
IsTile |
42 |
42 | script.enum-value.ItemProperty.IsTile |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:255 | Classifies the item as a ground or roof tile rendered in a tile layer |
IsTrigger |
38 |
38 | script.enum-value.ItemProperty.IsTrigger |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:243 | Includes the item in map trigger lookup and movement-trigger processing |
IsWall |
41 |
41 | script.enum-value.ItemProperty.IsWall |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:252 | Classifies the item as a wall for Mapper filtering and map presentation |
LightColor |
34 |
34 | script.enum-value.ItemProperty.LightColor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:229 | RGBA color emitted by the item's light source |
LightDistance |
32 |
32 | script.enum-value.ItemProperty.LightDistance |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:223 | Radius in hexes reached by the item's light source |
LightFlags |
33 |
33 | script.enum-value.ItemProperty.LightFlags |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:226 | Bit mask controlling global, inverse, and direction-blocking behavior of the light source |
LightIntensity |
31 |
31 | script.enum-value.ItemProperty.LightIntensity |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:220 | Signed percentage intensity of the item's light source |
LightSource |
30 |
30 | script.enum-value.ItemProperty.LightSource |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:217 | Enables a map light source centered on this item |
LightThru |
29 |
29 | script.enum-value.ItemProperty.LightThru |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:212 | Allows map light propagation through every hex occupied by the item |
MapId |
7 |
7 | script.enum-value.ItemProperty.MapId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:126 | Identifier of the owning map while Ownership is MapHex; zero otherwise |
MultihexGeneration |
21 |
21 | script.enum-value.ItemProperty.MultihexGeneration |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:178 | Mapper coalescing strategy used to build MultihexMesh from compatible item placements |
MultihexLines |
19 |
19 | script.enum-value.ItemProperty.MultihexLines |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:172 | Direction and step-count pairs that trace additional footprint hexes from each mesh origin |
MultihexMesh |
20 |
20 | script.enum-value.ItemProperty.MultihexMesh |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:175 | Explicit map hexes that share this item's footprint and optional repeated sprite |
NoBlock |
27 |
27 | script.enum-value.ItemProperty.NoBlock |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:202 | Allows movement through every hex occupied by the item |
NoHighlight |
47 |
47 | script.enum-value.ItemProperty.NoHighlight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:274 | Prevents the client from applying normal item highlight presentation |
NoLightInfluence |
48 |
48 | script.enum-value.ItemProperty.NoLightInfluence |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:279 | Prevents ambient map lighting from tinting the item's sprite |
None |
0 |
0 | script.enum-value.ItemProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no Item property identifier is selected. |
Offset |
16 |
16 | script.enum-value.ItemProperty.Offset |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:161 | Pixel offset applied to the item's map sprite from its origin hex |
Ownership |
6 |
6 | script.enum-value.ItemProperty.Ownership |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:123 | Current placement category: map hex, critter inventory, item container, or nowhere |
PicInv |
39 |
39 | script.enum-value.ItemProperty.PicInv |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:246 | Sprite resource used to present the item in inventory interfaces |
PicMap |
15 |
15 | script.enum-value.ItemProperty.PicMap |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:158 | Sprite resource used to render the item on a map |
ShootThru |
28 |
28 | script.enum-value.ItemProperty.ShootThru |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:207 | Allows projectile traces through every hex occupied by the item |
Static |
5 |
5 | script.enum-value.ItemProperty.Static |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:118 | Marks map-authored item data as static scenery rather than a dynamic item entity |
StaticScript |
36 |
36 | script.enum-value.ItemProperty.StaticScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:237 | Server callback invoked when a critter interacts with this static item |
TileLayer |
44 |
44 | script.enum-value.ItemProperty.TileLayer |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:261 | Zero-based ground- or roof-tile draw layer selected for a tile item |
TriggerScript |
37 |
37 | script.enum-value.ItemProperty.TriggerScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:240 | Server callback invoked when a critter enters or leaves this trigger item |
KeyCode
enum KeyCode : uint8
Symbol ID: script.enum.KeyCode
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Frontend/Application.h:50
Physical SDL-scancode key identifiers used by input events and key-state queries, plus a synthetic Text event for UTF-8 text, paste, and drop payloads
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
A |
0x1E |
30 | script.enum-value.KeyCode.A |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:83 | Identifies the physical keyboard key mapped from SDL_SCANCODE_A by the application input layer |
Add |
0x4E |
78 | script.enum-value.KeyCode.Add |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:131 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_PLUS by the application input layer |
Apostrophe |
0x28 |
40 | script.enum-value.KeyCode.Apostrophe |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:93 | Identifies the physical keyboard key mapped from SDL_SCANCODE_APOSTROPHE by the application input layer |
B |
0x30 |
48 | script.enum-value.KeyCode.B |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:101 | Identifies the physical keyboard key mapped from SDL_SCANCODE_B by the application input layer |
Back |
0x0E |
14 | script.enum-value.KeyCode.Back |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:67 | Identifies the physical keyboard key mapped from SDL_SCANCODE_BACKSPACE by the application input layer |
Backslash |
0x2B |
43 | script.enum-value.KeyCode.Backslash |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:96 | Identifies the physical keyboard key mapped from SDL_SCANCODE_BACKSLASH by the application input layer |
C |
0x2E |
46 | script.enum-value.KeyCode.C |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:99 | Identifies the physical keyboard key mapped from SDL_SCANCODE_C by the application input layer |
C0 |
0x0B |
11 | script.enum-value.KeyCode.C0 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:64 | Identifies the physical keyboard key mapped from SDL_SCANCODE_0 by the application input layer |
C1 |
0x02 |
2 | script.enum-value.KeyCode.C1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:55 | Identifies the physical keyboard key mapped from SDL_SCANCODE_1 by the application input layer |
C2 |
0x03 |
3 | script.enum-value.KeyCode.C2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:56 | Identifies the physical keyboard key mapped from SDL_SCANCODE_2 by the application input layer |
C3 |
0x04 |
4 | script.enum-value.KeyCode.C3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:57 | Identifies the physical keyboard key mapped from SDL_SCANCODE_3 by the application input layer |
C4 |
0x05 |
5 | script.enum-value.KeyCode.C4 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:58 | Identifies the physical keyboard key mapped from SDL_SCANCODE_4 by the application input layer |
C5 |
0x06 |
6 | script.enum-value.KeyCode.C5 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:59 | Identifies the physical keyboard key mapped from SDL_SCANCODE_5 by the application input layer |
C6 |
0x07 |
7 | script.enum-value.KeyCode.C6 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:60 | Identifies the physical keyboard key mapped from SDL_SCANCODE_6 by the application input layer |
C7 |
0x08 |
8 | script.enum-value.KeyCode.C7 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:61 | Identifies the physical keyboard key mapped from SDL_SCANCODE_7 by the application input layer |
C8 |
0x09 |
9 | script.enum-value.KeyCode.C8 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:62 | Identifies the physical keyboard key mapped from SDL_SCANCODE_8 by the application input layer |
C9 |
0x0A |
10 | script.enum-value.KeyCode.C9 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:63 | Identifies the physical keyboard key mapped from SDL_SCANCODE_9 by the application input layer |
Capital |
0x3A |
58 | script.enum-value.KeyCode.Capital |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:111 | Identifies the physical keyboard key mapped from SDL_SCANCODE_CAPSLOCK by the application input layer |
Comma |
0x33 |
51 | script.enum-value.KeyCode.Comma |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:104 | Identifies the physical keyboard key mapped from SDL_SCANCODE_COMMA by the application input layer |
D |
0x20 |
32 | script.enum-value.KeyCode.D |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:85 | Identifies the physical keyboard key mapped from SDL_SCANCODE_D by the application input layer |
Decimal |
0x53 |
83 | script.enum-value.KeyCode.Decimal |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:136 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_PERIOD by the application input layer |
Delete |
0xD3 |
211 | script.enum-value.KeyCode.Delete |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:154 | Identifies the physical keyboard key mapped from SDL_SCANCODE_DELETE by the application input layer |
Divide |
0xB5 |
181 | script.enum-value.KeyCode.Divide |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:141 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_DIVIDE by the application input layer |
Down |
0xD0 |
208 | script.enum-value.KeyCode.Down |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:151 | Identifies the physical keyboard key mapped from SDL_SCANCODE_DOWN by the application input layer |
E |
0x12 |
18 | script.enum-value.KeyCode.E |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:71 | Identifies the physical keyboard key mapped from SDL_SCANCODE_E by the application input layer |
End |
0xCF |
207 | script.enum-value.KeyCode.End |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:150 | Identifies the physical keyboard key mapped from SDL_SCANCODE_END by the application input layer |
Equals |
0x0D |
13 | script.enum-value.KeyCode.Equals |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:66 | Identifies the physical keyboard key mapped from SDL_SCANCODE_EQUALS by the application input layer |
Escape |
0x01 |
1 | script.enum-value.KeyCode.Escape |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:54 | Identifies the physical keyboard key mapped from SDL_SCANCODE_ESCAPE by the application input layer |
F |
0x21 |
33 | script.enum-value.KeyCode.F |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:86 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F by the application input layer |
F1 |
0x3B |
59 | script.enum-value.KeyCode.F1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:112 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F1 by the application input layer |
F10 |
0x44 |
68 | script.enum-value.KeyCode.F10 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:121 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F10 by the application input layer |
F11 |
0x57 |
87 | script.enum-value.KeyCode.F11 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:137 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F11 by the application input layer |
F12 |
0x58 |
88 | script.enum-value.KeyCode.F12 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:138 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F12 by the application input layer |
F2 |
0x3C |
60 | script.enum-value.KeyCode.F2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:113 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F2 by the application input layer |
F3 |
0x3D |
61 | script.enum-value.KeyCode.F3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:114 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F3 by the application input layer |
F4 |
0x3E |
62 | script.enum-value.KeyCode.F4 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:115 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F4 by the application input layer |
F5 |
0x3F |
63 | script.enum-value.KeyCode.F5 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:116 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F5 by the application input layer |
F6 |
0x40 |
64 | script.enum-value.KeyCode.F6 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:117 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F6 by the application input layer |
F7 |
0x41 |
65 | script.enum-value.KeyCode.F7 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:118 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F7 by the application input layer |
F8 |
0x42 |
66 | script.enum-value.KeyCode.F8 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:119 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F8 by the application input layer |
F9 |
0x43 |
67 | script.enum-value.KeyCode.F9 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:120 | Identifies the physical keyboard key mapped from SDL_SCANCODE_F9 by the application input layer |
G |
0x22 |
34 | script.enum-value.KeyCode.G |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:87 | Identifies the physical keyboard key mapped from SDL_SCANCODE_G by the application input layer |
Grave |
0x29 |
41 | script.enum-value.KeyCode.Grave |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:94 | Identifies the physical keyboard key mapped from SDL_SCANCODE_GRAVE by the application input layer |
H |
0x23 |
35 | script.enum-value.KeyCode.H |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:88 | Identifies the physical keyboard key mapped from SDL_SCANCODE_H by the application input layer |
Home |
0xC7 |
199 | script.enum-value.KeyCode.Home |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:145 | Identifies the physical keyboard key mapped from SDL_SCANCODE_HOME by the application input layer |
I |
0x17 |
23 | script.enum-value.KeyCode.I |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:76 | Identifies the physical keyboard key mapped from SDL_SCANCODE_I by the application input layer |
Insert |
0xD2 |
210 | script.enum-value.KeyCode.Insert |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:153 | Identifies the physical keyboard key mapped from SDL_SCANCODE_INSERT by the application input layer |
J |
0x24 |
36 | script.enum-value.KeyCode.J |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:89 | Identifies the physical keyboard key mapped from SDL_SCANCODE_J by the application input layer |
K |
0x25 |
37 | script.enum-value.KeyCode.K |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:90 | Identifies the physical keyboard key mapped from SDL_SCANCODE_K by the application input layer |
L |
0x26 |
38 | script.enum-value.KeyCode.L |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:91 | Identifies the physical keyboard key mapped from SDL_SCANCODE_L by the application input layer |
Lbracket |
0x1A |
26 | script.enum-value.KeyCode.Lbracket |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:79 | Identifies the physical keyboard key mapped from SDL_SCANCODE_LEFTBRACKET by the application input layer |
Lcontrol |
0x1D |
29 | script.enum-value.KeyCode.Lcontrol |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:82 | Identifies the physical keyboard key mapped from SDL_SCANCODE_LCTRL by the application input layer |
Left |
0xCB |
203 | script.enum-value.KeyCode.Left |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:148 | Identifies the physical keyboard key mapped from SDL_SCANCODE_LEFT by the application input layer |
Lmenu |
0x38 |
56 | script.enum-value.KeyCode.Lmenu |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:109 | Identifies the physical keyboard key mapped from SDL_SCANCODE_LALT by the application input layer |
Lshift |
0x2A |
42 | script.enum-value.KeyCode.Lshift |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:95 | Identifies the physical keyboard key mapped from SDL_SCANCODE_LSHIFT by the application input layer |
Lwin |
0xDB |
219 | script.enum-value.KeyCode.Lwin |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:155 | Identifies the physical keyboard key mapped from SDL_SCANCODE_LGUI by the application input layer |
M |
0x32 |
50 | script.enum-value.KeyCode.M |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:103 | Identifies the physical keyboard key mapped from SDL_SCANCODE_M by the application input layer |
Minus |
0x0C |
12 | script.enum-value.KeyCode.Minus |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:65 | Identifies the physical keyboard key mapped from SDL_SCANCODE_MINUS by the application input layer |
Multiply |
0x37 |
55 | script.enum-value.KeyCode.Multiply |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:108 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_MULTIPLY by the application input layer |
N |
0x31 |
49 | script.enum-value.KeyCode.N |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:102 | Identifies the physical keyboard key mapped from SDL_SCANCODE_N by the application input layer |
Next |
0xD1 |
209 | script.enum-value.KeyCode.Next |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:152 | Identifies the physical keyboard key mapped from SDL_SCANCODE_PAGEDOWN by the application input layer |
None |
0x00 |
0 | script.enum-value.KeyCode.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:53 | Indicates that no physical or synthetic keyboard input code is selected |
Numlock |
0x45 |
69 | script.enum-value.KeyCode.Numlock |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:122 | Identifies the physical keyboard key mapped from SDL_SCANCODE_NUMLOCKCLEAR by the application input layer |
Numpad0 |
0x52 |
82 | script.enum-value.KeyCode.Numpad0 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:135 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_0 by the application input layer |
Numpad1 |
0x4F |
79 | script.enum-value.KeyCode.Numpad1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:132 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_1 by the application input layer |
Numpad2 |
0x50 |
80 | script.enum-value.KeyCode.Numpad2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:133 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_2 by the application input layer |
Numpad3 |
0x51 |
81 | script.enum-value.KeyCode.Numpad3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:134 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_3 by the application input layer |
Numpad4 |
0x4B |
75 | script.enum-value.KeyCode.Numpad4 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:128 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_4 by the application input layer |
Numpad5 |
0x4C |
76 | script.enum-value.KeyCode.Numpad5 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:129 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_5 by the application input layer |
Numpad6 |
0x4D |
77 | script.enum-value.KeyCode.Numpad6 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:130 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_6 by the application input layer |
Numpad7 |
0x47 |
71 | script.enum-value.KeyCode.Numpad7 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:124 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_7 by the application input layer |
Numpad8 |
0x48 |
72 | script.enum-value.KeyCode.Numpad8 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:125 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_8 by the application input layer |
Numpad9 |
0x49 |
73 | script.enum-value.KeyCode.Numpad9 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:126 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_9 by the application input layer |
Numpadenter |
0x9C |
156 | script.enum-value.KeyCode.Numpadenter |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:139 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_ENTER by the application input layer |
O |
0x18 |
24 | script.enum-value.KeyCode.O |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:77 | Identifies the physical keyboard key mapped from SDL_SCANCODE_O by the application input layer |
P |
0x19 |
25 | script.enum-value.KeyCode.P |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:78 | Identifies the physical keyboard key mapped from SDL_SCANCODE_P by the application input layer |
Pause |
0xC5 |
197 | script.enum-value.KeyCode.Pause |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:144 | Identifies the physical keyboard key mapped from SDL_SCANCODE_PAUSE by the application input layer |
Period |
0x34 |
52 | script.enum-value.KeyCode.Period |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:105 | Identifies the physical keyboard key mapped from SDL_SCANCODE_PERIOD by the application input layer |
Prior |
0xC9 |
201 | script.enum-value.KeyCode.Prior |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:147 | Identifies the physical keyboard key mapped from SDL_SCANCODE_PAGEUP by the application input layer |
Q |
0x10 |
16 | script.enum-value.KeyCode.Q |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:69 | Identifies the physical keyboard key mapped from SDL_SCANCODE_Q by the application input layer |
R |
0x13 |
19 | script.enum-value.KeyCode.R |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:72 | Identifies the physical keyboard key mapped from SDL_SCANCODE_R by the application input layer |
Rbracket |
0x1B |
27 | script.enum-value.KeyCode.Rbracket |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:80 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RIGHTBRACKET by the application input layer |
Rcontrol |
0x9D |
157 | script.enum-value.KeyCode.Rcontrol |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:140 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RCTRL by the application input layer |
Return |
0x1C |
28 | script.enum-value.KeyCode.Return |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:81 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RETURN by the application input layer |
Right |
0xCD |
205 | script.enum-value.KeyCode.Right |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:149 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RIGHT by the application input layer |
Rmenu |
0xB8 |
184 | script.enum-value.KeyCode.Rmenu |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:143 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RALT by the application input layer |
Rshift |
0x36 |
54 | script.enum-value.KeyCode.Rshift |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:107 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RSHIFT by the application input layer |
Rwin |
0xDC |
220 | script.enum-value.KeyCode.Rwin |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:156 | Identifies the physical keyboard key mapped from SDL_SCANCODE_RGUI by the application input layer |
S |
0x1F |
31 | script.enum-value.KeyCode.S |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:84 | Identifies the physical keyboard key mapped from SDL_SCANCODE_S by the application input layer |
Scroll |
0x46 |
70 | script.enum-value.KeyCode.Scroll |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:123 | Identifies the physical keyboard key mapped from SDL_SCANCODE_SCROLLLOCK by the application input layer |
Semicolon |
0x27 |
39 | script.enum-value.KeyCode.Semicolon |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:92 | Identifies the physical keyboard key mapped from SDL_SCANCODE_SEMICOLON by the application input layer |
Slash |
0x35 |
53 | script.enum-value.KeyCode.Slash |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:106 | Identifies the physical keyboard key mapped from SDL_SCANCODE_SLASH by the application input layer |
Space |
0x39 |
57 | script.enum-value.KeyCode.Space |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:110 | Identifies the physical keyboard key mapped from SDL_SCANCODE_SPACE by the application input layer |
Subtract |
0x4A |
74 | script.enum-value.KeyCode.Subtract |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:127 | Identifies the physical keyboard key mapped from SDL_SCANCODE_KP_MINUS by the application input layer |
Sysrq |
0xB7 |
183 | script.enum-value.KeyCode.Sysrq |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:142 | Identifies the physical keyboard key mapped from SDL_SCANCODE_SYSREQ by the application input layer |
T |
0x14 |
20 | script.enum-value.KeyCode.T |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:73 | Identifies the physical keyboard key mapped from SDL_SCANCODE_T by the application input layer |
Tab |
0x0F |
15 | script.enum-value.KeyCode.Tab |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:68 | Identifies the physical keyboard key mapped from SDL_SCANCODE_TAB by the application input layer |
Text |
0xFF |
255 | script.enum-value.KeyCode.Text |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:157 | Identifies a synthetic text event whose UTF-8 input, clipboard, or dropped-data payload is carried separately by the input event |
U |
0x16 |
22 | script.enum-value.KeyCode.U |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:75 | Identifies the physical keyboard key mapped from SDL_SCANCODE_U by the application input layer |
Up |
0xC8 |
200 | script.enum-value.KeyCode.Up |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:146 | Identifies the physical keyboard key mapped from SDL_SCANCODE_UP by the application input layer |
V |
0x2F |
47 | script.enum-value.KeyCode.V |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:100 | Identifies the physical keyboard key mapped from SDL_SCANCODE_V by the application input layer |
W |
0x11 |
17 | script.enum-value.KeyCode.W |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:70 | Identifies the physical keyboard key mapped from SDL_SCANCODE_W by the application input layer |
X |
0x2D |
45 | script.enum-value.KeyCode.X |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:98 | Identifies the physical keyboard key mapped from SDL_SCANCODE_X by the application input layer |
Y |
0x15 |
21 | script.enum-value.KeyCode.Y |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:74 | Identifies the physical keyboard key mapped from SDL_SCANCODE_Y by the application input layer |
Z |
0x2C |
44 | script.enum-value.KeyCode.Z |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:97 | Identifies the physical keyboard key mapped from SDL_SCANCODE_Z by the application input layer |
LocationProperty
enum LocationProperty : uint16
Symbol ID: script.enum.LocationProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the Location script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CustomHolderEntry |
2 |
2 | script.enum-value.LocationProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.LocationProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
ExplicitlyPersistent |
3 |
3 | script.enum-value.LocationProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
InitScript |
4 |
4 | script.enum-value.LocationProperty.InitScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:495 | Server initialization function called after the location-init event for a newly created or restored location |
MapIds |
5 |
5 | script.enum-value.LocationProperty.MapIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:498 | Persistent identifiers of the maps owned by this location, in location-map order |
None |
0 |
0 | script.enum-value.LocationProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no Location property identifier is selected. |
MapLayers
enum MapLayers : uint8
Symbol ID: script.enum.MapLayers
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1102
The layers a map view draws. The mapper hides one to work on another, so the visible set is editor state
the view is told about - a value that changes while the tool runs is not something anyone configures
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
All |
0x7F |
127 | script.enum-value.MapLayers.All |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1113 | Draw every map layer |
Critters |
0x08 |
8 | script.enum-value.MapLayers.Critters |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1109 | Draw critters |
Fast |
0x40 |
64 | script.enum-value.MapLayers.Fast |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1112 | Draw the fast-rendered layer |
Items |
0x01 |
1 | script.enum-value.MapLayers.Items |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1106 | Draw map items |
None |
0 |
0 | script.enum-value.MapLayers.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1105 | Draw none of the optional map layers |
Roof |
0x20 |
32 | script.enum-value.MapLayers.Roof |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1111 | Draw roof tiles |
Scenery |
0x02 |
2 | script.enum-value.MapLayers.Scenery |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1107 | Draw scenery objects |
Tiles |
0x10 |
16 | script.enum-value.MapLayers.Tiles |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1110 | Draw ground tiles |
Walls |
0x04 |
4 | script.enum-value.MapLayers.Walls |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1108 | Draw wall objects |
MapProperty
enum MapProperty : uint16
Symbol ID: script.enum.MapProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the Map script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
CritterIds |
7 |
7 | script.enum-value.MapProperty.CritterIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:429 | Persistent identifiers of the non-player critters owned by this map |
CustomHolderEntry |
2 |
2 | script.enum-value.MapProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.MapProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
DayColor |
18 |
18 | script.enum-value.MapProperty.DayColor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:466 | Channel-major RGB values for the map's corresponding daylight color keyframes |
DayColorTime |
17 |
17 | script.enum-value.MapProperty.DayColorTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:463 | Map-specific daylight color keyframe times expressed in minutes of the day cycle |
ExplicitlyPersistent |
3 |
3 | script.enum-value.MapProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
FixedDayTime |
16 |
16 | script.enum-value.MapProperty.FixedDayTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:458 | Map-local day-time override value, conventionally expressed in minutes and interpreted by game scripts |
GlobalDayColor |
20 |
20 | script.enum-value.MapProperty.GlobalDayColor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:472 | Current client-side global daylight color supplied through SetDayColors for scripts and effects |
GlobalDayLightCapacity |
22 |
22 | script.enum-value.MapProperty.GlobalDayLightCapacity |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:478 | Current daylight capacity percentage for light sources flagged as global, clamped to 0 through 100 |
InitScript |
4 |
4 | script.enum-value.MapProperty.InitScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:420 | Server initialization function called after the map-init event for a newly created or restored map |
ItemIds |
8 |
8 | script.enum-value.MapProperty.ItemIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:432 | Persistent identifiers of the dynamic items placed directly on this map |
LocId |
5 |
5 | script.enum-value.MapProperty.LocId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:423 | Identifier of the location that owns this map |
LocMapIndex |
6 |
6 | script.enum-value.MapProperty.LocMapIndex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:426 | Zero-based position of this map in its owning location's map list |
MapDayColor |
19 |
19 | script.enum-value.MapProperty.MapDayColor |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:469 | Current client-side map tint supplied through SetDayColors and consumed by map rendering |
MapDayLightCapacity |
21 |
21 | script.enum-value.MapProperty.MapDayLightCapacity |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:475 | Current daylight capacity percentage for ordinary map light sources, clamped to 0 through 100 |
None |
0 |
0 | script.enum-value.MapProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no Map property identifier is selected. |
RemovedStaticItemIds |
9 |
9 | script.enum-value.MapProperty.RemovedStaticItemIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
ScrollAxialArea |
13 |
13 | script.enum-value.MapProperty.ScrollAxialArea |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:447 | Axial-coordinate rectangle that bounds map scrolling; a zero rectangle leaves the full map available |
ScrollOffset |
12 |
12 | script.enum-value.MapProperty.ScrollOffset |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:444 | Rounded client viewport offset in map-space pixels |
Size |
10 |
10 | script.enum-value.MapProperty.Size |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:438 | Width and height of the map grid in hexes |
SpritesZoom |
14 |
14 | script.enum-value.MapProperty.SpritesZoom |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:450 | Current client map-sprite zoom factor |
SpritesZoomTarget |
15 |
15 | script.enum-value.MapProperty.SpritesZoomTarget |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:453 | Target zoom factor toward which the client map view is interpolating |
WorkHex |
11 |
11 | script.enum-value.MapProperty.WorkHex |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:441 | Authoring work hex used as the initial Mapper view center |
MouseButton
enum MouseButton : uint8
Symbol ID: script.enum.MouseButton
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Frontend/Application.h:161
Mouse buttons and wheel directions exposed through application input events
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Ext0 |
5 |
5 | script.enum-value.MouseButton.Ext0 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:169 | First extended mouse button, mapped from the platform X1 button |
Ext1 |
6 |
6 | script.enum-value.MouseButton.Ext1 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:170 | Second extended mouse button, mapped from the platform X2 button |
Ext2 |
7 |
7 | script.enum-value.MouseButton.Ext2 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:171 | Third extended mouse button, mapped from platform button 6 |
Ext3 |
8 |
8 | script.enum-value.MouseButton.Ext3 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:172 | Fourth extended mouse button, mapped from platform button 7 |
Ext4 |
9 |
9 | script.enum-value.MouseButton.Ext4 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:173 | Fifth extended mouse button, mapped from platform button 8 |
Left |
0 |
0 | script.enum-value.MouseButton.Left |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:164 | Primary mouse button mapped from the platform left-button input |
Middle |
2 |
2 | script.enum-value.MouseButton.Middle |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:166 | Middle mouse button mapped from the platform middle-button input |
Right |
1 |
1 | script.enum-value.MouseButton.Right |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:165 | Secondary mouse button mapped from the platform right-button input |
WheelDown |
4 |
4 | script.enum-value.MouseButton.WheelDown |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:168 | Synthetic button event emitted for downward mouse-wheel motion |
WheelUp |
3 |
3 | script.enum-value.MouseButton.WheelUp |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:167 | Synthetic button event emitted for upward mouse-wheel motion |
MovingState
enum MovingState : uint8
Symbol ID: script.enum.MovingState
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Movement.h:43
Terminal or in-progress result reported by pathfinding and critter movement operations
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Attached |
13 |
13 | script.enum-value.MovingState.Attached |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:58 | Independent movement was rejected because the critter is attached to another critter |
CantMove |
3 |
3 | script.enum-value.MovingState.CantMove |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:49 | Movement could not start because the critter cannot move |
Deadlock |
10 |
10 | script.enum-value.MovingState.Deadlock |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:55 | Path construction encountered a movement deadlock |
GagCritter |
4 |
4 | script.enum-value.MovingState.GagCritter |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:50 | Movement was blocked by a critter occupancy callback |
GagItem |
5 |
5 | script.enum-value.MovingState.GagItem |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:51 | Movement was blocked by an item occupancy callback |
GenericError |
6 |
6 | script.enum-value.MovingState.GenericError |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:52 | Movement failed without a more specific result |
HexBusy |
8 |
8 | script.enum-value.MovingState.HexBusy |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:54 | The requested destination hex is occupied or otherwise unavailable |
HexTooFar |
7 |
7 | script.enum-value.MovingState.HexTooFar |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:53 | The requested destination is beyond the accepted movement range |
InProgress |
0 |
0 | script.enum-value.MovingState.InProgress |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:46 | Movement is active and has not produced a terminal result |
NotAlive |
12 |
12 | script.enum-value.MovingState.NotAlive |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:57 | Movement was rejected because the critter is not alive |
Stopped |
14 |
14 | script.enum-value.MovingState.Stopped |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:59 | Movement was cancelled or stopped before reaching the destination |
Success |
1 |
1 | script.enum-value.MovingState.Success |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:47 | Movement reached its requested destination successfully |
TargetNotFound |
2 |
2 | script.enum-value.MovingState.TargetNotFound |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:48 | Movement could not resolve the requested target |
TraceFailed |
11 |
11 | script.enum-value.MovingState.TraceFailed |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:56 | Path tracing could not produce a valid route |
MultihexGenerationType
enum MultihexGenerationType : uint8
Symbol ID: script.enum.MultihexGenerationType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1080
Policy for generating occupied hexes around a multihex prototype
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AnyUnique |
2 |
2 | script.enum-value.MultihexGenerationType.AnyUnique |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1085 | Coalesces compatible same-prototype items into distinct full-map groups without requiring adjacency |
None |
0 |
0 | script.enum-value.MultihexGenerationType.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1083 | Disables Mapper coalescing of item placements into a multihex mesh |
SameSibling |
1 |
1 | script.enum-value.MultihexGenerationType.SameSibling |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1084 | Coalesces spatially adjacent compatible sibling items into one incrementally grown multihex mesh |
PlayerProperty
enum PlayerProperty : uint16
Symbol ID: script.enum.PlayerProperty
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: -
Generated identifiers for properties exported by the Player script entity. Values are assigned in export order and are intended for property metadata and change notifications.
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
ControlledCritterId |
5 |
5 | script.enum-value.PlayerProperty.ControlledCritterId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:93 | Identifier of the critter currently controlled by this player; zero when none is attached |
CustomHolderEntry |
2 |
2 | script.enum-value.PlayerProperty.CustomHolderEntry |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:89 | For a custom entity, names the holder entry through which it is attached |
CustomHolderId |
1 |
1 | script.enum-value.PlayerProperty.CustomHolderId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
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 |
ExplicitlyPersistent |
3 |
3 | script.enum-value.PlayerProperty.ExplicitlyPersistent |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Entity.h:92 | Marks an entity as independently persistent rather than persistent only through containment by another entity |
LastControlledCritterId |
6 |
6 | script.enum-value.PlayerProperty.LastControlledCritterId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:96 | Persistent identifier of the most recently controlled critter, retained after detachment for restoration |
LoggedIn |
4 |
4 | script.enum-value.PlayerProperty.LoggedIn |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:90 | Reports whether this player connection has completed server login |
None |
0 |
0 | script.enum-value.PlayerProperty.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
- | Sentinel indicating that no Player property identifier is selected. |
RenderPrimitiveType
enum RenderPrimitiveType : uint8
Symbol ID: script.enum.RenderPrimitiveType
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Frontend/Rendering.h:98
Vertex assembly topology used when submitting primitive draw buffers
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
LineList |
1 |
1 | script.enum-value.RenderPrimitiveType.LineList |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Rendering.h:102 | Draws each pair of submitted vertices as an independent line segment |
LineStrip |
2 |
2 | script.enum-value.RenderPrimitiveType.LineStrip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Rendering.h:103 | Draws connected line segments and enables primitive restart where supported |
PointList |
0 |
0 | script.enum-value.RenderPrimitiveType.PointList |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Rendering.h:101 | Draws each submitted vertex as an independent point primitive |
TriangleList |
3 |
3 | script.enum-value.RenderPrimitiveType.TriangleList |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Rendering.h:104 | Draws each group of three submitted vertices as an independent triangle |
TriangleStrip |
4 |
4 | script.enum-value.RenderPrimitiveType.TriangleStrip |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Rendering.h:105 | Draws a connected triangle strip and enables primitive restart where supported |
ScrollDirection
enum ScrollDirection : uint8
Symbol ID: script.enum.ScrollDirection
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Common/Common.h:1090
The manual-scroll intent a view is currently under. Input decides it, the view consumes it, and the two
never share a field: a direction is a per-frame intent, not a value anyone configures
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Down |
0x08 |
8 | script.enum-value.ScrollDirection.Down |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1097 | Scroll toward the lower edge |
Left |
0x01 |
1 | script.enum-value.ScrollDirection.Left |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1094 | Scroll toward the left edge |
None |
0 |
0 | script.enum-value.ScrollDirection.None |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1093 | No manual-scroll direction is active |
Right |
0x02 |
2 | script.enum-value.ScrollDirection.Right |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1095 | Scroll toward the right edge |
Up |
0x04 |
4 | script.enum-value.ScrollDirection.Up |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:1096 | Scroll toward the upper edge |
TransparentEggSlot
enum TransparentEggSlot : uint8
Symbol ID: script.enum.TransparentEggSlot
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/SpriteManager.h:62
Selects one of the two simultaneous transparency-egg masks supported by sprite rendering
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Primary |
0 |
0 | script.enum-value.TransparentEggSlot.Primary |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/SpriteManager.h:65 | First transparency-egg mask evaluated for map sprites |
Secondary |
1 |
1 | script.enum-value.TransparentEggSlot.Secondary |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/SpriteManager.h:66 | Second independent transparency-egg mask evaluated for map sprites |
TransparentEggTarget
enum TransparentEggTarget : uint8
Symbol ID: script.enum.TransparentEggTarget
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: -
Source: Source/Client/SpriteManager.h:70
Which of the sprites standing in front of an egg's hex the egg cuts
| Value | Declared | Numeric | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
AnyOccluder |
0 |
0 | script.enum-value.TransparentEggTarget.AnyOccluder |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/SpriteManager.h:73 | Cut every sprite whose egg appearance places it before the egg |
Structure |
1 |
1 | script.enum-value.TransparentEggTarget.Structure |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/SpriteManager.h:74 | Cut walls and roofs only, leaving foreground props drawn |
Value Types
GamepadState
value type GamepadState
Symbol ID: script.value-type.GamepadState
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, float32, -, LeftStickX, +, float32, -, LeftStickY, +, float32, -, RightStickX, +, float32, -, RightStickY, +, float32, -, LeftTrigger, +, float32, -, RightTrigger, +, bool, -, Available, +, bool, -, South, +, bool, -, East, +, bool, -, West, +, bool, -, North, +, bool, -, Back, +, bool, -, Start, +, bool, -, LeftStickButton, +, bool, -, RightStickButton, +, bool, -, LeftShoulder, +, bool, -, RightShoulder, +, bool, -, DpadUp, +, bool, -, DpadDown, +, bool, -, DpadLeft, +, bool, -, DpadRight, +, bool, -, Reserved
Source: Source/Frontend/Application.h:199
Per-frame gamepad snapshot containing availability, stick and trigger values, face buttons, shoulders, sticks, and D-pad state
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
bool GamepadState.Available |
script.value-field.GamepadState.Available |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:183 | Reports whether the application currently has an opened gamepad |
bool GamepadState.Back |
script.value-field.GamepadState.Back |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:188 | Reports whether the back button is pressed |
bool GamepadState.DpadDown |
script.value-field.GamepadState.DpadDown |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:195 | Reports whether the D-pad down button is pressed |
bool GamepadState.DpadLeft |
script.value-field.GamepadState.DpadLeft |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:196 | Reports whether the D-pad left button is pressed |
bool GamepadState.DpadRight |
script.value-field.GamepadState.DpadRight |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:197 | Reports whether the D-pad right button is pressed |
bool GamepadState.DpadUp |
script.value-field.GamepadState.DpadUp |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:194 | Reports whether the D-pad up button is pressed |
bool GamepadState.East |
script.value-field.GamepadState.East |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:185 | Reports whether the east face button is pressed |
bool GamepadState.LeftShoulder |
script.value-field.GamepadState.LeftShoulder |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:192 | Reports whether the left shoulder button is pressed |
bool GamepadState.LeftStickButton |
script.value-field.GamepadState.LeftStickButton |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:190 | Reports whether the left-stick button is pressed |
float32 GamepadState.LeftStickX |
script.value-field.GamepadState.LeftStickX |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:177 | Left-stick horizontal axis normalized to -1 through 1 after the dead zone |
float32 GamepadState.LeftStickY |
script.value-field.GamepadState.LeftStickY |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:178 | Left-stick vertical axis normalized to -1 through 1 after the dead zone |
float32 GamepadState.LeftTrigger |
script.value-field.GamepadState.LeftTrigger |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:181 | Left-trigger pressure normalized to 0 through 1 after the dead zone |
bool GamepadState.North |
script.value-field.GamepadState.North |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:187 | Reports whether the north face button is pressed |
bool GamepadState.Reserved |
script.value-field.GamepadState.Reserved |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:198 | Reserved compatibility field; the current input backend leaves it false |
bool GamepadState.RightShoulder |
script.value-field.GamepadState.RightShoulder |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:193 | Reports whether the right shoulder button is pressed |
bool GamepadState.RightStickButton |
script.value-field.GamepadState.RightStickButton |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:191 | Reports whether the right-stick button is pressed |
float32 GamepadState.RightStickX |
script.value-field.GamepadState.RightStickX |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:179 | Right-stick horizontal axis normalized to -1 through 1 after the dead zone |
float32 GamepadState.RightStickY |
script.value-field.GamepadState.RightStickY |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:180 | Right-stick vertical axis normalized to -1 through 1 after the dead zone |
float32 GamepadState.RightTrigger |
script.value-field.GamepadState.RightTrigger |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:182 | Right-trigger pressure normalized to 0 through 1 after the dead zone |
bool GamepadState.South |
script.value-field.GamepadState.South |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:184 | Reports whether the south face button is pressed |
bool GamepadState.Start |
script.value-field.GamepadState.Start |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:189 | Reports whether the start button is pressed |
bool GamepadState.West |
script.value-field.GamepadState.West |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Frontend/Application.h:186 | Reports whether the west face button is pressed |
LanguageName
value type LanguageName
Symbol ID: script.value-type.LanguageName
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, hstring, -, Name
Source: Source/Common/TextPack.h:57
Hashed name that identifies a language in localized text resources
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
hstring LanguageName.Name |
script.value-field.LanguageName.Name |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TextPack.h:56 | Hashed language identifier used to select localized text resources |
TextFormat
value type TextFormat
Symbol ID: script.value-type.TextFormat
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, FontType, -, Font, +, FontFlag, -, Flags, +, int32, -, SkipLines
Source: Source/Client/FontManager.h:85
Bundled text formatting parameters: font slot, FontFlag bitmask, and skip-lines counter.SkipLines is "skip from top" by default; with FontFlag::AlignBottom set it becomes "skip from bottom" (trailing lines)
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
FontFlag TextFormat.Flags |
script.value-field.TextFormat.Flags |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:83 | FontFlag bitmask controlling alignment, wrapping, clipping, color tags, and glyph presentation |
FontType TextFormat.Font |
script.value-field.TextFormat.Font |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:82 | Font slot selected for text measurement and rendering |
int32 TextFormat.SkipLines |
script.value-field.TextFormat.SkipLines |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/FontManager.h:84 | Line-skip count taken from the top by default or from the bottom when AlignBottom is set |
TextPackKey
value type TextPackKey
Symbol ID: script.value-type.TextPackKey
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, TextPackName, -, Collection, +, hstring, -, Key1, +, hstring, -, Key2, +, hstring, -, Key3
Source: Source/Common/TextPack.h:65
Text lookup key composed of a collection name and up to three hashed key components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
TextPackName TextPackKey.Collection |
script.value-field.TextPackKey.Collection |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TextPack.h:61 | Text-pack collection in which the key is resolved |
hstring TextPackKey.Key1 |
script.value-field.TextPackKey.Key1 |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TextPack.h:62 | Primary hashed lookup-key component |
hstring TextPackKey.Key2 |
script.value-field.TextPackKey.Key2 |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TextPack.h:63 | Optional second hashed lookup-key component |
hstring TextPackKey.Key3 |
script.value-field.TextPackKey.Key3 |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TextPack.h:64 | Optional third hashed lookup-key component |
TextPackName
value type TextPackName
Symbol ID: script.value-type.TextPackName
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, hstring, -, Name
Source: Source/Common/TextPack.h:52
Hashed name that identifies a text-pack collection
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
hstring TextPackName.Name |
script.value-field.TextPackName.Name |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TextPack.h:51 | Hashed text-pack collection name |
fpos
value type fpos
Symbol ID: script.value-type.fpos
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, float32, -, x, +, float32, -, y
Source: Source/Essentials/ExtendedTypes.h:663
Two-dimensional 32-bit floating-point position exposed to scripts as mutable x and y components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
float32 fpos.x |
script.value-field.fpos.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:661 | 32-bit floating-point X position component |
float32 fpos.y |
script.value-field.fpos.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:662 | 32-bit floating-point Y position component |
frect
value type frect
Symbol ID: script.value-type.frect
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, float32, -, x, +, float32, -, y, +, float32, -, width, +, float32, -, height
Source: Source/Essentials/ExtendedTypes.h:683
32-bit floating-point rectangle exposed to scripts as mutable origin and size components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
float32 frect.height |
script.value-field.frect.height |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:682 | 32-bit floating-point rectangle height |
float32 frect.width |
script.value-field.frect.width |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:681 | 32-bit floating-point rectangle width |
float32 frect.x |
script.value-field.frect.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:679 | 32-bit floating-point X coordinate of the rectangle origin |
float32 frect.y |
script.value-field.frect.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:680 | 32-bit floating-point Y coordinate of the rectangle origin |
fsize
value type fsize
Symbol ID: script.value-type.fsize
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, float32, -, width, +, float32, -, height
Source: Source/Essentials/ExtendedTypes.h:672
Two-dimensional 32-bit floating-point size exposed to scripts as mutable width and height components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
float32 fsize.height |
script.value-field.fsize.height |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:671 | 32-bit floating-point height component |
float32 fsize.width |
script.value-field.fsize.width |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:670 | 32-bit floating-point width component |
hdir
value type hdir
Symbol ID: script.value-type.hdir
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int8, -, value
Source: Source/Common/Geometry.h:113
Discrete map direction normalized modulo the configured six-direction hex or eight-direction square geometry
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int8 hdir.value |
script.value-field.hdir.value |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Geometry.h:112 | Direction index normalized to 0 through the configured six- or eight-direction count minus one |
ident
value type ident
Symbol ID: script.value-type.ident
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int64, -, value
Source: Source/Common/Common.h:85
Strong signed 64-bit identity token whose zero value is false and whose ordering compares the stored value
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int64 ident.value |
script.value-field.ident.value |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:84 | Signed 64-bit identity payload; zero represents an empty identity |
ipos
value type ipos
Symbol ID: script.value-type.ipos
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int32, -, x, +, int32, -, y
Source: Source/Essentials/ExtendedTypes.h:631
Standard two-dimensional signed 32-bit integer position exposed to scripts as mutable x and y components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int32 ipos.x |
script.value-field.ipos.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:629 | Signed 32-bit X position component |
int32 ipos.y |
script.value-field.ipos.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:630 | Signed 32-bit Y position component |
ipos16
value type ipos16
Symbol ID: script.value-type.ipos16
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int16, -, x, +, int16, -, y
Source: Source/Essentials/ExtendedTypes.h:622
Two-dimensional signed 16-bit integer position exposed to scripts as mutable x and y components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int16 ipos16.x |
script.value-field.ipos16.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:620 | Signed 16-bit X position component |
int16 ipos16.y |
script.value-field.ipos16.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:621 | Signed 16-bit Y position component |
ipos8
value type ipos8
Symbol ID: script.value-type.ipos8
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int8, -, x, +, int8, -, y
Source: Source/Essentials/ExtendedTypes.h:613
Two-dimensional signed 8-bit integer position exposed to scripts as mutable x and y components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int8 ipos8.x |
script.value-field.ipos8.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:611 | Signed 8-bit X position component |
int8 ipos8.y |
script.value-field.ipos8.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:612 | Signed 8-bit Y position component |
irect
value type irect
Symbol ID: script.value-type.irect
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int32, -, x, +, int32, -, y, +, int32, -, width, +, int32, -, height
Source: Source/Essentials/ExtendedTypes.h:653
Signed 32-bit integer rectangle exposed to scripts as mutable origin and size components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int32 irect.height |
script.value-field.irect.height |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:652 | Signed 32-bit rectangle height |
int32 irect.width |
script.value-field.irect.width |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:651 | Signed 32-bit rectangle width |
int32 irect.x |
script.value-field.irect.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:649 | Signed 32-bit X coordinate of the rectangle origin |
int32 irect.y |
script.value-field.irect.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:650 | Signed 32-bit Y coordinate of the rectangle origin |
isize
value type isize
Symbol ID: script.value-type.isize
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int32, -, width, +, int32, -, height
Source: Source/Essentials/ExtendedTypes.h:641
Two-dimensional signed 32-bit integer size exposed to scripts as mutable width and height components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int32 isize.height |
script.value-field.isize.height |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:640 | Signed 32-bit height component |
int32 isize.width |
script.value-field.isize.width |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:639 | Signed 32-bit width component |
mdir
value type mdir
Symbol ID: script.value-type.mdir
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int16, -, angle
Source: Source/Common/Geometry.h:166
Map direction angle stored as a signed 16-bit value with conversion and rotation operations for discrete map directions
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int16 mdir.angle |
script.value-field.mdir.angle |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Geometry.h:165 | Direction angle in degrees normalized to the inclusive range 0 through 359 |
mpos
value type mpos
Symbol ID: script.value-type.mpos
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int16, -, x, +, int16, -, y
Source: Source/Common/Geometry.h:43
Signed 16-bit map-coordinate position exposed to scripts as mutable x and y components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int16 mpos.x |
script.value-field.mpos.x |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Geometry.h:41 | Signed X component of the map-cell coordinate |
int16 mpos.y |
script.value-field.mpos.y |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Geometry.h:42 | Signed Y component of the map-cell coordinate |
msize
value type msize
Symbol ID: script.value-type.msize
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int16, -, width, +, int16, -, height
Source: Source/Common/Geometry.h:60
Signed 16-bit map size exposed to scripts as mutable width and height components
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int16 msize.height |
script.value-field.msize.height |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Geometry.h:59 | Map height in addressable cells |
int16 msize.width |
script.value-field.msize.width |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Geometry.h:58 | Map width in addressable cells |
nanotime
value type nanotime
Symbol ID: script.value-type.nanotime
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int64, -, value
Source: Source/Essentials/TimeRelated.h:139
Monotonic steady-clock time point stored as a signed 64-bit nanosecond count; it is not civil wall-clock time
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int64 nanotime.value |
script.value-field.nanotime.value |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/TimeRelated.h:138 | Nanoseconds from the process-local monotonic steady-clock epoch; this is not civil wall-clock time |
synctime
value type synctime
Symbol ID: script.value-type.synctime
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int64, -, value
Source: Source/Essentials/TimeRelated.h:211
Engine-synchronized time point stored as a signed 64-bit millisecond count for shared game-time state
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int64 synctime.value |
script.value-field.synctime.value |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/TimeRelated.h:210 | Milliseconds in the Engine-synchronized game-time domain |
timespan
value type timespan
Symbol ID: script.value-type.timespan
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, int64, -, value
Source: Source/Essentials/TimeRelated.h:49
Signed nanosecond-resolution duration stored as a 64-bit count
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
int64 timespan.value |
script.value-field.timespan.value |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/TimeRelated.h:48 | Signed duration count in nanoseconds |
ucolor
value type ucolor
Symbol ID: script.value-type.ucolor
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: Layout, =, uint32, -, value
Source: Source/Essentials/ExtendedTypes.h:68
Color type
| Field | Symbol ID | Value contract | API contract | Source | Description |
|---|---|---|---|---|---|
uint32 ucolor.value |
script.value-field.ucolor.value |
value | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Essentials/ExtendedTypes.h:67 | Packed 32-bit RGBA storage used for equality, ordering, hashing, and script transfer |
Reference Types
FogLayer
ref type FogLayer
Symbol ID: script.ref-type.client.FogLayer
Runtime: client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: RefCounted, Export, =, Enabled, ,, Distance, ,, Radius, ,, ExtraLength, ,, TransitionDuration, ,, OvalRoundness, ,, EdgeNoise, ,, Depth, ,, ClearRadius, ,, TintColor, ,, OverlayColor, ,, CenterColor, ,, Traced, ,, CheckShootBlocks, ,, OriginHex, ,, Disposed, ,, Dispose
Source: Source/Client/MapView.h:99
Map-owned fog or traced-zone layer whose shape and compositing parameters are rebuilt from mutable script fields each frame
| Kind | Member | Symbol ID | Member contract | API contract | Source | Description |
|---|---|---|---|---|---|---|
| ref-field | ucolor FogLayer.CenterColor |
script.ref-field.client.FogLayer.CenterColor |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Traced-overlay center color |
| ref-field | bool FogLayer.CheckShootBlocks |
script.ref-field.client.FogLayer.CheckShootBlocks |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Includes shoot-blocking map geometry when tracing the fog boundary |
| ref-field | float32 FogLayer.ClearRadius |
script.ref-field.client.FogLayer.ClearRadius |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Fraction kept crisp before the edge fade (lower = wider border) |
| ref-field | float32 FogLayer.Depth |
script.ref-field.client.FogLayer.Depth |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Extra darkening with distance past the edge |
| ref-method | void FogLayer.Dispose() |
script.ref-method.client.FogLayer.Dispose |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Marks this layer for removal during the map's next fog preparation pass; repeated calls are harmless |
| ref-field | bool FogLayer.Disposed |
script.ref-field.client.FogLayer.Disposed |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Script-readable status: true once Dispose() ran or the owning map was destroyed (recreate then) |
| ref-field | int32 FogLayer.Distance |
script.ref-field.client.FogLayer.Distance |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Zone reach in hexes (traced overlay); 0 = derive from the look distance |
| ref-field | float32 FogLayer.EdgeNoise |
script.ref-field.client.FogLayer.EdgeNoise |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Drifting-mist rim ripple strength |
| ref-field | bool FogLayer.Enabled |
script.ref-field.client.FogLayer.Enabled |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Enables shape generation while preserving transition state when toggled |
| ref-field | int32 FogLayer.ExtraLength |
script.ref-field.client.FogLayer.ExtraLength |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Extra look length added to the derived radius |
| ref-field | mpos FogLayer.OriginHex |
script.ref-field.client.FogLayer.OriginHex |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Origin for a hex-anchored fog (ignored when following a critter) |
| ref-field | float32 FogLayer.OvalRoundness |
script.ref-field.client.FogLayer.OvalRoundness |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | 0 = raw hexagon, 1 = full smooth oval |
| ref-field | ucolor FogLayer.OverlayColor |
script.ref-field.client.FogLayer.OverlayColor |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Traced-overlay (zone) color |
| ref-field | int32 FogLayer.Radius |
script.ref-field.client.FogLayer.Radius |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Look radius in hexes; 0 = use the origin critter's look distance |
| ref-field | ucolor FogLayer.TintColor |
script.ref-field.client.FogLayer.TintColor |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Cold dim tint of the unseen area (rgb used; a ignored) |
| ref-field | bool FogLayer.Traced |
script.ref-field.client.FogLayer.Traced |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Positive traced overlay (attack/observation zone) vs inverse look fog |
| ref-field | int32 FogLayer.TransitionDuration |
script.ref-field.client.FogLayer.TransitionDuration |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:99 | Grow/move/shrink morph duration in ms |
MapSpriteHolder
ref type MapSpriteHolder
Symbol ID: script.ref-type.client.MapSpriteHolder
Runtime: client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: RefCounted, HasFactory, Export, =, Valid, ,, SprId, ,, Hex, ,, ProtoId, ,, Offset, ,, IsFlat, ,, NoLight, ,, DrawOrder, ,, DrawOrderSubLayer, ,, Corner, ,, DisableEgg, ,, Color, ,, IsTweakOffs, ,, TweakOffset, ,, IsTweakAlpha, ,, TweakAlpha, ,, Angle, ,, MapProjected, ,, StopDraw
Source: Source/Client/MapSprite.h:230
Script-configured holder for a client-local map sprite added by Map.DrawMapSprite and kept alive until invalidated or stopped
| Kind | Member | Symbol ID | Member contract | API contract | Source | Description |
|---|---|---|---|---|---|---|
| ref-field | int16 MapSpriteHolder.Angle |
script.ref-field.client.MapSpriteHolder.Angle |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Initial sprite angle in degrees applied when nonzero |
| ref-field | ucolor MapSpriteHolder.Color |
script.ref-field.client.MapSpriteHolder.Color |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Optional packed color and fixed alpha applied at attachment; clear leaves the sprite color unchanged |
| ref-field | CornerType MapSpriteHolder.Corner |
script.ref-field.client.MapSpriteHolder.Corner |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Manual corner classification used for lighting and egg appearance when ProtoId is empty |
| ref-field | bool MapSpriteHolder.DisableEgg |
script.ref-field.client.MapSpriteHolder.DisableEgg |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Manual switch that suppresses egg appearance when ProtoId is empty |
| ref-field | DrawOrderType MapSpriteHolder.DrawOrder |
script.ref-field.client.MapSpriteHolder.DrawOrder |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Manual draw-order slot used when ProtoId is empty |
| ref-field | int8 MapSpriteHolder.DrawOrderSubLayer |
script.ref-field.client.MapSpriteHolder.DrawOrderSubLayer |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Fine ordering within DrawOrder used when ProtoId is empty |
| ref-field | mpos MapSpriteHolder.Hex |
script.ref-field.client.MapSpriteHolder.Hex |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Map hex used as the sprite anchor and visibility test |
| ref-field | bool MapSpriteHolder.IsFlat |
script.ref-field.client.MapSpriteHolder.IsFlat |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Manual flat-sprite selection used when ProtoId is empty |
| ref-field | bool MapSpriteHolder.IsTweakAlpha |
script.ref-field.client.MapSpriteHolder.IsTweakAlpha |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Enables live alpha tracking through TweakAlpha after attachment |
| ref-field | bool MapSpriteHolder.IsTweakOffs |
script.ref-field.client.MapSpriteHolder.IsTweakOffs |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Enables live offset tracking through TweakOffset after attachment |
| ref-field | bool MapSpriteHolder.MapProjected |
script.ref-field.client.MapSpriteHolder.MapProjected |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Requests map-projected rendering when the sprite is attached |
| ref-field | bool MapSpriteHolder.NoLight |
script.ref-field.client.MapSpriteHolder.NoLight |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Manual lighting bypass used when ProtoId is empty |
| ref-field | ipos MapSpriteHolder.Offset |
script.ref-field.client.MapSpriteHolder.Offset |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Base map-pixel offset applied when the sprite is attached |
| ref-field | hstring MapSpriteHolder.ProtoId |
script.ref-field.client.MapSpriteHolder.ProtoId |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Optional item prototype whose color, flattening, lighting, draw order, corner, and egg settings override the corresponding holder fields |
| ref-field | uint32 MapSpriteHolder.SprId |
script.ref-field.client.MapSpriteHolder.SprId |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Sprite resource handle resolved when Map.DrawMapSprite attaches the holder |
| ref-method | void MapSpriteHolder.StopDraw() |
script.ref-method.client.MapSpriteHolder.StopDraw |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Invalidates the attached map sprite, sets Valid to false through its callback, and detaches this holder; repeated calls are harmless |
| ref-field | uint8 MapSpriteHolder.TweakAlpha |
script.ref-field.client.MapSpriteHolder.TweakAlpha |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Mutable alpha read by the attached sprite while IsTweakAlpha was enabled at attachment |
| ref-field | ipos MapSpriteHolder.TweakOffset |
script.ref-field.client.MapSpriteHolder.TweakOffset |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Mutable map-pixel offset read by the attached sprite while IsTweakOffs was enabled at attachment |
| ref-field | bool MapSpriteHolder.Valid |
script.ref-field.client.MapSpriteHolder.Valid |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapSprite.h:230 | Reports whether the attached map sprite remains valid; the sprite writes false when invalidated |
MovingContext
ref type MovingContext
Symbol ID: script.ref-type.common.MovingContext
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: RefCounted, Export, =, GetSpeed, ,, GetStartHex, ,, GetEndHex, ,, GetStartHexOffset, ,, GetEndHexOffset, ,, GetPreBlockHex, ,, GetBlockHex, ,, GetWholeTime, ,, GetWholeDist, ,, GetElapsedTime, ,, IsCompleted, ,, GetCompleteReason, ,, EvaluateProjectedHex, ,, EvaluateNearestPathHex, ,, EvaluatePathHexes
Source: Source/Common/Movement.h:88
Shared movement-path state containing route geometry, timing, offsets, blocking information, and current completion progress
| Kind | Member | Symbol ID | Member contract | API contract | Source | Description |
|---|---|---|---|---|---|---|
| ref-method | mpos MovingContext.EvaluateNearestPathHex(mpos current_hex, mpos from_hex, mpos fallback_hex) |
script.ref-method.common.MovingContext.EvaluateNearestPathHex |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the route hex at or after current_hex nearest to from_hex, falling back to fallback_hex when no closer path point exists |
| ref-method | mpos[] MovingContext.EvaluatePathHexes(mpos current_hex) |
script.ref-method.common.MovingContext.EvaluatePathHexes |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns route hexes from current_hex through the available path end, or a current/end pair for a route without stored steps |
| ref-method | mpos MovingContext.EvaluateProjectedHex(float32 look_ahead_ms) |
script.ref-method.common.MovingContext.EvaluateProjectedHex |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Evaluates the route hex at the stored elapsed time plus a nonnegative look-ahead interval in milliseconds |
| ref-method | mpos MovingContext.GetBlockHex() |
script.ref-method.common.MovingContext.GetBlockHex |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the blocking hex recorded for the route |
| ref-method | MovingState MovingContext.GetCompleteReason() |
script.ref-method.common.MovingContext.GetCompleteReason |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the reason supplied when the movement was completed |
| ref-method | float32 MovingContext.GetElapsedTime() |
script.ref-method.common.MovingContext.GetElapsedTime |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the stored elapsed movement time in milliseconds |
| ref-method | mpos MovingContext.GetEndHex() |
script.ref-method.common.MovingContext.GetEndHex |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the final map hex obtained from the stored route steps |
| ref-method | ipos16 MovingContext.GetEndHexOffset() |
script.ref-method.common.MovingContext.GetEndHexOffset |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the map-pixel offset applied at the route's final hex |
| ref-method | mpos MovingContext.GetPreBlockHex() |
script.ref-method.common.MovingContext.GetPreBlockHex |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the last reachable hex recorded immediately before a blocking hex |
| ref-method | uint16 MovingContext.GetSpeed() |
script.ref-method.common.MovingContext.GetSpeed |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the movement speed used to derive route timing |
| ref-method | mpos MovingContext.GetStartHex() |
script.ref-method.common.MovingContext.GetStartHex |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the first map hex of the stored route |
| ref-method | ipos16 MovingContext.GetStartHexOffset() |
script.ref-method.common.MovingContext.GetStartHexOffset |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the map-pixel offset applied at the route's starting hex |
| ref-method | float32 MovingContext.GetWholeDist() |
script.ref-method.common.MovingContext.GetWholeDist |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the total projected map-pixel distance across all control-step segments |
| ref-method | float32 MovingContext.GetWholeTime() |
script.ref-method.common.MovingContext.GetWholeTime |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns the total route duration in milliseconds after speed and endpoint offsets are applied |
| ref-method | bool MovingContext.IsCompleted() |
script.ref-method.common.MovingContext.IsCompleted |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Movement.h:88 | Returns whether the movement has been explicitly completed |
SpritePattern
ref type SpritePattern
Symbol ID: script.ref-type.client.SpritePattern
Runtime: client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: RefCounted, Export, =, Finished, ,, EveryHex, ,, InteractWithRoof, ,, CheckTileProperty, ,, TileProperty, ,, ExpectedTilePropertyValue, ,, Finish
Source: Source/Client/MapView.h:76
Map-owned controller that places copies of a named sprite on matching visible hexes until finished or the map is destroyed
| Kind | Member | Symbol ID | Member contract | API contract | Source | Description |
|---|---|---|---|---|---|---|
| ref-field | bool SpritePattern.CheckTileProperty |
script.ref-field.client.SpritePattern.CheckTileProperty |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Enables the required ground-tile property filter; false currently suppresses all pattern placement |
| ref-field | ipos SpritePattern.EveryHex |
script.ref-field.client.SpritePattern.EveryHex |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Positive nonzero X/Y hex intervals used as modulo divisors when selecting placement cells |
| ref-field | int32 SpritePattern.ExpectedTilePropertyValue |
script.ref-field.client.SpritePattern.ExpectedTilePropertyValue |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Integer value that the selected ground-tile property must equal for sprite placement |
| ref-method | void SpritePattern.Finish() |
script.ref-method.client.SpritePattern.Finish |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Clears the pattern sprites and marks the controller finished; repeated calls are harmless |
| ref-field | bool SpritePattern.Finished |
script.ref-field.client.SpritePattern.Finished |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Reports whether Finish has stopped this pattern and released its sprite instances |
| ref-field | bool SpritePattern.InteractWithRoof |
script.ref-field.client.SpritePattern.InteractWithRoof |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Makes hidden roofs suppress the pattern and places matching roof sprites in the roof-particle draw order |
| ref-field | ItemProperty SpritePattern.TileProperty |
script.ref-field.client.SpritePattern.TileProperty |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/MapView.h:76 | Ground-tile item property read when CheckTileProperty is enabled |
TimeEventContext
ref type TimeEventContext
Symbol ID: script.ref-type.common.TimeEventContext
Runtime: server, client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: RefCounted, Export, =, GetId, ,, GetData, ,, GetDataArray, ,, HasData, ,, IsStopped, ,, GetRepeat, ,, Stop, ,, Repeat, ,, SetData, ,, SetDataArray
Source: Source/Common/TimeEvents.h:47
Transient callback context for inspecting and changing the time event that is currently firing; requested changes are applied after the callback returns
| Kind | Member | Symbol ID | Member contract | API contract | Source | Description |
|---|---|---|---|---|---|---|
| ref-method | any TimeEventContext.GetData() |
script.ref-method.common.TimeEventContext.GetData |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Returns the first payload value, or an empty any value when the event has no payload |
| ref-method | any[] TimeEventContext.GetDataArray() |
script.ref-method.common.TimeEventContext.GetDataArray |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Returns a copy of the complete payload array visible to this callback |
| ref-method | uint32 TimeEventContext.GetId() |
script.ref-method.common.TimeEventContext.GetId |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Returns the unique identifier of the event currently invoking the callback |
| ref-method | timespan TimeEventContext.GetRepeat() |
script.ref-method.common.TimeEventContext.GetRepeat |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Returns the current repeat interval, including a value assigned by Repeat during this callback |
| ref-method | bool TimeEventContext.HasData() |
script.ref-method.common.TimeEventContext.HasData |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Returns whether the callback context currently contains at least one payload value |
| ref-method | bool TimeEventContext.IsStopped() |
script.ref-method.common.TimeEventContext.IsStopped |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Returns whether Stop has been requested through this callback context |
| ref-method | void TimeEventContext.Repeat(timespan repeat) |
script.ref-method.common.TimeEventContext.Repeat |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Replaces the repeat interval and schedules the next firing from callback completion, clamped to the Engine minimum interval |
| ref-method | void TimeEventContext.SetData(any data) |
script.ref-method.common.TimeEventContext.SetData |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Replaces the event payload with one value after the callback returns |
| ref-method | void TimeEventContext.SetDataArray(any[] data) |
script.ref-method.common.TimeEventContext.SetDataArray |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Replaces the complete event payload with a copy of the supplied array after the callback returns |
| ref-method | void TimeEventContext.Stop() |
script.ref-method.common.TimeEventContext.Stop |
callable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/TimeEvents.h:47 | Marks the current event for removal after the callback returns |
VideoPlayback
ref type VideoPlayback
Symbol ID: script.ref-type.client.VideoPlayback
Runtime: client, mapper
Contract: experimental (scope)
since 2022.1.0.wip
contract source: Source/Common/Common.h:47
Flags: RefCounted, Export, =, Stopped
Source: Source/Client/Client.h:77
Script-owned controller for a video clip and render texture created by Game.CreateVideoPlayback and advanced by Game.DrawVideoPlayback
| Kind | Member | Symbol ID | Member contract | API contract | Source | Description |
|---|---|---|---|---|---|---|
| ref-field | bool VideoPlayback.Stopped |
script.ref-field.client.VideoPlayback.Stopped |
mutable | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Client/Client.h:77 | Becomes true after DrawVideoPlayback observes that the underlying clip has stopped and releases its playback resources |