CCEffectInstanceTimed

CCEffectInstanceTimed

Class: CCEffectInstanceTimed

Inherits: CCEffectInstance < RefCounted < Object

An instance of a timed effect.

Description

CCEffectInstanceTimed holds information about the state of a running CCEffectTimed.

Methods

type	signature
CCEffectTimed	get_effect_timed() const
float	get_end_time() const
float	get_time_left() const
bool	is_active() const
bool	is_paused() const
bool	should_be_running() const

Method Descriptions

CCEffectTimed get_effect_timed() const : Shortcut to get the result of get_effect() as CCEffectTimed.

float get_end_time() const : Returns the time at which this effect will be stopped and removed from the queue.

float get_time_left() const : Returns the time left before the effect ends.

bool is_active() const : Returns if the effect is currently active.

bool is_paused() const : Returns if the effect was paused.

bool should_be_running() const : Returns true if the effect should be running.