Enum: EArco Player Action: Difference between revisions

From Whiskerwood Official Wiki
Browse history interactively
Created page with "Category:Arco_Enums {{Arco_Enum_Infobox | name = EArco_PlayerAction | path = /Script/ProjectArco.EArco_PlayerAction | purpose = Represents concrete gameplay actions resolved from player verbs within the Arco Framework. | usedin = Function: Arco Verb To Action }} = Enum: EArco Player Action = ''EArco_PlayerAction'' is an enumeration within the Project Arco framework (used internally by '''Whiskerwood'''). It represents the concrete '''gameplay acti..."
 
No edit summary
 
Line 1: Line 1:
[[Category:Arco_Enums]]
{{Arco_Enum_Infobox
{{Arco_Enum_Infobox
  | name    = EArco_PlayerAction
  | name    = EArco_PlayerAction
  | path    = /Script/ProjectArco.EArco_PlayerAction
  | path    = /Script/ProjectArco.EArco_PlayerAction
  | purpose = Represents concrete gameplay actions resolved from player verbs within the Arco Framework.
  | purpose = Represents actual gameplay actions resolved from verbs via the Arco Framework.
  | usedin  = [[Function: Arco Verb To Action]]
  | usedin  = [[Function: Arco Verb To Action]]
}}
}}
[[Category:Arco_Enums]]


= Enum: EArco Player Action =
= Enum: EArco Player Action =


''EArco_PlayerAction'' is an enumeration within the Project Arco framework (used internally by '''Whiskerwood''').   
''EArco_PlayerAction'' is an enumeration within the Project Arco framework (used internally by '''Whiskerwood''').   
It represents the concrete '''gameplay actions''' that can be triggered by player input or systems after resolving higher-level verbs such as [[Enum: EArco Player Verb]] via [[Function: Arco Verb To Action]].
It represents the concrete '''gameplay actions''' that result from resolving higher-level verbs via [[Function: Arco Verb To Action]].


__TOC__
__TOC__


== Overview ==
== Overview ==
Where [[Enum: EArco Player Verb]] expresses intent (''what'' the player wants to do),   
Where [[Enum: EArco Player Verb]] expresses intent,   
''EArco_PlayerAction'' expresses the actual action (''what'' the game will perform).
''EArco_PlayerAction'' expresses the actual gameplay action performed.


This enum is typically produced as the output of [[Function: Arco Verb To Action]], and then consumed by input handling, camera, UI, or gameplay logic.
It is used extensively in camera controls, UI, tools, overlays, and simulation speed controls.


The default Blueprint value for this enum (as seen in variable defaults) is <code>TOGGLE_POLLUTION_VIEW</code>.
The default Blueprint value is <code>TOGGLE_POLLUTION_VIEW</code>.


