Class CancellablePlayerEvent
public class CancellablePlayerEvent : PlayerEvent, IPlayerEvent, ICancellable
- Inheritance
-
CancellablePlayerEvent
- Implements
- Derived
- Inherited Members
Constructors
CancellablePlayerEvent()
public CancellablePlayerEvent()
CancellablePlayerEvent(bool)
public CancellablePlayerEvent(bool shouldAllow)
Parameters
shouldAllowbool
Properties
IsActionCancelled
If the action is also cancelled.
public virtual bool IsActionCancelled { get; }
Property Value
IsCancelled
If this execution has been cancelled.
public virtual bool IsCancelled { get; }
Property Value
Methods
Cancel(bool)
Cancel the execution which will keep the next event listener from running.
public virtual void Cancel(bool cancelAction = true)
Parameters
cancelActionboolAlso cancel whatever action the event represents, such as placing a structure.
CancelAction()
Cancel only the action but allow more event handlers to be ran.
public virtual void CancelAction()
ResumeAction()
Resume (or un-cancel) the action.
public virtual void ResumeAction()