Scheduler is responsible for triggering the scheduled callbacks. More...

#include <CCScheduler.h>

Inheritance diagram for Scheduler:

Public Member Functions
	Scheduler ()
virtual	~Scheduler ()
float	getTimeScale ()
void	setTimeScale (float timeScale)
	Modifies the time of all scheduled callbacks. More...

void	update (float dt)
	'update' the scheduler. More...

void	schedule (const ccSchedulerFunc &callback, void *target, float interval, unsigned int repeat, float delay, bool paused, const std::string &key)
	The scheduled method will be called every 'interval' seconds. More...

void	schedule (const ccSchedulerFunc &callback, void *target, float interval, bool paused, const std::string &key)
	Calls scheduleCallback with kRepeatForever and a 0 delay. More...

void	schedule (SEL_SCHEDULE selector, Ref *target, float interval, unsigned int repeat, float delay, bool paused)
	The scheduled method will be called every 'interval' seconds. More...

void	schedule (SEL_SCHEDULE selector, Ref *target, float interval, bool paused)
	calls scheduleSelector with kRepeatForever and a 0 delay More...

template<class T >
void	scheduleUpdate (T *target, int priority, bool paused)
	Schedules the 'update' selector for a given target with a given priority. More...

void	unschedule (const std::string &key, void *target)
	Unschedules a callback for a key and a given target. More...

void	unschedule (SEL_SCHEDULE selector, Ref *target)
	Unschedule a selector for a given target. More...

void	unscheduleUpdate (void *target)
	Unschedules the update selector for a given target. More...

void	unscheduleAllForTarget (void *target)
	Unschedules all selectors for a given target. More...

void	unscheduleAll (void)
	Unschedules all selectors from all targets. More...

void	unscheduleAllWithMinPriority (int minPriority)
	Unschedules all selectors from all targets with a minimum priority. More...

bool	isScheduled (const std::string &key, void *target)
	Checks whether a callback associated with 'key' and 'target' is scheduled. More...

bool	isScheduled (SEL_SCHEDULE selector, Ref *target)
	Checks whether a selector for a given taget is scheduled. More...

void	pauseTarget (void *target)
	Pauses the target. More...

void	resumeTarget (void *target)
	Resumes the target. More...

bool	isTargetPaused (void *target)
	Returns whether or not the target is paused. More...

std::set< void * >	pauseAllTargets ()
	Pause all selectors from all targets. More...

std::set< void * >	pauseAllTargetsWithMinPriority (int minPriority)
	Pause all selectors from all targets with a minimum priority. More...

void	resumeTargets (const std::set< void * > &targetsToResume)
	Resume selectors on a set of targets. More...

void	performFunctionInCocosThread (const std::function< void()> &function)
	calls a function on the cocos2d thread. More...

CC_DEPRECATED_ATTRIBUTE void	scheduleSelector (SEL_SCHEDULE selector, Ref *target, float interval, unsigned int repeat, float delay, bool paused)
	The scheduled method will be called every 'interval' seconds. More...

CC_DEPRECATED_ATTRIBUTE void	scheduleSelector (SEL_SCHEDULE selector, Ref *target, float interval, bool paused)
	calls scheduleSelector with kRepeatForever and a 0 delay More...

template<class T >
CC_DEPRECATED_ATTRIBUTE void	scheduleUpdateForTarget (T *target, int priority, bool paused)
	Schedules the 'update' selector for a given target with a given priority. More...

CC_DEPRECATED_ATTRIBUTE void	unscheduleSelector (SEL_SCHEDULE selector, Ref *target)
	Unschedule a selector for a given target. More...

CC_DEPRECATED_ATTRIBUTE bool	isScheduledForTarget (Ref *target, SEL_SCHEDULE selector)
	Checks whether a selector for a given taget is scheduled. More...

CC_DEPRECATED_ATTRIBUTE void	unscheduleUpdateForTarget (Ref *target)
	Unschedules the update selector for a given target. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Release the ownership immediately. More...

Ref *	autorelease ()
	Release the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()

Static Public Attributes
static const int	PRIORITY_SYSTEM
static const int	PRIORITY_NON_SYSTEM_MIN

Protected Member Functions
void	schedulePerFrame (const ccSchedulerFunc &callback, void *target, int priority, bool paused)
	Schedules the 'callback' function for a given target with a given priority. More...

void	removeHashElement (struct _hashSelectorEntry *element)
void	removeUpdateFromHash (struct _listEntry *entry)
void	priorityIn (struct _listEntry *list, const ccSchedulerFunc &callback, void target, int priority, bool paused)
void	appendIn (struct _listEntry *list, const ccSchedulerFunc &callback, void target, bool paused)
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
float	_timeScale
struct _listEntry *	_updatesNegList
struct _listEntry *	_updates0List
struct _listEntry *	_updatesPosList
struct _hashUpdateEntry *	_hashForUpdates
struct _hashSelectorEntry *	_hashForTimers
struct _hashSelectorEntry *	_currentTarget
bool	_currentTargetSalvaged
bool	_updateHashLocked
std::vector< std::function < void()> >	_functionsToPerform
std::mutex	_performMutex
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Detailed Description

