Action

Summary

This page summarizes all aspects of the action system, which is responsible for controlling what a unit knows how to do.

Scripting

The code files in this section are at BeatEmUpTemplate/Assets/Scripting/Action.

MonoBehaviours

These scripts are meant to be attached to GameObjects in the scene as components and inherit from Unity's MonoBehaviour class.

UnitActionManagers

classDiagram
    class UnitActionManager{
    }

UnitActionManagers manage the UnitActions a unit knows how to perform.

UnitActionManager.cs represents a basic, general-purpose UnitActionManager in the template. This component can be found attached to the Human prefab and its Hero and Villain prefab variants. These prefabs are instantiated as children of the HumanPlayerUnitManager and AIPlayerUnitManager GameObjects in the Training scene at runtime.

ScriptableObjects

These scripts contain centralized data that can be conveniently accessed from scenes and assets within a project. All classes in this folder derive from Unity's base ScriptableObject class.

ScriptableObjects are stored on disk and live independently of GameObjects and class instances. They are used as data containers to save large amounts of data, reducing a project’s memory usage by not duplicating values.

UnitActions

classDiagram
    UnitAction <|-- BeltScrollMoveUnitAction
    UnitAction <|-- JumpUnitAction
    UnitAction <|-- JabUnitAction
    UnitAction <|-- CrossUnitAction
    class UnitAction{
        <<Abstract>>
    }

UnitActions represent actions that units can perform.

Note

UnitActions are different from abilties. For example, a UnitAction named FireBarrage could have a unit cast three random fire spells in succession, each of which are their own separate ability.

UnitAction.cs defines what is common across all UnitActions regardless of game. This includes things like returning an instanced version of itself called a Command.

BeltScrollMoveUnitAction.cs represents the knowledge of performing the BeltScrollMove ability. Both the Hero and Villain prefabs know this UnitAction in their UnitActionManager components.

JumpUnitAction.cs represents the knowledge of performing the Jump ability. The Hero prefab knows this UnitAction in its UnitActionManager component.

JabUnitAction.cs represents the knowledge of performing the Jab ability. The Villain prefab knows this UnitAction in its UnitActionManager component.

CrossUnitAction.cs represents the knowledge of performing the Cross ability. The Hero prefab knows this UnitAction in its UnitActionManager component.