View source for Function: Set New Map Starting Agents

[[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&lt;Agent Characteristics&gt;)
 | 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&lt;[[Struct: Agent Characteristics]]&gt; || 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}}