Scheduler is responsible for triggering the scheduled callbacks.

You should not use system timer for your game logic. Instead, use this class.

There are 2 different types of callbacks (selectors):

update selector: the 'update' selector will be called every frame. You can customize the priority.
custom selector: A custom selector will be called every frame, or with a custom interval of time

The 'custom selectors' should be avoided when possible. It is faster, and consumes less memory to use the 'update selector'.

Constructor & Destructor Documentation

Scheduler ( )

virtual ~Scheduler ( )

virtual

Member Function Documentation

void appendIn	(	struct _listEntry **	list,
		const ccSchedulerFunc &	callback,
		void *	target,
		bool	paused
	)

protected

float getTimeScale ( )

inline

bool isScheduled	(	const std::string &	key,
		void *	target
	)

Checks whether a callback associated with 'key' and 'target' is scheduled.

Since: v3.0.0

bool isScheduled	(	SEL_SCHEDULE	selector,
		Ref *	target
	)

Checks whether a selector for a given taget is scheduled.

Since: v3.0

CC_DEPRECATED_ATTRIBUTE bool isScheduledForTarget	(	Ref *	target,
		SEL_SCHEDULE	selector
	)

inline

Checks whether a selector for a given taget is scheduled.

Deprecated:: Please use 'Scheduler::isScheduled' instead.

Since: v0.99.3

bool isTargetPaused ( void * target)

Returns whether or not the target is paused.

Since: v1.0.0 In js: var isTargetPaused(var jsObject)

std::set<void*> pauseAllTargets ( )

Pause all selectors from all targets.

You should NEVER call this method, unless you know what you are doing.

Since: v2.0.0

std::set<void*>
pauseAllTargetsWithMinPriority ( int minPriority)

Pause all selectors from all targets with a minimum priority.

You should only call this with kPriorityNonSystemMin or higher.

Since: v2.0.0

void pauseTarget ( void * target)

Pauses the target.

All scheduled selectors/update for a given target won't be 'ticked' until the target is resumed. If the target is not present, nothing happens.

Since: v0.99.3

void performFunctionInCocosThread ( const std::function< void()> & function)

calls a function on the cocos2d thread.

Useful when you need to call a cocos2d function from another thread. This function is thread safe.

Since: v3.0

void priorityIn	(	struct _listEntry **	list,
		const ccSchedulerFunc &	callback,
		void *	target,
		int	priority,
		bool	paused
	)

protected

void removeHashElement ( struct _hashSelectorEntry * element)

protected

void removeUpdateFromHash ( struct _listEntry * entry)

protected

void resumeTarget ( void * target)

Resumes the target.

The 'target' will be unpaused, so all schedule selectors/update will be 'ticked' again. If the target is not present, nothing happens.

Since: v0.99.3

void resumeTargets ( const std::set< void * > & targetsToResume)

Resume selectors on a set of targets.

This can be useful for undoing a call to pauseAllSelectors.

Since: v2.0.0

void schedule	(	const ccSchedulerFunc &	callback,
		void *	target,
		float	interval,
		unsigned int	repeat,
		float	delay,
		bool	paused,
		const std::string &	key
	)

The scheduled method will be called every 'interval' seconds.

If paused is true, then it won't be called until it is resumed. If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdate' instead. If the 'callback' is already scheduled, then only the interval parameter will be updated without re-scheduling it again. repeat let the action be repeated repeat + 1 times, use kRepeatForever to let the action run continuously delay is the amount of time the action will wait before it'll start

Parameters

key	The key to identify the callback

Since: v3.0

void schedule	(	const ccSchedulerFunc &	callback,
		void *	target,
		float	interval,
		bool	paused,
		const std::string &	key
	)

Calls scheduleCallback with kRepeatForever and a 0 delay.

Since: v3.0

void schedule	(	SEL_SCHEDULE	selector,
		Ref *	target,
		float	interval,
		unsigned int	repeat,
		float	delay,
		bool	paused
	)

The scheduled method will be called every 'interval' seconds.

If paused is true, then it won't be called until it is resumed. If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdate' instead. If the selector is already scheduled, then only the interval parameter will be updated without re-scheduling it again. repeat let the action be repeated repeat + 1 times, use kRepeatForever to let the action run continuously delay is the amount of time the action will wait before it'll start

Since: v3.0, repeat and delay added in v1.1

void schedule	(	SEL_SCHEDULE	selector,
		Ref *	target,
		float	interval,
		bool	paused
	)

calls scheduleSelector with kRepeatForever and a 0 delay

