Whiskerwood Official Wiki - User contributions [en]

Function: Calc Characteristics With Guild And Trait Mods

2025-11-28T04:57:12Z

76561198039019116: Created page with "{{Arco_Function_Infobox | name = Calc Characteristics With Guild And Trait Mods | class = Arco Game Instance | path = /Script/ProjectArco.ArcoGameInstance::CalcCharacteristicsWithGuildAndTraitMods | bpnode = Calc Characteristics With Guild And Trait Mods | purpose = Takes a single Struct: Agent Characteristics value and returns a new copy with guild and trait modifiers applied. | params = <code>Context</code> (Object), <code>characteristics</code>..."

{{Arco_Function_Infobox
| name = Calc Characteristics With Guild And Trait Mods
| class = [[Arco Game Instance]]
| path = /Script/ProjectArco.ArcoGameInstance::CalcCharacteristicsWithGuildAndTraitMods
| bpnode = Calc Characteristics With Guild And Trait Mods
| purpose = Takes a single [[Struct: Agent Characteristics]] value and returns a new copy with guild and trait modifiers applied.
| params = <code>Context</code> (Object), <code>characteristics</code> ([[Struct: Agent Characteristics]], const ref)
| returns = [[Struct: Agent Characteristics]]
}}

[[Category:Arco_Functions]]

= Function: Calc Characteristics With Guild And Trait Mods =

''Function: Calc Characteristics With Guild And Trait Mods'' is a helper function on the '''ArcoGameInstance''' class within the Project Arco framework.
It takes a single base [[Struct: Agent Characteristics]] value and produces a new struct with guild and trait modifiers applied to the agent’s stats.

In Blueprints, this appears as an impure node named '''Calc Characteristics With Guild And Trait Mods''' with Exec pins, a <code>Context</code> input, a const reference struct input, and a struct output.

__TOC__

== Overview ==
This function is the single-struct counterpart to [[Function: Calc Array Characteristics With Guild And Trait Mods]].

It is used when you want to:

* Start from a ''base'' [[Struct: Agent Characteristics]] definition
* Apply internal Arco logic for traits, guilds, and related modifiers
* Receive a ''new'' struct representing the final, modified characteristics for that one agent

Because it operates on a single struct rather than an array, it is convenient for:

* Inspecting or previewing one agent’s final stats
* Debugging trait/guild effects on a particular configuration
* Modifying or displaying a single agent’s characteristics without managing arrays

== Script Definition ==
The function is defined in:

<pre>/Script/ProjectArco.ArcoGameInstance::CalcCharacteristicsWithGuildAndTraitMods</pre>

Blueprint-reflected signature (from the node dump):

* **Target:** <code>Arco Game Instance</code>
* **Member Name:** <code>CalcCharacteristicsWithGuildAndTraitMods</code>
* **Impure function:** Yes (has <code>execute</code> / <code>then</code> pins)

== Parameters ==
{| class="wikitable"
! Pin / Parameter !! Type !! Description
|-
| <code>Context</code> || Object Reference || Generic context UObject. In most cases this can be set to <code>Self</code> (the calling Blueprint) or another object associated with the current world.
|-
| <code>characteristics</code> || [[Struct: Agent Characteristics]] (const ref) || Input base characteristics for a single agent. Passed by const reference and not modified in place; used as the source for calculating the final, modified characteristics.
|}

The <code>self</code> / Target pin is automatically bound to <code>Default__ArcoGameInstance</code> and normally does not need to be changed.

== Return Value ==
{| class="wikitable"
! Return !! Type !! Description
|-
| <code>ReturnValue</code> || [[Struct: Agent Characteristics]] || A new struct representing the agent’s characteristics after guild and trait modifiers have been applied. This is the version you should use for further logic, display, or spawning.
|}

== Usage in Blueprints ==

Typical usage pattern:

# Create or obtain a base [[Struct: Agent Characteristics]] value (for example, from a Data Table or a <code>Make Agent Characteristics</code> node).
# Call <code>Calc Characteristics With Guild And Trait Mods</code>:
#* <code>Context</code> → connect <code>Self</code> (or another valid context object).
#* <code>characteristics</code> → connect your base characteristics struct.
# Use the <code>ReturnValue</code> as the processed, final characteristics.

Conceptual flow:

<pre>
BaseCharacteristics (AgentCharacteristics)
↓
Calc Characteristics With Guild And Trait Mods
↓
ModifiedCharacteristics (AgentCharacteristics)
</pre>

You can then:

* Feed <code>ModifiedCharacteristics</code> into spawning logic
* Display the final, modified stats in UI
* Compare base vs. modified values for debugging trait/guild effects

== Notes ==
* The <code>characteristics</code> input is marked as **const reference**, indicating it is used as read-only input.
* This function is ideal when working with a single agent; use [[Function: Calc Array Characteristics With Guild And Trait Mods]] when processing many agents at once.
* Internal formulas for applying trait and guild effects are handled by Project Arco and are not exposed directly in the Mod SDK.

== Related ==
* [[Struct: Agent Characteristics]]
* [[Function: Calc Array Characteristics With Guild And Trait Mods]]
* [[Function: Set New Map Starting Agents]]
* [[Arco Game Instance]]

{{Arco_Functions_Modding}}

Function: Calc Array Characteristics With Guild And Trait Mods

2025-11-28T04:55:32Z

76561198039019116: Created page with "{{Arco_Function_Infobox | name = Calc Array Characteristics With Guild And Trait Mods | class = Arco Game Instance | path = /Script/ProjectArco.ArcoGameInstance::CalcArrayCharacteristicsWithGuildAndTraitMods | bpnode = Calc Array Characteristics With Guild And Trait Mods | purpose = Takes an array of base Struct: Agent Characteristics and returns a new array with guild and trait modifiers applied. | params = <code>Context</code> (Object), <code>ch..."

