SayCommand

Extends: ESCBaseCommand < Node

Description

say player text [type]

Displays the specified string as dialog spoken by the player. This command blocks further event execution until the dialog has finished being ‘said’ (either as displayed text or as audible speech from a file).

Global variables can be substituted into the text by wrapping the global name in braces. e.g. say player “I have {coin_count} coins remaining”.

Parameters

  • player: Global ID of the ESCPlayer or ESCItem object that is active

  • text: Text to display

  • type: Dialog type to use. One of floating or avatar (default: the value set in the setting “Escoria/UI/Default Dialog Type”)

The text supports translation keys by prepending the key followed by a colon (:) to the text. For more details see: https://docs.escoria-framework.org/en/devel/getting_started/dialogs.html#translations

Playing an audio file while the text is being displayed is also supported by this mechanism. For more details see: https://docs.escoria-framework.org/en/devel/getting_started/dialogs.html#recorded_speech

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

@ESC

Property Descriptions

globals_regex

var globals_regex: RegEx

Regex to match global variables in strings

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

validate

func validate(arguments: Array)

Validate whether the given arguments match the command descriptor

run

func run(command_params: Array) -> var

Run the command

interrupt

func interrupt()

Function called when the command is interrupted.