Companion System

Central singleton managing all active and stored companions. Add to a persistent GameObject in your scene. Handles summoning, recalling, storage, group commands, and formation updates.

Properties

Methods

SummonCompanion(definition, position, owner) — Spawn and initialize a companion
RecallCompanion(brain, delay?) — Remove companion from scene (optional VFX delay)
RecallAllCompanions() — Recall all active companions
StoreCompanion(brain) — Move companion to storage
RetrieveFromStorage(definition, position, owner) — Spawn a stored companion
GroupSetState(state) — Set all companions to same state
GroupSendCommand(command) — Send command to all (skips unsupported)
GroupSetFormation(formation) — Change formation for all companions
FindActiveByDefinition(definition) — Get brain by definition
IssueCommand(brain, command) — Issue command on a specific brain
SwapActive(stored, active, position?, owner?) — Store one active companion and retrieve a stored one in its place (see Swapping Companions below)
CanSwapActive(definition, brain, owner) / ValidateSwap(...) — Pure checks; return a CompanionSwapCheck
RecruitCompanion(gameObject, definition, owner) — Turn a scene Character into a managed companion (see Recruiting a Scene Character below)
DismissCompanion(definition) — Remove a companion from the party, leaving its GameObject in the scene
CanRecruitCompanion(...) / ValidateRecruit(...) — Pure checks; return a CompanionRecruitCheck
FindActiveByGameObject(gameObject) / IsCompanion(gameObject) — Query whether a GameObject is currently an active companion

The central component on each companion prefab. Drives state machine, motor control, follow behavior, idle system, bonding, and events. Initialized by CompanionManager on summon.

Properties

Methods

SetState(state) — Transition to new state (fires events)
IssueCommand(command) — Execute a command (validates against CommandSet)
SendCommand(command) — Group-safe command (silently skips if unsupported)
CompleteCommand() — Signal command is done, return to Following
SetOwner(owner) — Transfer to a new owner at runtime

The single boundary to GC2 Character Motion — no other CPS code touches GC2 movement directly. Provides follow, stop, teleport, speed control, gesture, and LookAt. Driver-aware: detects whether the Character uses the NavMesh Agent driver and can upgrade it for pathfinding. Added automatically to companion prefabs. See the Navigation & Following page for the full movement model.

Properties

Methods

StartFollow(target, minDist, maxDist) — Follow a Transform via GC2 Motion (pathfinds on the NavMesh driver)
StopFollow() — Stop following and halt movement
EnsureNavMeshDriver() — Upgrade the Character to the NavMesh Agent driver when a baked mesh is present
SetSpeed(speed) — Set movement speed
Teleport(position, rotation) — Instant reposition
LookAt(target) — Face a target via GC2 Facing layer
StopLookAt() — Remove LookAt layer
PlayGesture(clip) — Play animation clip as a gesture

Add to your Player Character to make it a companion owner. Bridges the GC2 Character to the ICompanionOwner interface, providing position, forward direction, and velocity tracking. Also records the breadcrumb trail companions follow while you move (see Navigation & Following). Auto-added by the Summon instruction if missing.

Properties

Defines a companion type — its prefab, display name, follow/idle profile overrides, commands, personality, and reaction profile. Create via Create > Companion System > Companion Definition.

Properties

Controls follow behavior parameters. Multiple profiles allow different companion types to move differently (e.g., a dog runs faster than a turtle).

Properties

Place across a gap in the NavMesh — a low wall or box — and NavMesh-driven companions will climb or vault over it with a scripted arc and optional animation, instead of detouring or teleporting. Drag the endpoints onto the mesh on either side. See Navigation & Following for setup.

Properties

Swapping Companions

CompanionManager.SwapActive stores one active companion and retrieves a stored one in its place, in a single call. It is built on the existing StoreCompanion / RetrieveFromStorage pair, and always stores first — so Max Active Companions can never be exceeded and a swap works even with a full party, where a plain Retrieve would be refused.

A swap raises no new events — you get exactly one On Companion Stored followed by one On Companion Summoned, so existing listeners keep working unchanged.

CompanionSwapCheck values: Ok, NoDefinition, NoActiveCompanion, SameCompanion, AlreadyActive, NotInStorage, NoPrefab, NoOwner. All checks run before anything is mutated, so a refused swap leaves both companions untouched.

Recruiting a Scene Character