{{Arco_Function_Infobox
| name = Calc Array Characteristics With Guild And Trait Mods
| class = [[Arco Game Instance]]
| path = /Script/ProjectArco.ArcoGameInstance::CalcArrayCharacteristicsWithGuildAndTraitMods
| bpnode = Calc Array Characteristics With Guild And Trait Mods
| purpose = Takes an array of base [[Struct: Agent Characteristics]] and returns a new array with guild and trait modifiers applied.
| params = <code>Context</code> (Object), <code>characteristics</code> (Array<[[Struct: Agent Characteristics]]>, const ref)
| returns = Array<[[Struct: Agent Characteristics]]>
}}

[[Category:Arco_Functions]]

= Function: Calc Array Characteristics With Guild And Trait Mods =

''Function: Calc Array Characteristics With Guild And Trait Mods'' is a helper function on the '''ArcoGameInstance''' class within the Project Arco framework.
It takes an array of base [[Struct: Agent Characteristics]] and produces a new array where guild and trait modifiers have been applied to the agents’ stats.

In Blueprints, this appears as an impure function node named '''Calc Array Characteristics With Guild And Trait Mods''' with Exec pins, a <code>Context</code> input, a const reference array input, and an array output.

__TOC__

== Overview ==
This function is used when you have a set of base agent definitions and want to calculate their ''final'' characteristics after:

* Traits (from the <code>traits</code> field in [[Struct: Agent Characteristics]])
* Guild-related progress / targets
* Other internal Arco modifiers

have been taken into account.

Rather than modifying the original array in place, the function:

* Reads from a const reference array (<code>characteristics</code>)
* Returns a separate array (<code>ReturnValue</code>) containing the calculated / modified characteristics

This makes it safe to reuse the base data while also working with fully processed values.

== Script Definition ==
The function is defined in:

<pre>/Script/ProjectArco.ArcoGameInstance::CalcArrayCharacteristicsWithGuildAndTraitMods</pre>

Blueprint-reflected signature (from the node dump):

* **Target:** <code>Arco Game Instance</code>
* **Member Name:** <code>CalcArrayCharacteristicsWithGuildAndTraitMods</code>
* **Impure function:** Yes (has <code>execute</code> / <code>then</code> pins)

== Parameters ==
{| class="wikitable"
! Pin / Parameter !! Type !! Description
|-
| <code>Context</code> || Object Reference || Generic context UObject. In typical usage this can be set to <code>Self</code> (the calling Blueprint), or another valid object associated with the current world.
|-
| <code>characteristics</code> || Array<[[Struct: Agent Characteristics]]> (const ref) || Input array of base agent characteristics. Passed by const reference; the original array is not modified by the function. Used as the source data for calculating final, modified characteristics.
|}

The <code>self</code> / Target pin is automatically bound to <code>Default__ArcoGameInstance</code> and normally does not need to be changed.

== Return Value ==
{| class="wikitable"
! Return !! Type !! Description
|-
| <code>ReturnValue</code> || Array<[[Struct: Agent Characteristics]]> || New array of agent characteristics with guild and trait modifiers applied. This is the array you should use for further logic, display, or spawning.
|}

== Usage in Blueprints ==

A typical pattern for using this function:

# Build or retrieve an array of [[Struct: Agent Characteristics]] representing base agents.
# Call <code>Calc Array Characteristics With Guild And Trait Mods</code>:
#* <code>Context</code> → connect <code>Self</code> (or another valid context object).
#* <code>characteristics</code> → connect your base array.
# Use the <code>ReturnValue</code> array as the processed, “final” characteristics.

Conceptual flow:

<pre>
BaseCharacteristics (Array<AgentCharacteristics>)
↓
Calc Array Characteristics With Guild And Trait Mods
↓
ModifiedCharacteristics (Array<AgentCharacteristics>)
</pre>

You can then:

* Feed <code>ModifiedCharacteristics</code> into spawning functions
* Use it for UI previews of final stats
* Log or debug how traits and guilds impact productivity, speed, expectations, etc.

== Notes ==
* The input <code>characteristics</code> array is marked as **const reference**, implying that the function reads but does not mutate the original array.
* The returned array is a separate collection which may reflect:
** Trait deviations/bonuses
** Guild progress or target effects
** Other internal Project Arco modifiers
* Exact numeric formulas are internal to Project Arco and not exposed in the Mod SDK, but this function provides a safe, high-level way to obtain “fully processed” agent stats.

== Related ==
* [[Struct: Agent Characteristics]]
* [[Function: Set New Map Starting Agents]]
* [[Function: Arco Verb To Action]]
* [[Arco Game Instance]]

{{Arco_Functions_Modding}}

Enum: EArco Player Action

2025-11-28T04:53:30Z

76561198039019116:

{{Arco_Enum_Infobox
| name = EArco_PlayerAction
| path = /Script/ProjectArco.EArco_PlayerAction
| purpose = Represents actual gameplay actions resolved from verbs via the Arco Framework.
| usedin = [[Function: Arco Verb To Action]]
}}

[[Category:Arco_Enums]]

= 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]].

__TOC__

== 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 <code>TOGGLE_POLLUTION_VIEW</code>.

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

== Usage ==
This enum appears:

* As the output of [[Function: Arco Verb To Action]]
* In camera/tool/UI behavior systems
* In gameplay logic

Typical flow:

<pre>
[[Enum: EArco Player Verb]] → [[Function: Arco Verb To Action]] → [[Enum: EArco Player Action]]
</pre>

