Action

Fields

Field	Description
State	Is the event active or not?

Methods

SubscribeToStart

PUT SubscribeTo(Event newEvent)

Invoking this method will subscribe the event you pass to this Action, making it a listener to the start event.

Path Parameters

Name	Type	Description
newEvent	object	Determines the method you want to subscribe to this Action's start.

200 In this example we want to print Aiming! whenever the player starts aiming. We can do this by using this method.

private void OnAim(){
    Debug.Log("Aiming!");
}

PlayerEvents.Aim.SubscribeToStart(OnAim);

SubscribeToStop

PUT SubscribeToStop(Event newEvent)

Invoking this method will subscribe the event you pass to this Action, making it a listener to the stop event.

Path Parameters

Name	Type	Description
newEvent	object	Determines the method you want to subscribe to this Action's stop.

200 In this example we want to print Aiming! whenever the player stops aiming. We can do this by using this method.

private void OnAim(){
    Debug.Log("Aiming!");
}

PlayerEvents.Aim.SubscribeToStop(OnAim);

AddStartTrier

PUT AddStartTrier(TryDelegate newTrier)

Invoking this method will make the function you passed the new start trier for this Action.

Path Parameters

Name	Type	Description
newTrier	boolean	Function with a return type of boolean that will be used as a trier for this Action.

200 We can use this method as a way to locally check whether to allow an Action to change state or not.

private bool OnTry_Aim(){
    if(canAim)
        return true;
    else
        return false;
}

PlayerEvents.Aim.AddStartTrier(OnTry_Aim);

AddStopTrier

PUT AddStopTrier(TryDelegate newTrier)

Invoking this method will make the function you passed the new stop trier for this Action.

Path Parameters

Name	Type	Description
newTrier	boolean	Function with a return type of boolean that will be used as a trier for this Action.

200 We can use this method as a way to locally check if we should allow the Action to stop once it has started.

private bool OnTryStop_Aim(){
    if(canAim)
        return true;
    else
        return false;
}

PlayerEvents.Aim.AddStopTrier(OnTryStop_Aim);

TryStart

POST TryStart()

Invoking this method will try to start this Action, meaning that it will first invoke the triers and make sure they all return true before starting.

200 As you can see, this method is really simple to invoke, but should not be used too much as it checks triers every time.

PlayerEvents.Aim.TryStart();

TryStop

POST TryStop()

Invoking this method will try to stop this Action, meaning it will first invoke the triers and make sure they all return before properly stopping it.

200 In this example we are trying to stop the aiming, this will only work if aiming is current happening, and if the triers allow us to stop it.

PlayerEvents.Aim.TryStop();

ForceStart

POST ForceStart()

Invoking this method will allow you to directly skip over the triers and start the Action.

200 In this case, the code will directly start the aiming Action.

PlayerEvents.Aim.ForceStart();

ForceStop

POST ForceStop()

Invoking this method will allow you to directly skip over the triers and stop the Action. This forceful approach is necessary sometimes.

200 In this case the code will directly stop the aiming Action.

PlayerEvents.Aim.ForceStop();

ForceToggle

POST ForceToggle()

Invoking this method will forcefully switch the Action's state. Actions that are started will be forcefully stopped, and ones that are stopped will be forcefully started.

200 This method is helpful for things like crouching, where you just need to toggle the state when the player presses a button.

if(Input.GetKeyCode(KeyCode.C))
    PlayerEvents.Crouch.ForceToggle();

Debug

OPTIONS Debug(bool debugAttempts = false, string name = "Debug")

Logs the names of the methods subscribed to this Attempt, and the Triers added.

Path Parameters

Name	Type	Description
Name	string	Simple name that you can give this debug, making it easier to not confuse it when debugging other things.
DebugAttempts	boolean	​Determines whether you want to debug the triers of this attempt, or only the listeners.

200