User Tools

Site Tools


commands:deprecated_commands

The following commands are described for completeness only - they remain in Wintermute for backwards compatibility, and should not be used going forward.

zone_test: {name} | {condition}

Returns an OSC command in the form {name}_true or {name}_false depending on the truth value of the condition.

  • name is the name of the test to be appended to the return cue
  • condition is a statement in same form as condition prefixes to commands. Multiple condition fields can be added separated by the | symbol, and the truth value is the logical AND of all the conditions.

Use of this command should be deprecated in favour of using return_cue with a conditional prefix.

zone_status: {name} | {status} | log

Sets the status of a previously created zone

  • name is the name of the zone to be set
  • status is the value to set it to
  • log is a flag that means that this status will be added to the history stack for this zone (optional)

Use of this command should be deprecated in favour of using set; the functionality is identical, but the command was changed to align with how variables are handled

deck_makekey: {name} | {text}

Used to create a new key Imageset with the given name and text; this now just creates an alias dictionary for reverse compatibility.

  • name is the name for the image set
  • text is the text displayed on the key

zone_history: {zone}

Prints the history of logged statuses for the named zone to the System Log; this should generally only be used for programming/debugging

  • zone is the name of the zone to print out logged statuses for

Use of this command should be deprecated in favour of using history.

variable_increment: {zone}.{variable} | {value}

Assuming the given zone variable is an integer, increments it by the given value

  • zone is the name of the zone containing the variable
  • variable is the name of the variable
  • value is the value to increment the variable by; it can be negative

Use of this command should be deprecated in favour of using increment.

zone_set: {zone} | {status} | log

Sets the status of a previously created zone

  • zone is the name of the zone to be set
  • status is the value to set it to
  • log is a tag that means that this status will be added to the history stack for this zone (optional)

Use of this command should be deprecated in favour of using set.

variable_set: {zone}.{variable} | {value}

Sets the value of a previously created variable

  • zone is the name of the zone containing the variable
  • variable is the name of the variable
  • value is the value this variable is set to

Use of this command should be deprecated in favour of using set.

node_setuifonts: {name} | {small} | {medium} | {large} | {button}

node_setuiheights: {name} | {chat} | {data}

These are for developer use only.

commands/deprecated_commands.txt · Last modified: 2024/09/20 07:47 by 127.0.0.1