Changed Action description to be more succinct (And removed spelling errors)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{LowQuality|reason=Contains strewn comments, action descriptions do not match ingame, strange markup regarding bolding of text}}
'''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 a system of scripting events in a player's House, and run off of players within the House. These Actions can be used to send a chat message, kill a player, or even compute advanced arithmetic. 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.
== Standard Actions ==
Actions in this category are found in all standard Action Holders.


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 || No || Yes || An container for an Action Chain to run when certain conditions are met
| 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 || No || Yes || See [[Groups]]
| Change Player's Group ||
|All, except Item Actions and the Player Change Group event
|-
|-
| Kill Player || Yes || No || Kills the player.
| Kill Player ||
|All, except in any Event Actions
|-
|-
| Full Heal || Yes || No || No description provided.
| Full Heal ||
|All
|-
|-
| Display Title || Yes || Yes || No description provided.
| Display Title ||
|All
|-
|-
| Display Action Bar || Yes || Yes || No description provided.
| Display Action Bar ||
|All
|-
|-
| Reset Inventory || Yes || No || No description provided.
| Reset Inventory ||
|All
|-
|-
| Change Max Health || Yes || Yes || No description provided.
| Change Max Health ||
|All
|-
|-
| Parkour Checkpoint || 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
|-
|-
| Give Item || No || Yes || No description provided.
| Give Item ||
|All, except item actions
|-
|-
| Remove Item || No* || Yes || No description provided.
| Remove Item ||
|All, except item actions
|-
|-
| Send a Chat Message || Yes || Yes || No description provided.
| Send a Chat Message ||
|All
|-
|-
| Apply Potion Effect || Yes || Yes || No description provided.
| Apply Potion Effect ||
|All
|-
|-
| Clear All Potion Effects || Yes || No || No description provided.
| Clear All Potion Effects ||
|All
|-
|-
| Give Experience Levels || Yes || Yes || No description provided.
| Give Experience Levels ||
|All
|-
|-
| Send to Lobby || Yes || Yes || No description provided.
| Send to Lobby ||
|All
|-
|-
| Change Player Stat || Yes || Yes || No description provided.
| Change Player Stat || Modify a stat of the player who triggered the action.
|All
|-
|-
| Change Global Stat || Yes || Yes || No description provided.
| Change Global Stat || Modify a global stat for the current house.
|All
|-
|-
| Teleport Player || Yes || Yes || No description provided.
| Teleport Player || Teleport the player to a set location.
|All
|-
|-
| Fail Parkour || Yes || Yes || No description provided.
| Fail Parkour || End the player's current parkour run with a provided reason.
|All
|-
|-
| Play Sound || Yes || Yes || No description provided.
| Play Sound || Play a sound with a custom pitch to the player.
|All
|-
|-
| Set Compass Target || Yes || Yes || No description provided.
| Set Compass Target || Set the target location of the compass for a player.
|All
|-
|-
| Set Gamemode || Yes || Yes || No description provided.
| Set Gamemode ||
|All
|-
|-
| Change Health || Yes || Yes || No description provided.
| Change Health ||
|All
|-
|-
| Change Hunger Level || Yes || Yes || No description provided.
| Change Hunger Level ||
|All
|-
|-
| Random Action || No || Yes || No description provided.
| Random Action || Executes a single random action from the selected actions.
|All, except item and nested actions
|-
|-
| Trigger Function || Yes || Yes || No description provided.
| Trigger Function ||
|All
|-
|-
| Apply Inventory Layout || Yes || Yes || No description provided.
| Apply Inventory Layout ||
|All
|-
|-
| Enchant Held Item || Yes || Yes || No description provided.
| Enchant Held Item ||
|All
|-
|-
| Pause Execution || Yes || Yes || No description provided.
| Pause Execution || Pauses execution of the remaining actions for the specified amount of ticks.
|All
|-
|-
| Set Player Team || Yes || Yes || No description provided.
| Set Player Team ||
|All
|-
|-
| Change Team Stat || Yes || Yes || No description provided.
| Change Team Stat || Modify a team stat for a specific or the player's team.
|All
|-
|-
| Display Menu || Yes || Yes || No description provided.
| Display Menu ||
|}
|All
 
* "Remove Item" is very similar in functionality to "Use/Remove Held Item" in Item Actions. See below for more information.
 
== Special Action Holders ==
Most Action Holders in Housing support all of the "Standard Actions", but some Action Holders omit or include more Actions. This section lists these special Action Holders, and the Isolated Actions section will list special actions associated with certain Locations. This list excludes the Item Action Holder.
 
{| class="wikitable sortable"
! Action Holder !! Omitted Actions !! Additional Actions
|-
|-
| "Change Player's Group" Action Event || Change Player's Group || -
|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
|-
|-
| "Player Death" Action Event || Kill Player || -
|Close Menu
|
|Only in custom menu elements, cannot be nested
|-
|-
| Conditional Action Holder || - || Exit
|Cancel Event
|Apply this action to cancel the event.
|Only certain [[Event Actions|event actions]], unsupported in Player Toggle Sneak
|-
|-
| Random Action Action Holder || - || Exit
|Exit
|Stops executing the remaining actions.
|Only in nested actions such as a conditional or random action
|-
|-
| Action Holders for Custom Menu Items || - || Close Menu
|Inc Stat
|}
|
 
|Removed from action list
This list is not exhaustive and needs to be finished
 
== Isolated Actions ==
These actions are found in specific Action Holders. If a '''Conditional''' or '''Random Action''' Action is added to a Location which supports one of these Actions, the Isolated Action will be available within that '''Conditional''' or '''Random Action''' Action Holder as well. (How do I explain this better ;-;)
 
{| class="wikitable sortable"
! Action Name !! Location(s) !! Has Edit Menu !! class="unsortable"|Definition/Usage
|-
|-
| Use/Remove Held Item || Item Actions || No || No description provided.
|Go to House Spawn
|-
|
| Exit || '''Conditionals''' and '''Random Action''' Action Holders || No || Terminates the currently-executing Action Chain early
|Removed from action list
|-
| Cancel Event || "Player Death", "Fish Caught", "Player Damage", "Player Drop Item", "Player Pick Up Item", "Player Change Held Item", "Player Toggle Sneak", and "Player Toggle Fly" Action Events || No || Can sometimes cancel the activation event for an Action Event, such as preventing a Player from picking up an Item in the "Player Pick Up Item" Action Event. For certain Action Events, even those which support this Action, nothing will happen
|-
| Close Menu || Action Holders for Custom Menu Items || No || Will close the currently-opened Custom Menu
|}
|}
== Removed Actions ==
As of 2024, there are only 2 actions that have been deprecated and can no longer be added.
* Inc Stat
* Go to House Spawn

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