CCEffectBase

Inherits MonoBehaviour

Public Member Functions

void

ToggleSellable(bool sellable)

Toggles whether this effect can currently be sold during this session.

void

ToggleVisible(bool visible)

Toggles whether this effect is visible in the menu during this session.

void

UpdatePrice(uint newPrice)

Updates the price on the effect menu during runtime.

void

UpdateNonPoolable(bool newNonPoolable)

Updates whether this effect is poolable or not.

void

UpdateSessionMax(uint newSessionMax)

Updates the amount of times you can use this effect during runtime.

virtual

bool

CanBeRan()

Determines whether this effect can be ran right now or not. Overridable

virtual

void

RegisterParameters(CCEffectEntries effectEntries)

Registers a paramter for this effect. Overridable

virtual

bool

HasParameterID(string id)

Returns true if this bid war is the parent of the parameter ID. Overridable

string

SetIdentifier()

Sets the internal ID of this effect.

Protected Functions

abstract

EffectResult

OnTriggerEffect(CCEffectInstance effectInstance)

Called when an effect instance is scheduled for execution. The returned value is communicated back to the server. If EffectResult.Retry is returned, will be called again in retryDelay seconds, unless maxRetries is reached.

Public Attributes

string

Categories

Categories for this effect.

Internal Attributes

float

delayUntilUnscaledTime

Wait until this time before triggering the next effect instance. Used by CrowdControl.TryStart.

Properties

Sprite

Icon

[get, ]

The effect's icon.

string

ID

[get, ]

The effect's unique id.

string

Name

[get, ]

The name of this effect.

string

Description

[get, ]

Information about the effect, displayed in the extension.

bool

NoPooling

[get, ]

Disables pooling for this effect.

Morality

Morality

[get, ]

// Denotes whether this effect intends to help the player, hurt the player, or act as neutral.

bool

Visible

[get, ]

If true, the effect will be inaccessible to everyone but Warp World staff, unless turned off later.

bool

Sellable

[get, ]

If true, this effect will appear but not be sellable unless turned off later.

Color

IconColor

[get, ]

The color tint of this effect's icon

int

MaxRetries

[get, ]

Number of retries before the effect instance fails.

float

RetryDelay

[get, ]

Delay in seconds before retrying to trigger an effect instance.

float

PendingDelay

[get, ]

Delay in seconds to wait before triggering the next effect instance.

uint

Price

[get, ]

Delay in seconds to wait before triggering the next effect instance.

uint

SessionMax

[get, ]

How many times can this effect be used during one session?