CCEffectInstance

CCEffectInstance

Class: CCEffectInstance

Inherits: RefCounted < Object

Inherited By: CCEffectInstanceBidWar, CCEffectInstanceParameters, CCEffectInstanceTimed

Base class for all Crowd Control effect instances.

Description

An effect instance represents a request from the server to perform the corresponding CCEffect.

Methods

type	signature
CCEffect	get_effect() const
StringName	get_effect_id() const
String	get_id() const
int	get_retry_count() const
float	get_start_time() const
StreamUser	get_user() const
bool	is_test() const

Method Descriptions

CCEffect get_effect() const : Returns the requested effect.

StringName get_effect_id() const : Returns the id of the requested effect.

String get_id() const : Returns the id of the request used to create this instance.

int get_retry_count() const : Returns the amount of times the engine has already tried to execute this effect.

float get_start_time() const : Returns the time in seconds when the effect was triggered.

StreamUser get_user() const : Returns the data of the user that purchased this effect.

bool is_test() const : Returns true is this instance is a test.