Added a (non-comprehensive) action list
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Stub}}
'''Actions''' are a Housing feature that allows you to run code on a player with special blocks and items added through a GUI. Actions are able to do things such as teleporting the player, sending a chat message to them, updating stats among many other things. They were originally added on the 20th of August, 2020 alongside the Action Pad. There are currently over 30 unique actions all with their own options and use cases.
'''Actions''' are a Housing feature that allows you to run code on a player with special blocks and items added through a GUI. Actions are able to do things such as teleporting the player, sending a chat message to them, updating stats among many other things. They were originally added on the 20th of August, 2020 alongside the Action Pad. There are currently over 30 unique actions all with their own options and use cases.


== Standard Actions ==
== List of actions ==
Below are all of the available actions in Housing with their ingame description and contexts in which they are available. To prevent confusion, we will be listing an action as being available in all contexts even if they are not included in the Player Quit event.


Conditionals and Random Actions cannot be nested within one another.
{| class="wikitable sortable"
{| class="wikitable sortable"
! Action Name !! Available in Item Actions !! Has Edit Menu !! class="unsortable"|Definition/Usage
! Name !! class="unsortable" |Ingame Description
!Available Contexts
|-
| Conditional || Use conditions to only execute the provided actions when all the conditions are met by the player.
|All, except item and nested actions
|-
| Change Player's Group ||
|All, except Item Actions and the Player Change Group event
|-
| Kill Player ||
|All, except in any Event Actions
|-
| Full Heal ||
|All
|-
| Display Title ||
|All
|-
| Display Action Bar ||
|All
|-
|-
| Conditional || No || Yes || An container for an Action Chain to run when certain conditions are met
| Reset Inventory ||
|All
|-
|-
| Change Player's Group || No || Yes || See [[Groups]]
| Change Max Health ||
|All
|-
|-
| Kill Player || Yes || No || No description provided.
| Parkour Checkpoint || Teleports the player back to the last parkour checkpoint. Teleports them to the start if they are not currently in the parkour.
|All
|-
|-
| Full Heal || Yes || No || No description provided.
| Give Item ||
|All, except item actions
|-
|-
| Display Title || Yes || Yes || No description provided.
| Remove Item ||
|All, except item actions
|-
|-
| Display Action Bar || Yes || Yes || No description provided.
| Send a Chat Message ||
|All
|-
|-
| Reset Inventory || Yes || No || No description provided.
| Apply Potion Effect ||
|All
|-
|-
| Change Max Health || Yes || Yes || No description provided.
| Clear All Potion Effects ||
|All
|-
|-
| Parkour Checkpoint || Yes || No || No description provided.
| Give Experience Levels ||
|All
|-
|-
| Give Item || No || Yes || No description provided.
| Send to Lobby ||
|All
|-
|-
| Remove Item || No* || Yes || No description provided.
| Change Player Stat || Modify a stat of the player who triggered the action.
|All
|-
|-
| Send a Chat Message || Yes || Yes || No description provided.
| Change Global Stat || Modify a global stat for the current house.
|All
|-
|-
| Apply Potion Effect || Yes || Yes || No description provided.
| Teleport Player || Teleport the player to a set location.
|All
|-
|-
| Clear All Potion Effects || Yes || No || No description provided.
| Fail Parkour || End the player's current parkour run with a provided reason.
|All
|-
|-
| Give Experience Levels || Yes || Yes || No description provided.
| Play Sound || Play a sound with a custom pitch to the player.
|All
|-
|-
| Send to Lobby || Yes || Yes || No description provided.
| Set Compass Target || Set the target location of the compass for a player.
|All
|-
|-
| Change Player Stat || Yes || Yes || No description provided.
| Set Gamemode ||
|All
|-
|-
| Change Global Stat || Yes || Yes || No description provided.
| Change Health ||
|All
|-
|-
| Teleport Player || Yes || Yes || No description provided.
| Change Hunger Level ||
|All
|-
|-
| Fail Parkour || Yes || Yes || No description provided.
| Random Action || Executes a single random action from the selected actions.
|All, except item and nested actions
|-
|-
| Play Sound || Yes || Yes || No description provided.
| Trigger Function ||
|All
|-
|-
| Set Compass Target || Yes || Yes || No description provided.
| Apply Inventory Layout ||
|All
|-
|-
| Set Gamemode || Yes || Yes || No description provided.
| Enchant Held Item ||
|All
|-
|-
| Change Health || Yes || Yes || No description provided.
| Pause Execution || Pauses execution of the remaining actions for the specified amount of ticks.
|All
|-
|-
| Change Hunger Level || Yes || Yes || No description provided.
| Set Player Team ||
|All
|-
|-
| Random Action || No || Yes || No description provided.
| Change Team Stat || Modify a team stat for a specific or the player's team.
|All
|-
|-
| Trigger Function || Yes || Yes || No description provided.
| Display Menu ||
|All
|-
|-
| Apply Inventory Layout || Yes || Yes || No description provided.
|Use/Remove Held Item
|Uses the held item when its triggered, this will either decrement the amount of items in the stack by 1 or remove the item if the amount is already 1.
|Only in item actions
|-
|-
| Enchant Held Item || Yes || Yes || No description provided.
|Close Menu
|
|Only in custom menu elements, cannot be nested
|-
|-
| Pause Execution || Yes || Yes || No description provided.
|Cancel Event
|Apply this action to cancel the event.
|Only certain [[Event Actions|event actions]], unsupported in Player Toggle Sneak
|-
|-
| Set Player Team || Yes || Yes || No description provided.
|Exit
|Stops executing the remaining actions.
|Only in nested actions such as a conditional or random action
|-
|-
| Change Team Stat || Yes || Yes || No description provided.
|Inc Stat
|
|Removed from action list
|-
|-
| Display Menu || Yes || Yes || No description provided.
|Go to House Spawn
|
|Removed from action list
|}
|}
*"Remove Item" is instead replaced by "Use/Remove Held Item" in Item Actions.