== Related ==
* [[Enum: EArco Player Verb]]
* [[Function: Arco Verb To Action]]
* [[Arco Game Instance]]

{{Arco_Enums_Modding}}

Enum: EArco Player Verb

2025-11-28T04:53:11Z

76561198039019116:

{{Arco_Enum_Infobox
| name = EArco_PlayerVerb
| path = /Script/ProjectArco.EArco_PlayerVerb
| purpose = Represents high-level player input verbs (intent-level actions) within the Arco Framework.
| usedin = [[Function: Arco Verb To Action]]
}}

[[Category:Arco_Enums]]

= Enum: EArco Player Verb =

''EArco_PlayerVerb'' is an enumeration within the Project Arco framework (used internally by '''Whiskerwood''').
It represents the '''intent-level verbs''' that describe what the player is trying to do.

This enum is converted into gameplay-level actions by [[Function: Arco Verb To Action]].

__TOC__

== Overview ==
The Arco Framework separates player input into two layers:

* '''Verbs''' – high-level intent ("what the player wants to do")
* '''Actions''' – concrete gameplay operations the system performs

This enum defines the possible verbs the player can express.

== Values ==
{| class="wikitable"
! Value !! Description
|-
| <code>BACK</code> || Go back / previous / cancel current selection or step.
|-
| <code>CLOSE</code> || Close the current UI, window, or panel.
|-
| <code>ACCEPT</code> || Confirm an action, accept a dialog, or apply a choice.
|-
| <code>SELECT</code> || Select an item, tile, or entity.
|-
| <code>ROTATE</code> || Rotate the current selection or placement.
|-
| <code>BEGIN_DRAG</code> || Begin a drag operation (area select, object drag, etc.).
|-
| <code>END_DRAG</code> || End the current drag operation.
|-
| <code>CANCEL_DRAG</code> || Cancel the current drag operation.
|-
| <code>RAISE</code> || Raise elevation/height.
|-
| <code>LOWER</code> || Lower elevation/height.
|-
| <code>RAISE_SLICE</code> || Raise the slice view layer.
|-
| <code>LOWER_SLICE</code> || Lower the slice view layer.
|-
| <code>LOCK_HEIGHT</code> || Lock elevation while building or viewing.
|-
| <code>UNLOCK_HEIGHT</code> || Unlock elevation.
|-
| <code>TOGGLE_BULLDOZE</code> || Toggle bulldoze mode.
|-
| <code>REMOVAL_MODE</code> || Switch to removal mode.
|-
| <code>ENABLE_SLICE_VIEW</code> || Enable slice view.
|-
| <code>DISABLE_SLICE_VIEW</code> || Disable slice view.
|-
| <code>OPEN_MESSAGES</code> || Open messages/alerts UI.
|-
| <code>TOGGLE_HEAT</code> || Toggle heatmap overlay.
|-
| <code>ROTATE_CAM_CW</code> || Rotate camera clockwise.
|-
| <code>ROTATE_CAM_CCW</code> || Rotate camera counter-clockwise.
|-
| <code>HOTKEY_MINETOOL</code> || Activate mining tool.
|-
| <code>PAUSE</code> || Toggle pause.
|-
| <code>HOTKEY_FARMTOOL</code> || Activate farming tool.
|-
| <code>TOGGLE_POLLUTION</code> || Toggle pollution overlay.
|-
| <code>INVALID</code> || Invalid/fallback verb used as an error state.
|}

== Usage ==
This enum appears:

* As an input to [[Function: Arco Verb To Action]]
* In Blueprint logic requiring verb-based intent
* In control or UI systems

== Related ==
* [[Enum: EArco Player Action]]
* [[Function: Arco Verb To Action]]
* [[Arco Game Instance]]

{{Arco_Enums_Modding}}

Function: Arco Verb To Action

2025-11-28T04:51:25Z

76561198039019116:

