Command

Summary

This page summarizes all aspects of the command system, which is responsible for determining when in-game actions should be performed.

Scripting

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

CSharp

These scripts are not meant to be attached to GameObjects in the scene. Many of them represent static event classes that are meant to be invoked or are abstract classes representing concepts.

Commands

classDiagram
    class Command{
    }

Commands represent instances of UnitActions that can be queued for execution. A UnitActionManager requests a Command instance of a UnitAction from its ScriptableObject and then passes the Command to a CommandInvoker.

Command.cs defines what is common across all Commands, regardless of game. This includes things like references to its name, its user, and an execution method.

MonoBehaviours

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

CommandInvokers

classDiagram
    class CommandInvoker{
    }

CommandInvokers invoke Commands for execution. A UnitActionManager requests a Command instance of a UnitActions from its ScriptableObject and then passes the Command to a CommandInvoker.

CommandInvoker.cs represents a basic, general-purpose CommandInvoker used by the template. It simply executes Commands as soon as it receives them instead of inserting them into any sort of queue. 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.