No Dialogue module is required. RecruitCompanion turns a Character that already exists in the scene into a managed companion without spawning anything — the Character keeps its own GameObject and everything on it, and the Companion Definition supplies behaviour data only (its Prefab field is ignored). The target needs a Game Creator 2 Character component; CompanionBrain and CompanionMotor are added automatically.

CompanionRecruitCheck values: Ok, NoCharacter, NoDefinition, NotAGameCreatorCharacter, NoOwner, AlreadyRecruited, DefinitionAlreadyActive, PartyFull. As with SwapActive, all checks run before anything is mutated.

Mount Metadata

Be clear about what this is: the Companion Party System contains no riding code. Movement is GC2 Character plus CompanionMotor; parenting a player to a saddle, swapping the camera and handing over input are GC2 Character concerns, not companion-lifecycle concerns. What 1.2.0 adds is the two pieces CPS is actually the right owner of:

Transform saddle = definition.FindMountPoint(companionInstance);
// or, without a definition:
Transform saddle = CompanionDefinition.FindMountPoint(companionInstance, "Saddle");

FindMountPoint searches the whole hierarchy including the root and inactive children, matches the name exactly (case-sensitive), and returns the first hit or null.

Companion Vitals

A standalone health and secondary resource system that works without GC2 Stats. Add CompanionVitals to any companion prefab to enable HP, damage, healing, death, and auto-revive.

Ability System

Companions can have up to 8 ability slots. Each ability is a ScriptableObject defining timing, cost, targeting requirements, and optional GC2 instructions that execute on cast.

Traits System

Traits are permanent modifiers assigned to companions. They apply stat multipliers, grant bonus abilities, and can spawn aura VFX. Use traits to create unique companions — a "Fierce" wolf that deals more damage, or a "Loyal" companion that gains bond faster.

Target System

A lightweight targeting system that works alongside abilities. The player or game logic selects a target; abilities validate it against their TargetType and range requirements.

Bridges (Optional Integrations)

Each bridge is an independent, deletable assembly that connects CPS to one optional GC2 module. Neither is required for the core feature set — see Getting Started → Requirements.

Autonomous Abilities (Optional)

bool TryChooseAbility(
    CompanionBrain      brain,
    CompanionAbilitySet abilities,
    ITargetable         currentTarget,
    out int             slotIndex,
    out ITargetable     target);

Party Frame Manager

Component → Companion System → UI → Party Frame Manager drives the party HUD: it pools Companion Frame UI instances, binds one per active companion, re-binds when companions are summoned or recalled, and lays the frames out vertically or horizontally.

Two pure helpers are public so custom UI can reuse the same rules: PartyFrameManager.ResolveTargetable(companion, searchChildren) and PartyFrameManager.ShouldSetTarget(setTargetOnSelect, targetable, targetManagerExists). Requires a Targetable component (or any ITargetable) on the companion and a Target Manager in the scene — with neither, frame clicks still select and highlight normally.

Companion Banter Trigger

Decides when two active companions should exchange a line and who the two are. It does not decide what is said: that is the job of whatever listens to the GC2 Event On Companion Banter — a Dialogue, a bark, a subtitle, an animation. Put it on the Companion Manager's GameObject, or any scene object you like.

CompanionBanterTrigger.OnBanter += args =>
{
    Debug.Log($"{args.Speaker.CustomName} -> {args.Listener.CustomName} ({args.Cause})");
};

OnBanter is static, so a listener needs no reference to the component. CompanionBanterEventArgs carries Speaker, Listener, Cause (CompanionBanterCause: Timer / BondTierUp / Manual) and the two GameObject shortcuts.

TryRaiseBanter() raises a line on demand (cause Manual) and returns whether the rules allowed it. The rules themselves live in the public CompanionBanterUtility. See GC2 Integration → Banter Nodes.

Personality & Reactions

Two optional ScriptableObjects that bring companions to life. Assign both in the CompanionDefinition.

Interest Points

Place CompanionInterestPoint in your scene to create locations that idle companions will navigate to and interact with (campfires, fountains, food bowls, etc.).

Companions also passively "glance" at nearby interest points they haven't visited yet. Bond points are awarded upon a successful POI visit (configured in CompanionPersonality).

IdleBehaviorProfile

ScriptableObject configuring what companions do when idle. Assign to a CompanionDefinition or set a default in CompanionSettings.

CompanionSettings

Project-wide defaults. Access via Window → Companion System → Settings. The Settings window auto-creates the asset if not found.