ExecuteFunctionEntityBlock

Inheritance 2 ancestors · 35 siblings

IScriptBlock
- GameEntityBlock

Class Documentation

A game entity block that calls a function of a script that runs on the Target entity.

The block finds the script instance on the entity by its script hash, then the function in that script by its name. It runs the function with FunctionDefinition and Sequence, which have the same meaning as on IRunFunctionBlock.

The block raises a script error in these cases:

The entity is inactive and AllowInactive is false.
The entity does not support scripting.
The entity has no instance of the script, or the script has no function with that name.

Properties

AllowInactive

Bool = false

Documentation Edit documentation

If true, the block also calls the function on an inactive entity. If false, an inactive entity is a script error.

FunctionDefinition

Embed<0x2a2c82dc>

Default value

{
  "FunctionInputs": {},
  "0xc7adc150": {},
  "FunctionOutputs": {}
}

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

PassThroughParameters

Map<Hash, IScriptValueGet> = {}

Documentation Edit documentation

Not read by the client.

Sequence

Embed<ScriptSequence> = { "blocks": [] }

16.7

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

Target

Pointer<IEntityGet> = null

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

callback

Embed<0xf6e1bec7> = { "Script": "0x0", "FunctionName": "0x0" }

Documentation Edit documentation

The function to call: Script is the hash of the entity script and FunctionName the hash of the function name. If Script is 0, the block uses the entity script that is running.