== Values ==
== Values ==
Line 27: Line 27:
! Value !! Description
! Value !! Description
|-
|-
| <code>BAD_ACTION</code> || Fallback / sentinel action used when no valid mapping exists or an error occurs.
| <code>BAD_ACTION</code> || Fallback action for invalid or unmapped verbs.
|-
|-
| <code>BACK</code> || Perform a “back”/previous action, such as going back in UI or canceling a step.
| <code>BACK</code> || Go back / cancel.
|-
|-
| <code>SELECT</code> || Perform a selection action (select tile, unit, object, etc.).
| <code>SELECT</code> || Select tile/object.
|-
|-
| <code>ROTATE</code> || Rotate the current selection or placement.
| <code>ROTATE</code> || Rotate selection/placement.
|-
|-
| <code>RAISE</code> || Raise height, elevation, or level of something (terrain, structures, etc.).
| <code>RAISE</code> || Raise elevation.
|-
|-
| <code>LOWER</code> || Lower height, elevation, or level.
| <code>LOWER</code> || Lower elevation.
|-
|-
| <code>TOGGLE_HEIGHT_LOCK</code> || Toggle a height/elevation lock state on or off.
| <code>TOGGLE_HEIGHT_LOCK</code> || Toggle height lock on/off.
|-
|-
| <code>TOGGLE_BULLDOZE</code> || Toggle bulldozer / demolition mode on or off.
| <code>TOGGLE_BULLDOZE</code> || Toggle bulldoze mode.
|-
|-
| <code>MODIFIER_KEY</code> || Apply or toggle a modifier key/action (e.g. shift/alt-style modifier behavior).
| <code>MODIFIER_KEY</code> || Apply a modifier action (Shift/Alt style behavior).
|-
|-
| <code>TOGGLE_SLICE_VIEW</code> || Toggle slice view mode (switching between sliced and full map view).
| <code>TOGGLE_SLICE_VIEW</code> || Toggle slice view.
|-
|-
| <code>OPEN_MESSAGES</code> || Open messages, notifications, or alerts UI.
| <code>OPEN_MESSAGES</code> || Open messages UI.
|-
|-
| <code>MOVE_FORWARD</code> || Move the camera or focus forward.
| <code>MOVE_FORWARD</code> || Camera move forward.
|-
|-
| <code>MOVE_BACK</code> || Move the camera or focus backward.
| <code>MOVE_BACK</code> || Camera move backward.
|-
|-
| <code>MOVE_LEFT</code> || Move the camera or focus left.
| <code>MOVE_LEFT</code> || Camera move left.
|-
|-
| <code>MOVE_RIGHT</code> || Move the camera or focus right.
| <code>MOVE_RIGHT</code> || Camera move right.
|-
|-
| <code>ZOOM_IN</code> || Zoom the camera in.
| <code>ZOOM_IN</code> || Camera zoom in.
|-
|-
| <code>ZOOM_OUT</code> || Zoom the camera out.
| <code>ZOOM_OUT</code> || Camera zoom out.
|-
|-
| <code>TOGGLE_HEAT_VIEW</code> || Toggle a heatmap / heat overlay view on or off.
| <code>TOGGLE_HEAT_VIEW</code> || Toggle heatmap overlay.
|-
|-
| <code>CLONE</code> || Perform a cloning/duplicate action (e.g. clone a placement or selection).
| <code>CLONE</code> || Clone current object/placement.
|-
|-
| <code>TAB_LEFT</code> || Cycle/tab left through UI tabs, tools, or panels.
| <code>TAB_LEFT</code> || Tab left in UI/toolbars.
|-
|-
| <code>TAB_RIGHT</code> || Cycle/tab right through UI tabs, tools, or panels.
| <code>TAB_RIGHT</code> || Tab right in UI/toolbars.
|-
|-
| <code>SPEED_1</code> || Set simulation/game speed to level 1 (slow/normal).
| <code>SPEED_1</code> || Simulation speed 1.
|-
|-
| <code>SPEED_2</code> || Set simulation/game speed to level 2 (faster).
| <code>SPEED_2</code> || Simulation speed 2.
|-
|-
| <code>SPEED_3</code> || Set simulation/game speed to level 3 (fastest).
| <code>SPEED_3</code> || Simulation speed 3.
|-
|-
| <code>ROTATE_CAM_CW</code> || Rotate the camera clockwise.
| <code>ROTATE_CAM_CW</code> || Rotate camera clockwise.
|-
|-
| <code>ROTATE_CAM_CCW</code> || Rotate the camera counter-clockwise.
| <code>ROTATE_CAM_CCW</code> || Rotate camera counter-clockwise.
|-
|-
| <code>PAUSE</code> || Pause or unpause the simulation.
| <code>PAUSE</code> || Toggle pause.
|-
|-
| <code>HOTKEY_MINETOOL</code> || Activate or trigger the mining tool via hotkey.
| <code>HOTKEY_MINETOOL</code> || Activate mining tool.
|-
|-
| <code>HOTKEY_FARMTOOL</code> || Activate or trigger the farming tool via hotkey.
| <code>HOTKEY_FARMTOOL</code> || Activate farming tool.
|-
|-
| <code>TOGGLE_POLLUTION_VIEW</code> || Toggle the pollution view or pollution overlay on/off.
| <code>TOGGLE_POLLUTION_VIEW</code> || Toggle pollution overlay.
|}
|}


