SpawnCommand

Description

spawn(identifier: String, path: String[, is_active: Boolean[, position_target: String]])

Programmatically adds a new item to the scene.

Name	Type	Description	Required?
identifier	`String`	Global ID to use for the new object	yes
path	`String`	Path to the scene file of the object	yes
is_active	`Boolean`	Whether the new object should be set to active (default: `true`)	no
position_target	`String`	Global ID of another object that will be used to position the new object (when omitted, the new object’s position is not specified)	no

func configure() -> ESCCommandArgumentDescriptor

The descriptor of the arguments of this command.

None.

Returns the descriptor of the arguments of this command. The argument descriptor for this command. (ESCCommandArgumentDescriptor)

func validate(arguments: Array) -> Variant

Validates whether the given arguments match the command descriptor.

Name	Type	Description	Required?
arguments	`Array`	The arguments to validate.	yes

Returns True if the arguments are valid, false otherwise. (bool)

func run(command_params: Array) -> int

Runs the command.

Name	Type	Description	Required?
command_params	`Array`	The parameters for the command.	yes

Returns the execution result code. (int)

func interrupt() -> void

Function called when the command is interrupted.

None.

Returns nothing.