[[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> ([[Enum: EArco Player Verb|EArco_PlayerVerb]])
| returns = [[Enum: EArco Player Action|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'''.

__TOC__

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

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

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:

<pre>/Script/ProjectArco.ArcoGameInstance::ArcoVerbToAction</pre>

The Blueprint-reflected signature:

* **Target:** <code>Arco Game Instance</code>
* **Member Name:** <code>ArcoVerbToAction</code>
* **Pure Function:** Yes ( <code>bDefaultsToPureFunc=True</code> )

== Parameters ==
{| class="wikitable"
! Parameter !! Type !! Description
|-
| <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>.
|}

== Return Value ==
{| class="wikitable"
! Return !! Type !! Description
|-
| <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>.
|}

== 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:

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

A typical flow might:

# Obtain a value of [[Enum: EArco Player Verb|EArco_PlayerVerb]] from player input or UI.
# Pass it into <code>Arco Verb To Action</code>.
# 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.

== Notes ==
* If a verb does not map to a known action, the output may be <code>BAD_ACTION</code>.
* 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 ==
* [[Arco Game Instance]]
* [[Function: Set New Map Starting Agents]]
* [[Enum: EArco Player Verb]]
* [[Enum: EArco Player Action]]

{{Arco_Functions_Modding}}

Enum: EArco Player Action

2025-11-28T04:49:49Z

76561198039019116: 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..."

[[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 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]].

__TOC__

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

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.

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

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

== Usage ==
This enum commonly appears:

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

Typical flow:

<pre>
[[Enum: EArco Player Verb]] → [[Function: Arco Verb To Action]] → [[Enum: EArco Player Action]]
</pre>

Game systems can then switch on <code>EArco_PlayerAction</code> to perform the appropriate behavior.

== Related ==
* [[Enum: EArco Player Verb]]
* [[Function: Arco Verb To Action]]
* [[Arco Game Instance]]

{{Arco_Enums_Modding}}

Enum: EArco Player Verb

2025-11-28T04:44:41Z

76561198039019116: /* Values */

[[Category:Arco_Enums]]

{{Arco_Enum_Infobox
| name = EArco_PlayerVerb
| path = /Script/ProjectArco.EArco_PlayerVerb
| purpose = Represents high-level player input verbs (intent-level actions) within the Arco Framework.
| usedin = [[Function: Arco Verb To Action]]
}}

= Enum: EArco Player Verb =

''EArco_PlayerVerb'' is an enumeration within the Project Arco framework (used internally by '''Whiskerwood''').
It represents the '''intent-level verbs''' that describe what the player is trying to do.

This enum is converted into gameplay-level actions by [[Function: Arco Verb To Action]].

__TOC__

== Overview ==
The Arco Framework separates player input into two layers:

* '''Verbs''' – high-level intent ("what the player wants to do")
* '''Actions''' – concrete gameplay operations the system performs

This enum defines the possible verbs the player can express.

== Values ==
{| class="wikitable"
! Value !! Description
|-
| <code>BACK</code> || Go back / previous / cancel current selection or step.
|-
| <code>CLOSE</code> || Close the current UI, window, or panel.
|-
| <code>ACCEPT</code> || Confirm an action, accept a dialog, or apply a choice.
|-
| <code>SELECT</code> || Select an item, tile, or entity.
|-
| <code>ROTATE</code> || Rotate the current selection or placement.
|-
| <code>BEGIN_DRAG</code> || Begin a drag operation (e.g., drag-select area, drag object).
|-
| <code>END_DRAG</code> || End the current drag operation.
|-
| <code>CANCEL_DRAG</code> || Cancel the current drag operation.
|-
| <code>RAISE</code> || Raise height or level (terrain or slice).
|-
| <code>LOWER</code> || Lower height or level (terrain or slice).
|-
| <code>RAISE_SLICE</code> || Raise the active vertical slice view.
|-
| <code>LOWER_SLICE</code> || Lower the active vertical slice view.
|-
| <code>LOCK_HEIGHT</code> || Lock height / elevation while building or viewing.
|-
| <code>UNLOCK_HEIGHT</code> || Unlock height / elevation.
|-
| <code>TOGGLE_BULLDOZE</code> || Toggle bulldozer / demolition mode.
|-
| <code>REMOVAL_MODE</code> || Switch to object / structure removal mode.
|-
| <code>ENABLE_SLICE_VIEW</code> || Enable slice view for the map (view one layer).
|-
| <code>DISABLE_SLICE_VIEW</code> || Disable slice view and return to full view.
|-
| <code>OPEN_MESSAGES</code> || Open messages / notifications / alerts UI.
|-
| <code>TOGGLE_HEAT</code> || Toggle a heatmap or overlay view on/off.
|-
| <code>ROTATE_CAM_CW</code> || Rotate the camera clockwise.
|-
| <code>ROTATE_CAM_CCW</code> || Rotate the camera counter-clockwise.
|-
| <code>HOTKEY_MINETOOL</code> || Activate the mining tool via hotkey.
|-
| <code>PAUSE</code> || Pause or unpause the simulation.
|-
| <code>HOTKEY_FARMTOOL</code> || Activate the farming tool via hotkey.
|-
| <code>TOGGLE_POLLUTION</code> || Toggle pollution or a pollution overlay.
|-
| <code>INVALID</code> || Sentinel / invalid verb, used as a fallback or error state.
|}

== Usage ==
This enum appears:

* As an input on [[Function: Arco Verb To Action]]
* In any Blueprint logic where modders need to express a player input verb
* In control, input, or UI translation layers

== Related ==
* [[Enum: EArco Player Action]]
* [[Function: Arco Verb To Action]]
* [[Arco Game Instance]]

{{Arco_Enums_Modding}}

Category:Arco Enums

2025-11-28T04:33:33Z

76561198039019116: Created page with "= Category for Arco Enums = For more information about Enums, go to Arco Enums."

= Category for Arco Enums =

For more information about Enums, go to [[Arco Enums]].

Template:Arco Enums Modding

2025-11-28T04:32:43Z

76561198039019116:

{{Modding}}

{| class="wikitable" style="margin:auto; text-align:left;"
|+ '''Arco Enums'''
! [[:Category:Arco_Enums|Enums]]
|-
| [[Enum: EArco Player Verb]]
|}

[[Category:Arco_Enums]]
<noinclude>[[Category:Modding_Templates]]</noinclude>

Arco Enums

2025-11-28T04:29:54Z

76561198039019116:

{{Modding Todo|Highlight the most important Enums and document a little bit about that}}
= Arco Enums =
(Stub for now)
[[Category:Arco Enums]]
{{Arco_Enums_Modding}}

Arco Enums

2025-11-28T04:29:07Z

76561198039019116:

{{Modding Todo|Highlight the most important Enums and document a little bit about that}}
= Arco Enums =
(Stub for now)
[[Category:Arco Enums]]
{{Modding Arco Enums}}

Arco Enums

2025-11-28T04:28:55Z

76561198039019116:

{{Modding Todo|Highlight the most important Enums and document a little bit about that}}
= Arco Enums =
(Stub for now)
[[Category:Arco Enums]]

Arco Enums

2025-11-28T04:28:41Z

76561198039019116: Created page with "{{Modding Todo|Highlight the most important Enums and document a little bit about that}} = Arco Enums = (Stub for now)"

{{Modding Todo|Highlight the most important Enums and document a little bit about that}}
= Arco Enums =
(Stub for now)

Template:Arco Enums Modding

2025-11-28T04:27:47Z

76561198039019116:

{{Modding}}

{| class="wikitable" style="margin:auto; text-align:left;"
|+ '''Arco Enums'''
! Enum
|-
| [[Enum: EArco Player Verb]]
|}

[[Category:Arco_Enums]]
<noinclude>[[Category:Modding_Templates]]</noinclude>

Template:Arco Enums Modding

2025-11-28T04:27:38Z

76561198039019116:

Template:Arco Enums Modding

2025-11-28T04:26:34Z

76561198039019116: Created page with "{{Modding}} {| class="wikitable" style="margin:auto; text-align:left;" |+ '''Arco Enums''' ! Enum |- | Enum: EArco Player Verb |} Category:Arco_Enums"

{{Modding}}

{| class="wikitable" style="margin:auto; text-align:left;"
|+ '''Arco Enums'''
! Enum
|-
| [[Enum: EArco Player Verb]]
|}

[[Category:Arco_Enums]]

Enum: EArco Player Verb

2025-11-28T04:25:49Z

76561198039019116: Created page with "Category:Arco_Enums {{Arco_Enum_Infobox | name = EArco_PlayerVerb | path = /Script/ProjectArco.EArco_PlayerVerb | purpose = Represents high-level player input verbs (intent-level actions) within the Arco Framework. | usedin = Function: Arco Verb To Action }} = Enum: EArco Player Verb = ''EArco_PlayerVerb'' is an enumeration within the Project Arco framework (used internally by '''Whiskerwood'''). It represents the '''intent-level verbs''' that des..."

Template:Arco Enum Infobox

2025-11-28T04:24:54Z

76561198039019116: Created page with "{| class="wikitable" style="float:right; clear:right; margin:0 0 1em 1em;" |+ '''Arco Enum''' |- ! Name | {{{name|}}} |- ! Script Path | <code style="word-wrap:break-word; word-break:break-all;">{{{path|}}}</code> |- ! Purpose | {{{purpose|}}} |- ! Used In | {{{usedin|}}} |} <noinclude>Category:Modding_Infoboxes</noinclude>"

{| class="wikitable" style="float:right; clear:right; margin:0 0 1em 1em;"
|+ '''Arco Enum'''
|-
! Name
| {{{name|}}}
|-
! Script Path
| <code style="word-wrap:break-word; word-break:break-all;">{{{path|}}}</code>
|-
! Purpose
| {{{purpose|}}}
|-
! Used In
| {{{usedin|}}}
|}

<noinclude>[[Category:Modding_Infoboxes]]</noinclude>

Function: Arco Verb To Action

2025-11-28T04:21:13Z

76561198039019116: 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..."

[[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 =

''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'''.

__TOC__

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

* **EArco_PlayerVerb** → **EArco_PlayerAction**

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:

<pre>/Script/ProjectArco.ArcoGameInstance::ArcoVerbToAction</pre>

The Blueprint-reflected signature:

* **Target:** <code>Arco Game Instance</code>
* **Member Name:** <code>ArcoVerbToAction</code>
* **Pure Function:** Yes ( <code>bDefaultsToPureFunc=True</code> )

== Parameters ==
{| class="wikitable"
! 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>.
|}

== Return Value ==
{| class="wikitable"
! 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>.
|}

== 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:

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

A typical flow might:

# Obtain a value of <code>EArco_PlayerVerb</code> from player input or UI.
# Pass it into <code>Arco Verb To Action</code>.
# Use the resulting <code>EArco_PlayerAction</code> 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 <code>BAD_ACTION</code>.
* 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 ==
* [[Arco Game Instance]]
* [[Function: Set New Map Starting Agents]]
* [[Enum: EArco_PlayerVerb]] 
* [[Enum: EArco_PlayerAction]] 

{{Arco_Functions_Modding}}

Modding

2025-11-28T04:14:07Z

76561198039019116: /* Contributing to the Modding portion of the Wiki */

= Modding Whiskerwood =

Here you will find resources, links, how-to's, and other details involving modding Whiskerwood.

Whiskerwood is powered by [https://www.unrealengine.com/en-US Unreal Engine] (Version 5.6).

'''Important Links and Sections'''
* [[Unreal_Engine_Resource_Links|Links to Unreal Engine Resources]]
* [https://github.com/Whiskerwood-Modding/Whiskerwood-Project Official Whiskerwood Mod Template]

= Getting Started =

We suggest you head on over to [[Getting Started]] to prepare your setup for modding Whiskerwood.

= Contributing to the Modding portion of the Wiki =

Some focus has been on using the proper templates based on what they are. Be sure to visit [[:Category:Modding Templates]] as well as [[:Category:Modding Infoboxes]] to understand how to apply them. Also harnessing the TOC at the top and proper Wiki formatting is ideal. Be sure to visit https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents if you need to learn how, or simply go and edit an existing page and see what makes it tick! Thank you so much for wanting to contribute and help people learn how to mod!

{{Modding}}

Modding

2025-11-28T04:13:54Z

76561198039019116: /* Contributing to the Modding Wiki */

= Modding Whiskerwood =

Here you will find resources, links, how-to's, and other details involving modding Whiskerwood.

Whiskerwood is powered by [https://www.unrealengine.com/en-US Unreal Engine] (Version 5.6).

'''Important Links and Sections'''
* [[Unreal_Engine_Resource_Links|Links to Unreal Engine Resources]]
* [https://github.com/Whiskerwood-Modding/Whiskerwood-Project Official Whiskerwood Mod Template]

= Getting Started =

We suggest you head on over to [[Getting Started]] to prepare your setup for modding Whiskerwood.

= Contributing to the Modding portion of the Wiki =

Some focus has been on ensuring using the proper templates based on what they are. Be sure to visit [[:Category:Modding Templates]] as well as [[:Category:Modding Infoboxes]] to understand how to apply them. Also harnessing the TOC at the top and proper Wiki formatting is ideal. Be sure to visit https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents if you need to learn how, or simply go and edit an existing page and see what makes it tick! Thank you so much for wanting to contribute and help people learn how to mod!

{{Modding}}

Modding

2025-11-28T04:13:38Z

76561198039019116: /* Modding */

= Modding Whiskerwood =

Here you will find resources, links, how-to's, and other details involving modding Whiskerwood.

Whiskerwood is powered by [https://www.unrealengine.com/en-US Unreal Engine] (Version 5.6).

'''Important Links and Sections'''
* [[Unreal_Engine_Resource_Links|Links to Unreal Engine Resources]]
* [https://github.com/Whiskerwood-Modding/Whiskerwood-Project Official Whiskerwood Mod Template]

= Getting Started =

We suggest you head on over to [[Getting Started]] to prepare your setup for modding Whiskerwood.

= Contributing to the Modding Wiki =

Some focus has been on ensuring using the proper templates based on what they are. Be sure to visit [[:Category:Modding Templates]] as well as [[:Category:Modding Infoboxes]] to understand how to apply them. Also harnessing the TOC at the top and proper Wiki formatting is ideal. Be sure to visit https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents if you need to learn how, or simply go and edit an existing page and see what makes it tick! Thank you so much for wanting to contribute and help people learn how to mod!

{{Modding}}

MediaWiki:Sidebar

2025-11-28T04:13:14Z

76561198039019116:

Template:Modding

2025-11-28T04:04:45Z

76561198039019116:

{| class="wikitable" style="margin:auto"
|+ Whiskerwood Modding
|-
| Primary Pages: || [[Modding|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]]
|}

<noinclude>[[Category:Modding_Templates]]</noinclude>
[[Category:Modding]]

Modding

2025-11-28T01:11:11Z

76561198039019116: /* Contributing to the Modding Wiki */

= Modding =

Here you will find resources, links, how-to's, and other details involving modding Whiskerwood.

Whiskerwood is powered by [https://www.unrealengine.com/en-US Unreal Engine] (Version 5.6).

'''Important Links and Sections'''
* [[Unreal_Engine_Resource_Links|Links to Unreal Engine Resources]]
* [https://github.com/Whiskerwood-Modding/Whiskerwood-Project Official Whiskerwood Mod Template]

= Getting Started =

We suggest you head on over to [[Getting Started]] to prepare your setup for modding Whiskerwood.

= Contributing to the Modding Wiki =

Some focus has been on ensuring using the proper templates based on what they are. Be sure to visit [[:Category:Modding Templates]] as well as [[:Category:Modding Infoboxes]] to understand how to apply them. Also harnessing the TOC at the top and proper Wiki formatting is ideal. Be sure to visit https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents if you need to learn how, or simply go and edit an existing page and see what makes it tick! Thank you so much for wanting to contribute and help people learn how to mod!

{{Modding}}

Modding

2025-11-28T01:10:30Z

76561198039019116: /* Contributing to the Modding Wiki */

= Modding =

Here you will find resources, links, how-to's, and other details involving modding Whiskerwood.

Whiskerwood is powered by [https://www.unrealengine.com/en-US Unreal Engine] (Version 5.6).

'''Important Links and Sections'''
* [[Unreal_Engine_Resource_Links|Links to Unreal Engine Resources]]
* [https://github.com/Whiskerwood-Modding/Whiskerwood-Project Official Whiskerwood Mod Template]

= Getting Started =

We suggest you head on over to [[Getting Started]] to prepare your setup for modding Whiskerwood.

= Contributing to the Modding Wiki =

Some focus has been on ensuring using the proper templates based on what they are. Be sure to visit [[:Category:Modding Templates]] as well as [[:Category:Modding Infoboxes]] to understand how to apply them. Also harnessing the TOC at the top and proper Wiki formatting is ideal. Be sure to visit [[https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents|MediaWiki Help]] if you need to learn how, or simply go and edit an existing page and see what makes it tick! Thank you so much for wanting to contribute and help people learn how to mod!

{{Modding}}

Template:Modding Todo

2025-11-28T00:59:37Z

76561198039019116:

<div style="border:1px solid #f7df93; background:#453913; color:#f7df93; font-weight:bold; padding:10px; margin:10px 0; font-size:90%;">
This page is incomplete and needs additional information. Please visit [[:Category:Modding Todo]] if you wish to see a full list of pages that require additional information and would greatly benefit from your help!

'''TODO:''' {{{1|Complete the documentation on this page.}}}
</div>
[[Category:Modding Todo]]
<noinclude>[[Category:Modding Templates]]</noinclude>

Template:Modding

2025-11-28T00:57:59Z

76561198039019116:

Template:Arco Structs Modding

2025-11-28T00:57:43Z

76561198039019116:

{{Modding}}

{| class="wikitable" style="margin:auto; text-align:left;"
|+ '''Arco Structs'''
|-
| [[Struct: Agent Characteristics]]
|}

[[Category:Arco_Structs]]
<noinclude>[[Category:Modding_Templates]]</noinclude>

Template:Arco Functions Modding

2025-11-28T00:57:23Z

76561198039019116:

{{Modding}}

{| class="wikitable" style="margin:auto; text-align:left;"
|+ '''Arco Functions'''
! Function
|-
| [[Function: Set New Map Starting Agents]]
|}

[[Category:Arco_Functions]]
<noinclude>[[Category:Modding_Templates]]</noinclude>

Template:Arco Struct Infobox

2025-11-28T00:56:36Z

76561198039019116:

{| class="wikitable" style="float:right; clear:right; margin:0 0 1em 1em;"
|+ '''Arco Struct'''
|-
! Name
| {{{name|}}}
|-
! Script Path
| <code style="word-wrap:break-word; word-break:break-all;">{{{path|}}}</code>
|-
! Purpose
| {{{purpose|}}}
|-
! Used In
| {{{usedin|}}}
|-
! Category
| {{{category|Agent / NPC}}}
|}

<noinclude>[[Category:Modding_Templates]]</noinclude>
<noinclude>[[Category:Modding_Infoboxes]]</noinclude>

Template:Arco Function Infobox

2025-11-28T00:56:00Z

76561198039019116:

{| class="wikitable" style="float:right; clear:right; margin:0 0 1em 1em;"
|+ '''Arco Function'''
|-
! Name
| {{{name|}}}
|-
! Class
| {{{class|}}}
|-
! Script Path
| <code style="word-wrap:break-word; word-break:break-all;">{{{path|}}}</code>
|-
! Blueprint Node
| {{{bpnode|}}}
|-
! Purpose
| {{{purpose|}}}
|-
! Parameters
| {{{params|}}}
|-
! Returns
| {{{returns|void}}}
|}

<noinclude>[[Category:Modding_Templates]]</noinclude>
<noinclude>[[Category:Modding_Infoboxes]]</noinclude>

Category:Modding Infoboxes

2025-11-28T00:55:09Z

76561198039019116:

<noinclude>[[Category:Modding_Templates]]</noinclude>
{{Modding_Todo|Explain the usage of Infoboxes and how it helps unify the look and feel of the modding documentation.}}

Arco Classes

2025-11-28T00:52:34Z

76561198039019116: Created page with "{{Modding Todo|Explain and document the details of Arco Classes and how they relate to WW}} = Arco Classes = (Stub for now)"

{{Modding Todo|Explain and document the details of Arco Classes and how they relate to WW}}

= Arco Classes =

(Stub for now)

Template:Modding

2025-11-28T00:49:48Z

76561198039019116:

User:76561198039019116

2025-11-28T00:38:44Z

76561198039019116: Created page with "= About Shenjima = I am a developer and network engineer who also does 3D Modeling and graphics and also meteorology. I seem to have my hands in everything these days. I love creative games, FPS's, factory-building, base-building, RPG, and survival games. I'm just very well-rounded. I enjoy documenting and modding Whiskerwood though! This game is very fun and engaging. It has such huge potential and growth and the dev's are absolutely amazing at patches and improvement..."

= About Shenjima =

I am a developer and network engineer who also does 3D Modeling and graphics and also meteorology. I seem to have my hands in everything these days. I love creative games, FPS's, factory-building, base-building, RPG, and survival games. I'm just very well-rounded. I enjoy documenting and modding Whiskerwood though! This game is very fun and engaging. It has such huge potential and growth and the dev's are absolutely amazing at patches and improvement and listening, so I'm here for all of it!

Function: Set New Map Starting Agents

2025-11-28T00:24:04Z

76561198039019116:

[[Category:Arco_Functions]]
[[Category:Agents/Whiskers]]
[[Category:Arco Game Instance Class]]
{{Arco_Function_Infobox
| name = Set New Map Starting Agents
| class = [[Arco Game Instance]]
| path = /Script/ProjectArco.ArcoGameInstance::SetNewMapStartingAgents
| bpnode = Set New Map Starting Agents
| purpose = Registers the starting Agents for a new map using an array of [[Struct: Agent Characteristics]].
| params = <code>Context</code> (Object), <code>agents</code> (Array<Agent Characteristics>)
| returns = void
}}

= Function: Set New Map Starting Agents =

''Function: Set New Map Starting Agents'' is a Project Arco function defined on the '''[[Arco Game Instance]]''' class.
It is used to register the initial set of Agents (NPCs) for a new map by passing an array of [[Struct: Agent Characteristics]] values.

This function appears in Blueprints as a node with the target type '''Arco Game Instance''' and the name '''Set New Map Starting Agents'''.

__TOC__

== Overview ==
When invoked, '''Set New Map Starting Agents''' takes an array of [[Struct: Agent Characteristics]] definitions and uses them to configure the starting population for a new map or game state.

The function does not return a value; it performs internal setup inside the Arco Framework.

The exact spawning timing and internal storage are handled by the ArcoGameInstance and related systems.

== Definition ==
The function is defined on:

<pre>/Script/ProjectArco.ArcoGameInstance::SetNewMapStartingAgents</pre>

In Blueprint, it appears as a standard Call Function node with:

* Exec input: <code>execute</code>
* Exec output: <code>then</code>
* Target: <code>Arco Game Instance</code>
* Parameters: <code>Context</code>, <code>agents</code>

== Parameters ==
{| class="wikitable"
! Pin / Parameter !! Type !! Description
|-
| <code>Context</code> || Object Reference || World or game context object. In most Blueprint usage this can safely be set to <code>Self</code> (the calling object), or another valid UObject associated with the current world.
|-
| <code>agents</code> || Array<[[Struct: Agent Characteristics]]> || Array of agent definitions used as the starting population for the new map.
|}

The <code>self</code> / Target pin is automatically set to the default ArcoGameInstance object and is usually not modified.

== Blueprint Usage ==
A typical Blueprint setup looks like:

# Create one or more <code>Make Agent Characteristics</code> nodes to define starting agents.
# Collect those structs into an <code>Array</code> variable of type <code>Agent Characteristics</code>.
# Call <code>Set New Map Starting Agents</code>:
#* <code>Context</code> → plug in <code>Self</code> (or another relevant UObject).
#* <code>agents</code> → plug in the array variable containing your agent definitions.

Example (high-level):

<pre>
Make Agent Characteristics Make Agent Characteristics
├ agentName = "Marlo" ├ agentName = "Rini"
├ traits = { "rude" } ├ traits = { "swift" }

↓ (added to array variable: StartingAgents)

Set New Map Starting Agents
├ Context = Self
└ agents = StartingAgents
</pre>

== Interaction with Agent Characteristics ==
This function expects the <code>agents</code> array to be composed of fully-formed
[[Struct: Agent Characteristics]] values. Each entry can control:

* Movement and productivity (speed, productivity, carry capacity)
* Traits (via the <code>traits</code> set)
* Guild and education status
* Appearance (skin color, portrait, scale)
* Various behavior and expectation modifiers

How and when these definitions are turned into active in-world Agents is handled internally by the Arco Framework.

== Related ==
* [[Struct: Agent Characteristics]]
* [[Arco Game Instance]]

{{Arco_Functions_Modding}}

Arco Game Instance

2025-11-27T06:21:56Z

76561198039019116: /* Class: Arco Game Instance */

[[Category:Modding Classes]]

{{Modding Todo|Full documentation on Arco Game Instance}}

= Arco Game Instance =

Arco Game Instance

2025-11-27T06:21:49Z

76561198039019116: /* Classes: Arco Game Instance */

[[Category:Modding Classes]]

{{Modding Todo|Full documentation on Arco Game Instance}}

= Class: Arco Game Instance =

Arco Game Instance

2025-11-27T06:21:38Z

76561198039019116:

[[Category:Modding Classes]]

{{Modding Todo|Full documentation on Arco Game Instance}}

= Classes: Arco Game Instance =

Arco Game Instance

2025-11-27T06:21:18Z

76561198039019116: Created page with "Category:Modding Classes {{Modding Todo|Full documentation on Arco Game Instance}}"

[[Category:Modding Classes]]

{{Modding Todo|Full documentation on Arco Game Instance}}

Template:Modding Todo

2025-11-27T06:19:18Z

76561198039019116:

Category:Modding Infoboxes

2025-11-27T06:17:36Z

76561198039019116:

[[Category:Modding_Templates]]
{{Modding_Todo|Explain the usage of Infoboxes and how it helps unify the look and feel of the modding documentation.}}

Category:Modding Todo

2025-11-27T06:14:47Z

76561198039019116: Created page with "= Modding Todo Category = This category shows all pages that still would greatly benefit from editors like you to help and contribute! When you feel a page has finally matured to the point where all that is left is perhaps minor tweaks here and there and covers the topic it represents, simply remove the category tag from that page so it drops off. You can help us greatly raise awareness to pages that have been completed by adding the Category:Modding Todo Complete tag t..."

= Modding Todo Category =

This category shows all pages that still would greatly benefit from editors like you to help and contribute! When you feel a page has finally matured to the point where all that is left is perhaps minor tweaks here and there and covers the topic it represents, simply remove the category tag from that page so it drops off. You can help us greatly raise awareness to pages that have been completed by adding the Category:Modding Todo Complete tag to it.

Thank you for taking the time to consider helping us document modding for Whiskerwood!

Unreal Engine Resource Links

2025-11-27T06:11:18Z

76561198039019116:

{{Modding_Todo}}
[[Category:Modding Todo]]
[[Category:Modding Articles]]
= Unreal Engine Resource Links =

Below are some links and resources to get you started and prepared for modding Whiskerwood:

[https://github.com/Buckminsterfullerene02/UE-Modding-Tools UE Modding Tools]

[https://github.com/Dmgvol/UE_Modding/ UE Modding Guides]

[https://github.com/nihilocrat/SteamWorkshopUploader?tab=readme-ov-file Steam Workshop Uploader]

{{Modding}}

Getting Started

2025-11-27T06:10:57Z

76561198039019116:

{{Modding_Todo}}
[[Category:Modding Todo]]
[[Category:Modding Articles]]
= Getting Started =

First, be sure to download/fork/clone the [https://github.com/Whiskerwood-Modding/Whiskerwood-Project Whiskerwood Project Template].

(Stub for now)

{{Modding}}

Category:Modding Infoboxes

2025-11-27T06:09:56Z

76561198039019116:

[[Category:Modding_Templates]]
{{Modding_Todo}}
[[Category:Modding Todo]]

Template:Modding Todo

2025-11-27T06:09:40Z

76561198039019116:

<div style="border:1px solid #f7df93; background:#453913; color:#f7df93; font-weight:bold; padding:10px; margin:10px 0; font-size:90%;">
'''TODO:''' {{{1|This page is incomplete and needs additional information. Please visit [[:Category:Modding Todo]] if you wish to see a full list of pages that require additional information and would greatly benefit from your help!}}}
</div>
[[Category:Modding Todo]]
[[Category:Modding Templates]]

Mod API Functions

2025-11-27T06:09:12Z

76561198039019116:

[[Category:Mod_API_Functions]]
{{Modding_Todo}}
[[Category:Modding Todo]]
= Mod API Functions =

(Stub for now)

{{Modding}}

Mod API Properties

2025-11-27T06:09:01Z

76561198039019116:

[[Category:Mod_API_Properties]]
{{Modding_Todo}}
[[Category:Modding Todo]]
= Mod API Properties =

{| class="wikitable"
|+ Properties for calling up References
|-
! Property !! Description
|-
| [[ModAPI Property UBackbone|UBackbone]] || -
|-
| [[ModAPI Property UOptionManager|UOptionManager]] || -
|-
| [[ModAPI Property UMasterSyncManager|UMasterSyncManager]] || -
|-
| [[ModAPI Property UModManager|UModManager]] || -
|-
| [[ModAPI Property FModApiState|FModApiState]] || -
|}

{{Modding}}