Latest revision as of 21:17, 2 September 2024

Actions are a Housing feature that allows you to run code on a player with special blocks and items added through a GUI. Actions are able to do things such as teleporting the player, sending a chat message to them, updating stats among many other things. They were originally added on the 20th of August, 2020 alongside the Action Pad. There are currently over 30 unique actions all with their own options and use cases.

List of actions

Below are all of the available actions in Housing with their ingame description and contexts in which they are available. To prevent confusion, we will be listing an action as being available in all contexts even if they are not included in the Player Quit event.

Conditionals and Random Actions cannot be nested within one another.

Name Ingame Description Available Contexts
Conditional Use conditions to only execute the provided actions when all the conditions are met by the player. All, except item and nested actions
Change Player's Group All, except Item Actions and the Player Change Group event
Kill Player All, except in any Event Actions
Full Heal All
Display Title All
Display Action Bar All
Reset Inventory All
Change Max Health All
Parkour Checkpoint Teleports the player back to the last parkour checkpoint. Teleports them to the start if they are not currently in the parkour. All
Give Item All, except item actions
Remove Item All, except item actions
Send a Chat Message All
Apply Potion Effect All
Clear All Potion Effects All
Give Experience Levels All
Send to Lobby All
Change Player Stat Modify a stat of the player who triggered the action. All
Change Global Stat Modify a global stat for the current house. All
Teleport Player Teleport the player to a set location. All
Fail Parkour End the player's current parkour run with a provided reason. All
Play Sound Play a sound with a custom pitch to the player. All
Set Compass Target Set the target location of the compass for a player. All
Set Gamemode All
Change Health All
Change Hunger Level All
Random Action Executes a single random action from the selected actions. All, except item and nested actions
Trigger Function All
Apply Inventory Layout All
Enchant Held Item All
Pause Execution Pauses execution of the remaining actions for the specified amount of ticks. All
Set Player Team All
Change Team Stat Modify a team stat for a specific or the player's team. All
Display Menu All
Use/Remove Held Item Uses the held item when its triggered, this will either decrement the amount of items in the stack by 1 or remove the item if the amount is already 1. Only in item actions
Close Menu Only in custom menu elements, cannot be nested
Cancel Event Apply this action to cancel the event. Only certain event actions, unsupported in Player Toggle Sneak
Exit Stops executing the remaining actions. Only in nested actions such as a conditional or random action
Inc Stat Removed from action list
Go to House Spawn Removed from action list