Act_Append

Parameters

Required:

Parameter1: A string containing text to display.

Optional:

instant: A boolean describing whether the script should push all characters instantly or not, defaults to false.

wait: A boolean describing whether the script should wait for user input when done or not, defaults to true.

mute: A boolean describing whether Oyster should play any speech sounds while text is being pushed, defaults to false.

Functionality

Appends the given text to the end of the main text box.

When not muted, plays back a random sound from the character’s CharacterSound component at a fixed rate while text is being pushed. Defaults to 2.5x the rate at which characters are pushed to the text display. Setting the integer variable mumblesPerSecond earlier in the script than an act command will override this default behaviour such that the time between sounds is one divided by mumblesPerSecond.

Examples

Act_Append ["Hello, I will output some text"]

Will output the given text and then wait for a ‘Nudge’ before continuing, plus pushes each character one at a time.

Act_Append ["Hello, I will output some text", instant=True, mute=True]

Will output the given text in its entirety in one tick, then wait for a ‘Nudge’ before continuing.

Version Info

This command has been supported as of Oyster 4.0.0.