Action Item Enums

8# Action Item Enums

Companion page to Action Items. This page documents every enum referenced by a class in com.jopre.streamlink.action.type (either directly, or through a nested supporting type such as Equipment).

Most of these enums are annotated with Gson's @SerializedName, which means the JSON value written in a config file can differ from the Java constant name. Where an enum has no @SerializedName annotations, Gson falls back to the raw enum constant name (see VariableMathOperation below for the one case where that applies).

`ActionItemType`

Package: com.jopre.streamlink.action · Discriminator field: itemType (present on every Action Item — see Action Items → Common Fields)

Constant	JSON Value	Action Item Class	Description
`COMMAND_ACTION`	`command-action`	`CommandActionItem`	This will run a minecraft command on the server
`TOAST_ACTION`	`toast-action`	`ToastActionItem`	Perform a Minecraft toast
`MONSTER_ACTION`	`monster-action`	`MonsterActionItem`	Summon a mob (hostile or passive)
`EFFECT_ACTION`	`effect-action`	`EffectActionItem`	Gives the targetted Player an effect
`GIVE_ACTION`	`give-action`	`GiveActionItem`	Give the Player an item
`CHAT_ACTION`	`chat-action`	`ChatActionItem`	Send a message to the client chat
`MOVE_PLAYER`	`move-player`	`MovePlayerActionItem`	Move The Player along the x, y or z planes
`PLAY_SOUND`	`play-sound`	`PlaySoundActionItem`	Play a sound
`VARIABLE_STORAGE`	`variable-storage`	`VariableStorageActionItem`	Declares a variable
`SLEEP_ACTION`	`sleep`	`SleepActionItem`	TODO: Pause the execution of an action
`VARIABLE_MATH`	`variable-math`	`VariableMathActionItem`	Performs arithmetic operations on a variable
`VARIABLE_PERSISTENCE`	`variable-persistence`	`VariablePersistenceActionItem`	Loads Variables to Disk or Loads them for Disk
`VARIABLE_VALUE`	`variable-value`	`VariableValueActionItem`	Set the value to a variable already declared

`TimeUnits`

Package: com.jopre.streamlink.action · Used by: SleepActionItem (timeUnit field)

Constant	JSON Value	Description
`SLEEP_TIME_TICKS`	`ticks`	Duration in minecraft ticks
`SLEEP_TIME_SECONDS`	`seconds`	Duration in real life sections
`SLEEP_TIME_MINUTES`	`minutes`	Duration in real life minutes

`VariableMathOperation`

Package: com.jopre.streamlink.action.type · Used by: VariableMathActionItem (operation field)

Constant	JSON Value	Description
`ADDITION`	`ADDITION`	Addition of two values
`SUBTRACTION`	`SUBTRACTION`	Subtration of two values.
`MULTIPLICATION`	`MULTIPLICATION`	Multiply two values
`DIVISION`	`DIVISION`	Divide two values
`MIN`	`DIVISION`	Get the minimum value of two values
`MAX`	`DIVISION`	_Get the maximum value of two values

`VariableDataType`

Package: com.jopre.streamlink.variable · Used by: VariableStorageActionItem (dataType)

Constant	JSON Value	Description
`STRING`	`string`	Data Type to store string values
`INTEGER`	`integer`	Data type to store Whole numbers
`DECIMAL`	`decimal`	Data type to store floating point number (e.g. 3.14)
`BOOLEAN`	`boolean`	Stores TRUE or FALSE values

`VariableScope`

Package: com.jopre.streamlink.variable · Used by: VariableStorageActionItem (variableScope field)

Constant	JSON Value	Description
`PROVIDER`	`provider`	Variables that are sent from a provider (like twitch, etc)
`ACTION`	`action`	Variables that will only be around for a specific action being executed
`EVENT`	`event`	Variables that will have scope when processing an event from a provider
`GLOBAL`	`global`	Variables that will have scope outside the events from a provider
`SYSTEM`	`system`	Reserved for variables created in streamlink

`EquipmentSlot`

Package: com.jopre.streamlink.action.items · Used by: Equipment.slot, a supporting type referenced by GiveActionItem (itemToGive) and MonsterActionItem (equipment)

Constant	JSON Value	Description
`HEAD`	`head`	Mob head equipment slot
`BODY`	`body`	Mob body equipment slot
`LEGS`	`legs`	Mob legs equipment slot
`FEET`	`feet`	Mob feet equipment slot
`MAIN_HAND`	`main-hand`	The Mobs main hand slot
`OFF_HAND`	`off-hand`	The Mobs off-hand slot