Function: Arco Verb To Action: Difference between revisions

From Whiskerwood Official Wiki
Created page with "Category:Arco_Functions {{Arco_Function_Infobox | name = Arco Verb To Action | class = Arco Game Instance | path = /Script/ProjectArco.ArcoGameInstance::ArcoVerbToAction | bpnode = Arco Verb To Action | purpose = Converts an '''EArco_PlayerVerb''' value (a player intent) into a corresponding '''EArco_PlayerAction''' value. | params = <code>verb</code> (EArco_PlayerVerb) | returns = EArco_PlayerAction }} = Function: Arco Verb To Action = ''Func..."
 
No edit summary
 
Line 7: Line 7:
  | bpnode  = Arco Verb To Action
  | bpnode  = Arco Verb To Action
  | purpose = Converts an '''EArco_PlayerVerb''' value (a player intent) into a corresponding '''EArco_PlayerAction''' value.
  | purpose = Converts an '''EArco_PlayerVerb''' value (a player intent) into a corresponding '''EArco_PlayerAction''' value.
  | params  = <code>verb</code> (EArco_PlayerVerb)
  | params  = <code>verb</code> ([[Enum: EArco Player Verb|EArco_PlayerVerb]])
  | returns = EArco_PlayerAction
  | returns = [[Enum: EArco Player Action|EArco_PlayerAction]]
}}
}}


Line 24: Line 24:
<code>Arco Verb To Action</code> performs the conversion from:
<code>Arco Verb To Action</code> performs the conversion from:


* **EArco_PlayerVerb** → **EArco_PlayerAction**
* [[Enum: EArco Player Verb|EArco_PlayerVerb]] → [[Enum: EArco Player Action|EArco_PlayerAction]]


Since it is marked as a **pure Blueprint function**, it:
Since it is marked as a **pure Blueprint function**, it:
Line 48: Line 48:
! Parameter !! Type !! Description
! Parameter !! Type !! Description
|-
|-
| <code>verb</code> || EArco_PlayerVerb || The input verb representing high-level player intent. The default enum value shown in Blueprint is <code>BACK</code>.
| <code>verb</code> || [[Enum: EArco Player Verb|EArco_PlayerVerb]] || The input verb representing high-level player intent. The default enum value shown in Blueprint is <code>BACK</code>.
|}
|}


Line 55: Line 55:
! Return !! Type !! Description
! Return !! Type !! Description
|-
|-
| <code>ReturnValue</code> || EArco_PlayerAction || The resulting gameplay action associated with the input verb. The default Blueprint fallback shown is <code>BAD_ACTION</code>.
| <code>ReturnValue</code> || [[Enum: EArco Player Action|EArco_PlayerAction]] || The resulting gameplay action associated with the input verb. The default Blueprint fallback shown is <code>BAD_ACTION</code>.
|}
|}


Line 65: Line 65:


<pre>
<pre>
PlayerVerb →  Arco Verb To Action  →  PlayerAction
EArco_PlayerVerb →  Arco Verb To Action  →  EArco_PlayerAction
</pre>
</pre>


A typical flow might:
A typical flow might:


# Obtain a value of <code>EArco_PlayerVerb</code> from player input or UI.
# Obtain a value of [[Enum: EArco Player Verb|EArco_PlayerVerb]] from player input or UI.
# Pass it into <code>Arco Verb To Action</code>.
# Pass it into <code>Arco Verb To Action</code>.
# Use the resulting <code>EArco_PlayerAction</code> in a Switch or behavior handler.
# Use the resulting [[Enum: EArco Player Action|EArco_PlayerAction]] in a Switch or behavior handler.


Because it is pure, you can drop it inside any expression or decision graph without needing Exec pins.
Because it is pure, you can drop it inside any expression or decision graph without needing Exec pins.
Line 84: Line 84:
* [[Arco Game Instance]]
* [[Arco Game Instance]]
* [[Function: Set New Map Starting Agents]]
* [[Function: Set New Map Starting Agents]]
* [[Enum: EArco_PlayerVerb]] <!-- create later -->
* [[Enum: EArco Player Verb]]
* [[Enum: EArco_PlayerAction]] <!-- create later -->
* [[Enum: EArco Player Action]]


{{Arco_Functions_Modding}}
{{Arco_Functions_Modding}}

Latest revision as of 04:51, 28 November 2025


Arco Function
Name Arco Verb To Action
Class Arco Game Instance
Script Path /Script/ProjectArco.ArcoGameInstance::ArcoVerbToAction
Blueprint Node Arco Verb To Action
Purpose Converts an EArco_PlayerVerb value (a player intent) into a corresponding EArco_PlayerAction value.
Parameters verb (EArco_PlayerVerb)
Returns EArco_PlayerAction



Function: Arco Verb To Action

Function: Arco Verb To Action is a pure helper function provided by the ArcoGameInstance class within the Project Arco framework. It maps a player verb (intent-level enum) to a player action (gameplay-level enum).

This function appears in Blueprints as a pure node named Arco Verb To Action.

Overview

The Arco Framework separates input or intent concepts ("verbs") from the actual gameplay operations ("actions"). Arco Verb To Action performs the conversion from:

Since it is marked as a **pure Blueprint function**, it:

  • Has no execution pins
  • Produces a value directly
  • Is side-effect free
  • Can be used inline in logic or expressions

Script Definition

The function is defined in:

/Script/ProjectArco.ArcoGameInstance::ArcoVerbToAction

The Blueprint-reflected signature:

  • **Target:** Arco Game Instance
  • **Member Name:** ArcoVerbToAction
  • **Pure Function:** Yes ( bDefaultsToPureFunc=True )

Parameters

Parameter Type Description
verb EArco_PlayerVerb The input verb representing high-level player intent. The default enum value shown in Blueprint is BACK.

Return Value

Return Type Description
ReturnValue EArco_PlayerAction The resulting gameplay action associated with the input verb. The default Blueprint fallback shown is BAD_ACTION.

Usage in Blueprints

This function is typically used in control or logic systems that must translate a user verb or input action into a specific gameplay operation.

Example usage:

EArco_PlayerVerb  →  Arco Verb To Action  →  EArco_PlayerAction

A typical flow might:

  1. Obtain a value of EArco_PlayerVerb from player input or UI.
  2. Pass it into Arco Verb To Action.
  3. Use the resulting EArco_PlayerAction in a Switch or behavior handler.

Because it is pure, you can drop it inside any expression or decision graph without needing Exec pins.

Notes

  • If a verb does not map to a known action, the output may be BAD_ACTION.
  • Mapping rules are internal to Project Arco and not exposed directly in the Mod SDK.
  • This function centralizes verb-to-action translation logic so downstream code does not need to hardcode mappings.

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 Functions
Function
Function: Set New Map Starting Agents