void schedulePerFrame	(	const ccSchedulerFunc &	callback,
		void *	target,
		int	priority,
		bool	paused
	)

protected

Schedules the 'callback' function for a given target with a given priority.

The 'callback' selector will be called every frame. The lower the priority, the earlier it is called.

Note: This method is only for internal use.

Since: v3.0

CC_DEPRECATED_ATTRIBUTE void scheduleSelector	(	SEL_SCHEDULE	selector,
		Ref *	target,
		float	interval,
		unsigned int	repeat,
		float	delay,
		bool	paused
	)

inline

The scheduled method will be called every 'interval' seconds.

If paused is true, then it won't be called until it is resumed. If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdateForTarget:' instead. If the selector is already scheduled, then only the interval parameter will be updated without re-scheduling it again. repeat let the action be repeated repeat + 1 times, use kRepeatForever to let the action run continuously delay is the amount of time the action will wait before it'll start

Deprecated:: Please use 'Scheduler::schedule' instead.

Since: v0.99.3, repeat and delay added in v1.1

CC_DEPRECATED_ATTRIBUTE void scheduleSelector	(	SEL_SCHEDULE	selector,
		Ref *	target,
		float	interval,
		bool	paused
	)

inline

calls scheduleSelector with kRepeatForever and a 0 delay

Deprecated:: Please use 'Scheduler::schedule' instead.

void scheduleUpdate	(	T *	target,
		int	priority,
		bool	paused
	)

inline

Schedules the 'update' selector for a given target with a given priority.

The 'update' selector will be called every frame. The lower the priority, the earlier it is called.

Since: v3.0

CC_DEPRECATED_ATTRIBUTE void scheduleUpdateForTarget	(	T *	target,
		int	priority,
		bool	paused
	)

inline

Schedules the 'update' selector for a given target with a given priority.

The 'update' selector will be called every frame. The lower the priority, the earlier it is called.

Deprecated:: Please use 'Scheduler::scheduleUpdate' instead.

Since: v0.99.3

void setTimeScale ( float timeScale)

inline

Modifies the time of all scheduled callbacks.

You can use this property to create a 'slow motion' or 'fast forward' effect. Default is 1.0. To create a 'slow motion' effect, use values below 1.0. To create a 'fast forward' effect, use values higher than 1.0.

Since: v0.8

Warning: It will affect EVERY scheduled selector / action.

void unschedule	(	const std::string &	key,
		void *	target
	)

Unschedules a callback for a key and a given target.

If you want to unschedule the 'callbackPerFrame', use unscheduleUpdate.

Since: v3.0

void unschedule	(	SEL_SCHEDULE	selector,
		Ref *	target
	)

Unschedule a selector for a given target.

If you want to unschedule the "update", use unscheudleUpdate.

Since: v3.0

void unscheduleAll ( void )

Unschedules all selectors from all targets.

You should NEVER call this method, unless you know what you are doing.

Since: v0.99.3

void unscheduleAllForTarget ( void * target)

Unschedules all selectors for a given target.

This also includes the "update" selector.

Since: v0.99.3

void unscheduleAllWithMinPriority ( int minPriority)

Unschedules all selectors from all targets with a minimum priority.

You should only call this with kPriorityNonSystemMin or higher.

Since: v2.0.0

CC_DEPRECATED_ATTRIBUTE void unscheduleSelector	(	SEL_SCHEDULE	selector,
		Ref *	target
	)

inline

Unschedule a selector for a given target.

If you want to unschedule the "update", use unscheudleUpdateForTarget.

Deprecated:: Please use 'Scheduler::unschedule' instead.

Since: v0.99.3

void unscheduleUpdate ( void * target)

Unschedules the update selector for a given target.

Since: v0.99.3

CC_DEPRECATED_ATTRIBUTE void
unscheduleUpdateForTarget ( Ref * target)

inline

Unschedules the update selector for a given target.

Deprecated:: Please use 'Scheduler::unscheduleUpdate' instead.

Since: v0.99.3

void update ( float dt)

'update' the scheduler.

You should NEVER call this method, unless you know what you are doing.

Member Data Documentation

struct _hashSelectorEntry*
_currentTarget

protected

bool _currentTargetSalvaged

protected

std::vector<std::function<void()>
> _functionsToPerform

protected

struct _hashSelectorEntry*
_hashForTimers

protected

struct _hashUpdateEntry*
_hashForUpdates

protected

std::mutex _performMutex

protected

float _timeScale

protected

bool _updateHashLocked

protected

struct _listEntry* _updates0List

protected

struct _listEntry* _updatesNegList

protected

struct _listEntry* _updatesPosList

protected

const int PRIORITY_NON_SYSTEM_MIN

static

const int PRIORITY_SYSTEM

static

The documentation for this class was generated from the following file:

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/CCScheduler.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation