Yarn Commands

Since we are using Yarn for handling dialogue, we have to create some ways for Yarn to be able to interact with the game code and call for certain actions. We do this through Yarn commands.

Here are the commands we have created for KeyWave:

Command	Argument Type(s)	Description
<<deliver_email subject>>	string	Sends an email (identified by subject argument) to the player.
<<player_sendtext recipient message>>	string	Sends a text message on behalf of the player to a named character.
<<player_receivetext sender message>>	string	Sends a text message to the player on behalf of a named character.
<<enable_contact contactName>>	string	Adds a contact for a character that can be phone called.
<<activate_assignment name>>	string	Activates an assignment with the given name for the player.
<<complete_assignment name>>	string	Completes an assignment with the given name for the player. Must be an active assignment.
<<delegate_assignment name characterName>>	string	Attempts to delegate assignment with the given name to a character with the given name.
<<undelegate_assignment name characterName>>	string	Attempts to undelegate assignment with the given name from a character with the given name.
<<toggle_delegation name enabled>>	string, bool	Enables or disabled the ability for a character by that name to be delegated assignments.
<<fail_assignment name>>	string	Fails an assignment with the given name for the player. Must be an active assignment.
<<play_clip clipName>>	string	Plays an audio sound effect clip.
<<play_background_clip clipName>>	string	Plays an audio background sound clip (music, ambiance, etc).
<<play_random_clip categoryName>>	string	Plays a random sound effect clip from that category.