Class CancellableEvent

Namespace

Uncreated.Warfare.Events.Models

Assembly

Uncreated.Warfare.dll

public class CancellableEvent : ICancellable

Inheritance

object

CancellableEvent

Implements

ICancellable

Derived

PlaceBarricadeRequested

TriggerTrapRequested

DamageRequested

ItemSpawning

PlayerPending

SpotTargetRequested

PlaceStructureRequested

DamageVehicleRequested

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CancellableEvent()

public CancellableEvent()

CancellableEvent(bool)

public CancellableEvent(bool shouldAllow)

Parameters

shouldAllow bool

Properties

IsActionCancelled

If the action is also cancelled.

public virtual bool IsActionCancelled { get; }

Property Value

bool

IsCancelled

If this execution has been cancelled.

public virtual bool IsCancelled { get; }

Property Value

bool

Methods

Cancel(bool)

Cancel the execution which will keep the next event listener from running.

public virtual void Cancel(bool cancelAction = true)

Parameters

cancelAction bool

Also 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()