IEffectHandler

Interface for handling effects in the game.

Kind: Interface

Namespace: CrowdControl.Games.SmartEffects

Public Member Functions

abstract virtual

bool

StartCondition()

Checks if the effect can be started.

abstract virtual

bool

StartAction()

Attempts to start the effect.

abstract virtual

bool

StartFollowup()

Attempts to start the follow-up action for the effect.

abstract virtual

bool

RefreshCondition()

Checks if the effect can be refreshed.

abstract virtual

bool

RefreshAction()

Attempts to refresh the effect.

abstract virtual

bool

StopAction()

Attempts to stop the effect.

abstract virtual

void

StopFollowup()

Performs any necessary cleanup when the effect is stopped.

Properties

EffectRequest

Request

[get, ]

Gets the request for the effect handler.

EffectHandlerType

Type

[get, ]

Gets or sets the type of the effect handler.

IList

Codes

[get, ]

Gets the IDs of all effects managed by this handler.

IList>

Parameters

[get, ]

Gets the parameter types for the effect handler.

Mutex

Mutexes

[get, ]

Gets a set of mutexes that this effect handler will hold while it is active.

bool

CanAccept

[get, ]

Checks if the effect handler is currently accepting requests.

uint

Quantity

[get, ]

Gets the requested quantity of the effect.

SITimeSpan

Duration

[get, ]

Gets the duration of the effect.

SITimeSpan

FollowUpDelay

[get, ]

Gets the delay before the follow-up action is executed.

SITimeSpan

StartRetry

[get, ]

Gets the delay before the effect is retried.

SITimeSpan

RefreshRetry

[get, ]

Gets the delay before reattempting to retry a failed refresh attempt.

SITimeSpan

RefreshInterval

[get, ]

Gets the interval for refreshing the effect.

IDictionary>

BidWarActions

[get, ]

Gets the set of actions that can be performed during a bid war.

SITimeSpan

StopRetry

[get, ]

Gets the delay before reattempting to retry a failed stop attempt.

SITimeSpan

HoldMutex

[get, ]

Gets any additional time that the effect handler should hold the mutex for.

bool

ExtendOnFail

[get, ]

Checks if the effect handler should extend the duration failure.

bool

RetryOnFail

[get, ]

Checks if the effect handler should retry on failure.