GameEntityScriptDefinition

Class Documentation

Edit documentation

One script of a map entity and the values of its instance variables. When the entity spawns, the client creates an instance of Script for the entity. For each instance variable of the script, it evaluates the getter in InstanceVariableOverrides with the same key, or the default getter of the script if there is none.

Notes

• Override keys that the script does not declare are ignored.
• If a getter produces no value, the client logs a script error.
• No shipped object uses it.

Properties

InstanceVariableOverrides

Map<Hash, IScriptValueGet> = {}

Documentation Edit documentation

Getters for instance variables of the script, keyed by the same hash as the variable in the InstanceVariables of the script. Each one replaces the default of the variable for this entity. See IScriptValueGet.

Script

Link<GameEntityScriptBase> = "0x0"

Type history (2 revisions)

• 14.24 - 16.9 Link<GameEntityScript>
• since 16.10 Link<GameEntityScriptBase>

Documentation Edit documentation

The entity script. If it is not set, the client skips the entry.

Referenced by 2 classes · 2 properties

• AddScriptToEntity ScriptDef Embed<GameEntityScriptDefinition>
• ScriptHelperDef Scripts List2<GameEntityScriptDefinition>

InstanceVariableOverrides

Script