Class Channel

Inheritance

object

Channel

Namespace: Global

Assembly: Dew.Core.dll

Syntax

public class Channel

Fields

blockedActions

Blocked actions for the owner of this channel.

This channel will fail if any of the cancelable blocks is disobeyed.

Declaration

public Channel.BlockedAction blockedActions

Field Value

Type	Description
Channel.BlockedAction

duration

Total duration of this channel.

Declaration

public float duration

Field Value

Type	Description
float

isAttack

Only a single attack channel can exist in an entity.

Declaration

public bool isAttack

Field Value

Type	Description
bool

onCancel

Callback function to be called when this channel has been canceled.

This can be because of either an invalidation flag from any of the validators, or cancelable block being canceled by an entity.

Declaration

public Action onCancel

Field Value

Type	Description
System.Action

onComplete

Callback function to be called when this channel has been successfully completed.

Declaration

public Action onComplete

Field Value

Type	Description
System.Action

onTick

Called every logic update tick while channel is alive.

Declaration

public Action<float> onTick

Field Value

Type	Description
System.Action<T><float>

uncancellableTime

If this channel is cancellable, it won't be cancellable during this period to prevent accidental cancel.

Declaration

public float uncancellableTime

Field Value

Type	Description
float

Properties

elapsedTime

Declaration

public float elapsedTime { get; }

Property Value

Type	Description
float

isAlive

Declaration

public bool isAlive { get; }

Property Value

Type	Description
bool

Methods

AddOnCancel(Action)

Declaration

public Channel AddOnCancel(Action callback)

Parameters

Type	Name	Description
System.Action	callback

Returns

Type	Description
Channel

AddOnComplete(Action)

Declaration

public Channel AddOnComplete(Action callback)

Parameters

Type	Name	Description
System.Action	callback

Returns

Type	Description
Channel

AddOnTick(Action<float>)

Declaration

public Channel AddOnTick(Action<float> callback)

Parameters

Type	Name	Description
System.Action<T><float>	callback

Returns

Type	Description
Channel

AddValidation(IBinaryEntityValidator, Entity)

Adds an binary entity validation for this channel. This channel will fail if any of the added validators evaluates to false.

Declaration

public Channel AddValidation(IBinaryEntityValidator validator, Entity entity)

Parameters

Type	Name	Description
IBinaryEntityValidator	validator
Entity	entity

Returns

Type	Description
Channel

AddValidation(IEntityValidator)

Adds an entity validation for this channel. This channel will fail if any of the added validators evaluates to false.

Declaration

public Channel AddValidation(IEntityValidator validator)

Parameters

Type	Name	Description
IEntityValidator	validator

Returns

Type	Description
Channel

Cancel()

Cancel this channel next channel update.

Declaration

public Channel Cancel()

Returns

Type	Description
Channel

Complete()

Complete this channel next channel update.

Declaration

public Channel Complete()

Returns

Type	Description
Channel

Dispatch(Entity)

Dispatch this channel.

Declaration

public Channel Dispatch(Entity e)

Parameters

Type	Name	Description
Entity	e

Returns

Type	Description
Channel