== Usage ==
== Usage ==
This enum commonly appears:
This enum appears:


* As the return type of [[Function: Arco Verb To Action]].
* As the output of [[Function: Arco Verb To Action]]
* In input handling systems that respond to specific actions (camera movement, tool switching, overlays, etc.).
* In camera/tool/UI behavior systems
* In UI or hotkey layers that dispatch actions based on user input.
* In gameplay logic


Typical flow:
Typical flow:


<pre>
<pre>
[[Enum: EArco Player Verb]] → [[Function: Arco Verb To Action]] → [[Enum: EArco Player Action]]
[[Enum: EArco Player Verb]] → [[Function: Arco Verb To Action]] → [[Enum: EArco Player Action]]
</pre>
</pre>
Game systems can then switch on <code>EArco_PlayerAction</code> to perform the appropriate behavior.


== Related ==
== Related ==

Latest revision as of 04:53, 28 November 2025

Arco Enum
Name EArco_PlayerAction
Script Path /Script/ProjectArco.EArco_PlayerAction
Purpose Represents actual gameplay actions resolved from verbs via the Arco Framework.
Used In Function: Arco Verb To Action

Enum: EArco Player Action

EArco_PlayerAction is an enumeration within the Project Arco framework (used internally by Whiskerwood). It represents the concrete gameplay actions that result from resolving higher-level verbs via Function: Arco Verb To Action.

Overview

Where Enum: EArco Player Verb expresses intent, EArco_PlayerAction expresses the actual gameplay action performed.

It is used extensively in camera controls, UI, tools, overlays, and simulation speed controls.

The default Blueprint value is TOGGLE_POLLUTION_VIEW.

Values

Value Description
BAD_ACTION Fallback action for invalid or unmapped verbs.
BACK Go back / cancel.
SELECT Select tile/object.
ROTATE Rotate selection/placement.
RAISE Raise elevation.
LOWER Lower elevation.
TOGGLE_HEIGHT_LOCK Toggle height lock on/off.
TOGGLE_BULLDOZE Toggle bulldoze mode.
MODIFIER_KEY Apply a modifier action (Shift/Alt style behavior).
TOGGLE_SLICE_VIEW Toggle slice view.
OPEN_MESSAGES Open messages UI.
MOVE_FORWARD Camera move forward.
MOVE_BACK Camera move backward.
MOVE_LEFT Camera move left.
MOVE_RIGHT Camera move right.
ZOOM_IN Camera zoom in.
ZOOM_OUT Camera zoom out.
TOGGLE_HEAT_VIEW Toggle heatmap overlay.
CLONE Clone current object/placement.
TAB_LEFT Tab left in UI/toolbars.
TAB_RIGHT Tab right in UI/toolbars.
SPEED_1 Simulation speed 1.
SPEED_2 Simulation speed 2.
SPEED_3 Simulation speed 3.
ROTATE_CAM_CW Rotate camera clockwise.
ROTATE_CAM_CCW Rotate camera counter-clockwise.
PAUSE Toggle pause.
HOTKEY_MINETOOL Activate mining tool.
HOTKEY_FARMTOOL Activate farming tool.
TOGGLE_POLLUTION_VIEW Toggle pollution overlay.

Usage

This enum appears:

Typical flow: 

[[Enum: EArco Player Verb]] → [[Function: Arco Verb To Action]] → [[Enum: EArco Player Action]]

Related


Whiskerwood Modding
Primary Pages: Modding Main Page · Getting Started · Unreal Engine Resource Links
Mod API: Mod API Properties · Mod API Functions
Arco: Arco Structs · Arco Functions · Arco Properties · Arco Enums · Arco Classes
Arco Enums
Enums
Enum: EArco Player Verb
Retrieved from "https://wiki.hoodedhorse.com/Whiskerwood/index.php?title=Enum:_EArco_Player_Action&oldid=521"