Files
gymkhana-actions/docs/api/SayCommand.md
2021-10-27 06:35:05 +00:00

971 B

SayCommand

Extends: ESCBaseCommand < Node

Description

say player text [type]

Runs the specified string as a dialog said by the player. Blocks execution until the dialog finishes playing.

The text supports translation keys by prepending the key and separating it with a : from the text.

Example: say player ROOM1_PICTURE:"Picture's looking good."

Optional parameters:

  • "type" determines the type of dialog UI to use. Default value is "default"

@ESC

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

validate

func validate(arguments: Array)

Validate wether the given arguments match the command descriptor

run

func run(command_params: Array) -> var

Run the command