Skip to main content

PlayerActor [Abstract Base]

The PlayerActor is a networked, extensible character base for player-controlled entities in the game, integrating Fusion networking, modular avatar customization, state machines, camera control, and interaction systems.

🎭 Core Overview​

public abstract class PlayerActor : NetworkBehaviour, IPlayerActor, IStateMachineOwner

Represents a networked player character capable of:

  • Performing interactions
  • Running primary/secondary state machines
  • Managing visual and camera systems
  • Supporting fast travel, teleportation, and avatar customization

👥 Identity & Avatar​

PlayerActorType​

public enum PlayerActorType { Human, Drone }

Represents the actor’s logical role.

SetDisplayName(string newName)​

Sets the player's display name in the world.

AvatarUpdated_Rpc(int skinToneIndex, string[] details)​

Syncs avatar details across the network and rebuilds visuals.

DisplayActiveClothing(List<PlayerItem_SO> overrideList = null)​

Loads and displays the actor's visual representation.

🎮 Interaction System​

AvailableInteractions​

Stores a mapping of interaction points to possible PlayerInteractions.

Interaction Methods​

  • RegisterInteractions(point, ...)
  • UnregisterInteraction(...)
  • ClearInteractions()
  • ActionPressed(...)
  • PerformAction(...)

Automatically shows interaction options and invokes matching responses.

🎥 Camera Handling​

ActivateCamera()​

Instantiates and configures a camera system with support for:

  • Mouse zoom
  • Touch gestures
  • Gamepad inputs

GetActiveCamera()​

Returns the current camera instance for this actor.

🧠 State Machines​

Implements two layered state machines:

  • Primary State Machine: Controls movement or player-driven behavior.
  • Secondary State Machine: Handles hand or tool interactions.

Initialization​

CollectStateMachines(List<IStateMachine> stateMachines)

Transitioning​

RequestState<T>(), RequestSecondaryState<T>()
RequestStateByKey(string), ForceStateAsHost<T>()

Uses RPCs to request state transitions on the server when needed.

🧍 Movement & Teleportation​

Teleport(Vector3 position, Vector3 rotation, bool lockKCC)​

Moves the player to a specified location. If lockKCC is true, disables the controller post-teleport.

❤️ Health Management (Abstract)​

You must implement:

  • UseHealth(int amount)
  • GetHealth()
  • SetHealth(int amount)
  • GetMaxHealth()

🔗 Network & Host Sync​

PlayerConnectionHost connectionHost​

Holds metadata about the player, including identity, XP, respawn, etc.

SetConnectionHost(...)​

Links a host to this actor.

🌐 Network Lifecycle​

Spawned(), Despawned()​

Triggers visual registration, location restoration, and multiplayer service hooks.

Render()​

Listens for avatar or host changes to update clothing and display name.

🧬 Interface: IPlayerActor​

Defines shared behaviors for polymorphic use across systems:

interface IPlayerActor {
    Dictionary<PlayerInteractionPoint, PlayerInteraction[]> AvailableInteractions { get; }
    PlayerActorType GetType();
    bool CanEnterDialog();
    void EnterDialogState(DialogStateMachine stateMachine);
    PlayerBehaviourMachine GetMainStateMachine();
    PlayerBehaviourMachine GetSecondaryStateMachine();
}

🧩 Summary​

PlayerActor is the spine of character logic in the m00m world. It enables multiplayer-ready avatars with rich interaction, animation, and customization layers. Extend this class to implement unique gameplay roles (e.g., drones, NPCs, special agents) while inheriting the common systems for interaction, camera, and control.