2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2011 Zynga Inc.
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __CCSCHEDULER_H__
|
|
|
|
#define __CCSCHEDULER_H__
|
|
|
|
|
|
|
|
#include <functional>
|
|
|
|
#include <mutex>
|
|
|
|
#include <set>
|
2023-10-12 22:00:46 +08:00
|
|
|
#include "base/axstd.h"
|
2024-05-03 22:15:08 +08:00
|
|
|
#include "base/Object.h"
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "base/Vector.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
class Scheduler;
|
|
|
|
|
|
|
|
typedef std::function<void(float)> ccSchedulerFunc;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @cond
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
class AX_DLL Timer : public Object
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
protected:
|
|
|
|
Timer();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
|
|
|
void setupTimerWithInterval(float seconds, unsigned int repeat, float delay);
|
|
|
|
void setAborted() { _aborted = true; }
|
|
|
|
bool isAborted() const { return _aborted; }
|
|
|
|
bool isExhausted() const;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual void trigger(float dt) = 0;
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual void cancel() = 0;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** triggers the timer */
|
|
|
|
void update(float dt);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
2021-12-25 10:04:45 +08:00
|
|
|
Scheduler* _scheduler; // weak ref
|
2019-11-23 20:27:39 +08:00
|
|
|
float _elapsed;
|
|
|
|
bool _runForever;
|
|
|
|
bool _useDelay;
|
|
|
|
unsigned int _timesExecuted;
|
2021-12-25 10:04:45 +08:00
|
|
|
unsigned int _repeat; // 0 = once, 1 is 2 x executed
|
2019-11-23 20:27:39 +08:00
|
|
|
float _delay;
|
|
|
|
float _interval;
|
|
|
|
bool _aborted;
|
|
|
|
};
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL TimerTargetSelector : public Timer
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
TimerTargetSelector();
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Initializes a timer with a target, a selector and an interval in seconds, repeat in number of times to repeat,
|
|
|
|
* delay in seconds. */
|
|
|
|
bool initWithSelector(Scheduler* scheduler,
|
|
|
|
SEL_SCHEDULE selector,
|
2024-05-03 22:15:08 +08:00
|
|
|
Object* target,
|
2021-12-25 10:04:45 +08:00
|
|
|
float seconds,
|
|
|
|
unsigned int repeat,
|
|
|
|
float delay);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
SEL_SCHEDULE getSelector() const { return _selector; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual void trigger(float dt) override;
|
|
|
|
virtual void cancel() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
2024-05-03 22:15:08 +08:00
|
|
|
Object* _target;
|
2019-11-23 20:27:39 +08:00
|
|
|
SEL_SCHEDULE _selector;
|
|
|
|
};
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL TimerTargetCallback : public Timer
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
TimerTargetCallback();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
// Initializes a timer with a target, a lambda and an interval in seconds, repeat in number of times to repeat,
|
|
|
|
// delay in seconds.
|
|
|
|
bool initWithCallback(Scheduler* scheduler,
|
|
|
|
const ccSchedulerFunc& callback,
|
|
|
|
void* target,
|
2021-12-31 12:12:40 +08:00
|
|
|
std::string_view key,
|
2021-12-25 10:04:45 +08:00
|
|
|
float seconds,
|
|
|
|
unsigned int repeat,
|
|
|
|
float delay);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
const ccSchedulerFunc& getCallback() const { return _callback; }
|
2021-12-31 12:12:40 +08:00
|
|
|
std::string_view getKey() const { return _key; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual void trigger(float dt) override;
|
|
|
|
virtual void cancel() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
|
|
|
void* _target;
|
|
|
|
ccSchedulerFunc _callback;
|
|
|
|
std::string _key;
|
|
|
|
};
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL TimerScriptHandler : public Timer
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
bool initWithScriptHandler(int handler, float seconds);
|
|
|
|
int getScriptHandler() const { return _scriptHandler; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual void trigger(float dt) override;
|
|
|
|
virtual void cancel() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
private:
|
|
|
|
int _scriptHandler;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @endcond
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup base
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2023-10-12 22:00:46 +08:00
|
|
|
// data structures
|
|
|
|
|
|
|
|
struct SchedHandle
|
|
|
|
{
|
2023-10-17 23:04:50 +08:00
|
|
|
SchedHandle(axstd::pod_vector<SchedHandle*>* o, const ccSchedulerFunc& cb, void* t, int pri, bool psd) noexcept
|
2023-10-12 22:00:46 +08:00
|
|
|
: owner(o), callback(cb), target(t), priority(pri), paused(psd)
|
|
|
|
{}
|
|
|
|
SchedHandle(const SchedHandle&) = delete;
|
2023-10-17 23:04:50 +08:00
|
|
|
axstd::pod_vector<SchedHandle*>* owner; // the owner sched list of this sched
|
2023-10-12 22:00:46 +08:00
|
|
|
ccSchedulerFunc callback;
|
|
|
|
void* target;
|
|
|
|
int priority;
|
|
|
|
bool paused;
|
|
|
|
// selector will no longer be called and entry will be removed at end of the next tick
|
|
|
|
bool markedForDeletion = false;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct TimerHandle
|
|
|
|
{
|
|
|
|
Vector<Timer*> timers;
|
|
|
|
int timerIndex;
|
|
|
|
Timer* currentTimer;
|
|
|
|
bool paused;
|
|
|
|
};
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
class SchedulerScriptHandlerEntry;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/** @brief 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
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
The 'custom selectors' should be avoided when possible. It is faster, and consumes less memory to use the 'update
|
|
|
|
selector'.
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
class AX_DLL Scheduler : public Object
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Priority level reserved for system services.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @lua NA
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
static const int PRIORITY_SYSTEM;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
/** Minimum priority level for user scheduling.
|
2019-11-23 20:27:39 +08:00
|
|
|
* Priority level of user scheduling should bigger then this value.
|
|
|
|
*
|
|
|
|
* @lua NA
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
static const int PRIORITY_NON_SYSTEM_MIN;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* @js ctor
|
|
|
|
*/
|
|
|
|
Scheduler();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Destructor
|
|
|
|
*
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~Scheduler();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the time scale of schedule callbacks.
|
|
|
|
* @see Scheduler::setTimeScale()
|
|
|
|
*/
|
|
|
|
float getTimeScale() { return _timeScale; }
|
|
|
|
/** 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 setTimeScale(float timeScale) { _timeScale = timeScale; }
|
|
|
|
|
|
|
|
/** 'update' the scheduler.
|
|
|
|
* You should NEVER call this method, unless you know what you are doing.
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
void update(float dt);
|
|
|
|
|
|
|
|
/////////////////////////////////////
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
// schedule
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** 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.
|
2021-12-25 10:04:45 +08:00
|
|
|
If the 'callback' is already scheduled, then only the interval parameter will be updated without re-scheduling it
|
2022-07-16 10:43:05 +08:00
|
|
|
again. repeat let the action be repeated repeat + 1 times, use AX_REPEAT_FOREVER to let the action run continuously
|
2019-11-23 20:27:39 +08:00
|
|
|
delay is the amount of time the action will wait before it'll start.
|
|
|
|
@param callback The callback function.
|
|
|
|
@param target The target of the callback function.
|
2021-12-25 10:04:45 +08:00
|
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every
|
|
|
|
frame.
|
2019-11-23 20:27:39 +08:00
|
|
|
@param repeat repeat+1 times to schedule the callback.
|
2021-12-25 10:04:45 +08:00
|
|
|
@param delay Schedule call back after `delay` seconds. If the value is not 0, the first schedule will happen after
|
|
|
|
`delay` seconds. But it will only affect first schedule. After first schedule, the delay time is determined by
|
|
|
|
`interval`.
|
2019-11-23 20:27:39 +08:00
|
|
|
@param paused Whether or not to pause the schedule.
|
|
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
|
|
@since v3.0
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void schedule(const ccSchedulerFunc& callback,
|
|
|
|
void* target,
|
|
|
|
float interval,
|
|
|
|
unsigned int repeat,
|
|
|
|
float delay,
|
|
|
|
bool paused,
|
2021-12-31 12:12:40 +08:00
|
|
|
std::string_view key);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** The scheduled method will be called every 'interval' seconds for ever.
|
|
|
|
@param callback The callback function.
|
|
|
|
@param target The target of the callback function.
|
2021-12-25 10:04:45 +08:00
|
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every
|
|
|
|
frame.
|
2019-11-23 20:27:39 +08:00
|
|
|
@param paused Whether or not to pause the schedule.
|
|
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
|
|
@since v3.0
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
void schedule(const ccSchedulerFunc& callback, void* target, float interval, bool paused, std::string_view key);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** 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.
|
2021-12-25 10:04:45 +08:00
|
|
|
If the selector is already scheduled, then only the interval parameter will be updated without re-scheduling it
|
2022-07-16 10:43:05 +08:00
|
|
|
again. repeat let the action be repeated repeat + 1 times, use AX_REPEAT_FOREVER to let the action run continuously
|
2019-11-23 20:27:39 +08:00
|
|
|
delay is the amount of time the action will wait before it'll start
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
@param selector The callback function.
|
|
|
|
@param target The target of the callback function.
|
2021-12-25 10:04:45 +08:00
|
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every
|
|
|
|
frame.
|
2019-11-23 20:27:39 +08:00
|
|
|
@param repeat repeat+1 times to schedule the callback.
|
2021-12-25 10:04:45 +08:00
|
|
|
@param delay Schedule call back after `delay` seconds. If the value is not 0, the first schedule will happen after
|
|
|
|
`delay` seconds. But it will only affect first schedule. After first schedule, the delay time is determined by
|
|
|
|
`interval`.
|
2019-11-23 20:27:39 +08:00
|
|
|
@param paused Whether or not to pause the schedule.
|
|
|
|
@since v3.0
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
void schedule(SEL_SCHEDULE selector, Object* target, float interval, unsigned int repeat, float delay, bool paused);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** The scheduled method will be called every `interval` seconds for ever.
|
|
|
|
@param selector The callback function.
|
|
|
|
@param target The target of the callback function.
|
2021-12-25 10:04:45 +08:00
|
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every
|
|
|
|
frame.
|
2019-11-23 20:27:39 +08:00
|
|
|
@param paused Whether or not to pause the schedule.
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
void schedule(SEL_SCHEDULE selector, Object* target, float interval, bool paused);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** 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
|
|
|
|
@lua NA
|
|
|
|
*/
|
|
|
|
template <class T>
|
2021-12-25 10:04:45 +08:00
|
|
|
void scheduleUpdate(T* target, int priority, bool paused)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
2021-12-25 10:04:45 +08:00
|
|
|
this->schedulePerFrame([target](float dt) { target->update(dt); }, target, priority, paused);
|
2019-11-23 20:27:39 +08:00
|
|
|
}
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
// Schedule for script bindings.
|
|
|
|
/** The scheduled script callback 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.
|
|
|
|
return schedule script entry ID, used for unscheduleScriptFunc().
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
@warn Don't invoke this function unless you know what you are doing.
|
|
|
|
@js NA
|
|
|
|
@lua NA
|
|
|
|
*/
|
|
|
|
unsigned int scheduleScriptFunc(unsigned int handler, float interval, bool paused);
|
|
|
|
#endif
|
|
|
|
/////////////////////////////////////
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
// unschedule
|
|
|
|
|
|
|
|
/** Unschedules a callback for a key and a given target.
|
|
|
|
If you want to unschedule the 'callbackPerFrame', use unscheduleUpdate.
|
|
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
|
|
@param target The target to be unscheduled.
|
|
|
|
@since v3.0
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
void unschedule(std::string_view key, void* target);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** Unschedules a selector for a given target.
|
|
|
|
If you want to unschedule the "update", use `unscheduleUpdate()`.
|
|
|
|
@param selector The selector that is unscheduled.
|
|
|
|
@param target The target of the unscheduled selector.
|
|
|
|
@since v3.0
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
void unschedule(SEL_SCHEDULE selector, Object* target);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Unschedules the update selector for a given target
|
|
|
|
@param target The target to be unscheduled.
|
|
|
|
@since v0.99.3
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void unscheduleUpdate(void* target);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Unschedules all selectors for a given target.
|
|
|
|
This also includes the "update" selector.
|
|
|
|
@param target The target to be unscheduled.
|
|
|
|
@since v0.99.3
|
|
|
|
@lua NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void unscheduleAllForTarget(void* target);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Unschedules all selectors from all targets.
|
|
|
|
You should NEVER call this method, unless you know what you are doing.
|
|
|
|
@since v0.99.3
|
|
|
|
*/
|
|
|
|
void unscheduleAll();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Unschedules all selectors from all targets with a minimum priority.
|
|
|
|
You should only call this with `PRIORITY_NON_SYSTEM_MIN` or higher.
|
|
|
|
@param minPriority The minimum priority of selector to be unscheduled. Which means, all selectors which
|
|
|
|
priority is higher than minPriority will be unscheduled.
|
|
|
|
@since v2.0.0
|
|
|
|
*/
|
|
|
|
void unscheduleAllWithMinPriority(int minPriority);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Unschedule a script entry.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @warning Don't invoke this function unless you know what you are doing.
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
void unscheduleScriptEntry(unsigned int scheduleScriptEntryID);
|
|
|
|
#endif
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/////////////////////////////////////
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
// isScheduled
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Checks whether a callback associated with 'key' and 'target' is scheduled.
|
|
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
|
|
@param target The target of the callback.
|
|
|
|
@return True if the specified callback is invoked, false if not.
|
|
|
|
@since v3.0.0
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
bool isScheduled(std::string_view key, const void* target) const;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Checks whether a selector for a given target is scheduled.
|
|
|
|
@param selector The selector to be checked.
|
|
|
|
@param target The target of the callback.
|
|
|
|
@return True if the specified selector is invoked, false if not.
|
|
|
|
@since v3.0
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
bool isScheduled(SEL_SCHEDULE selector, const Object* target) const;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/////////////////////////////////////
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** 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.
|
|
|
|
@param target The target to be paused.
|
|
|
|
@since v0.99.3
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void pauseTarget(void* target);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** 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.
|
|
|
|
@param target The target to be resumed.
|
|
|
|
@since v0.99.3
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void resumeTarget(void* target);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** Returns whether or not the target is paused.
|
|
|
|
* @param target The target to be checked.
|
|
|
|
* @return True if the target is paused, false if not.
|
|
|
|
* @since v1.0.0
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
bool isTargetPaused(void* target);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** 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*> pauseAllTargets();
|
|
|
|
|
|
|
|
/** Pause all selectors from all targets with a minimum priority.
|
|
|
|
You should only call this with PRIORITY_NON_SYSTEM_MIN or higher.
|
|
|
|
@param minPriority The minimum priority of selector to be paused. Which means, all selectors which
|
|
|
|
priority is higher than minPriority will be paused.
|
|
|
|
@since v2.0.0
|
|
|
|
*/
|
|
|
|
std::set<void*> pauseAllTargetsWithMinPriority(int minPriority);
|
|
|
|
|
|
|
|
/** Resume selectors on a set of targets.
|
|
|
|
This can be useful for undoing a call to pauseAllSelectors.
|
|
|
|
@param targetsToResume The set of targets to be resumed.
|
|
|
|
@since v2.0.0
|
|
|
|
*/
|
|
|
|
void resumeTargets(const std::set<void*>& targetsToResume);
|
|
|
|
|
|
|
|
/** Calls a function on the cocos2d thread. Useful when you need to call a cocos2d function from another thread.
|
|
|
|
This function is thread safe.
|
|
|
|
@param function The function to be run in cocos2d thread.
|
|
|
|
@since v3.0
|
|
|
|
@js NA
|
|
|
|
*/
|
2023-01-01 18:08:25 +08:00
|
|
|
void runOnAxmolThread(std::function<void()> action);
|
|
|
|
|
|
|
|
AX_DEPRECATED_ATTRIBUTE void performFunctionInCocosThread(std::function<void()> action)
|
|
|
|
{
|
|
|
|
runOnAxmolThread(std::move(action));
|
|
|
|
}
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
2023-01-11 23:28:22 +08:00
|
|
|
* Remove all pending functions queued to be performed with Scheduler::runOnAxmolThread
|
2019-11-23 20:27:39 +08:00
|
|
|
* Functions unscheduled in this manner will not be executed
|
|
|
|
* This function is thread safe
|
|
|
|
* @since v3.14
|
|
|
|
* @js NA
|
|
|
|
*/
|
2023-01-01 18:08:25 +08:00
|
|
|
void removeAllPendingActions();
|
|
|
|
AX_DEPRECATED_ATTRIBUTE void removeAllFunctionsToBePerformedInCocosThread() { removeAllPendingActions(); }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
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
|
|
|
|
@js _schedulePerFrame
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void schedulePerFrame(const ccSchedulerFunc& callback, void* target, int priority, bool paused);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
// update specific
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2023-10-12 22:00:46 +08:00
|
|
|
void priorityIn(axstd::pod_vector<SchedHandle*>& list,
|
|
|
|
const ccSchedulerFunc& callback,
|
|
|
|
void* target,
|
|
|
|
int priority,
|
|
|
|
bool paused);
|
|
|
|
void appendIn(axstd::pod_vector<SchedHandle*>& list, const ccSchedulerFunc& callback, void* target, bool paused);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2023-10-17 23:04:50 +08:00
|
|
|
void addToWaitList(const ccSchedulerFunc& callback, void* target, int priority, bool paused);
|
|
|
|
|
|
|
|
void activeWaitList();
|
|
|
|
|
2023-10-16 20:24:38 +08:00
|
|
|
void unscheduleAllForTarget(std::unordered_map<void*, TimerHandle>::iterator& timerIt);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
float _timeScale;
|
|
|
|
|
2023-10-17 23:04:50 +08:00
|
|
|
axstd::pod_vector<SchedHandle*> _waitList; // list wait active
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
//
|
|
|
|
// "updates with priority" stuff
|
|
|
|
//
|
2023-10-12 22:00:46 +08:00
|
|
|
axstd::pod_vector<SchedHandle*> _updatesNegList; // list of priority < 0
|
|
|
|
axstd::pod_vector<SchedHandle*> _updates0List; // list priority == 0
|
|
|
|
axstd::pod_vector<SchedHandle*> _updatesPosList; // list priority > 0
|
|
|
|
// weak reference SchedHandle map used to fetch quickly the list entries for pause,delete,etc
|
|
|
|
std::unordered_map<void*, SchedHandle*> _schedIndexMap;
|
|
|
|
|
|
|
|
// the vector holds list entries that needs to be deleted after update
|
|
|
|
axstd::pod_vector<SchedHandle*> _updateDeleteVector;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
// Used for "selectors with interval"
|
2023-10-12 22:00:46 +08:00
|
|
|
std::unordered_map<void*, TimerHandle> _timersMap;
|
|
|
|
struct TimerHandle* _currentTarget;
|
2019-11-23 20:27:39 +08:00
|
|
|
bool _currentTargetSalvaged;
|
|
|
|
// If true unschedule will not remove anything from a hash. Elements will only be marked for deletion.
|
2023-10-12 22:00:46 +08:00
|
|
|
bool _indexMapLocked;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_SCRIPT_BINDING
|
2019-11-23 20:27:39 +08:00
|
|
|
Vector<SchedulerScriptHandlerEntry*> _scriptHandlerEntries;
|
|
|
|
#endif
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2023-01-01 18:08:25 +08:00
|
|
|
// Used for "perform action"
|
|
|
|
std::vector<std::function<void()>> _actionsToPerform;
|
2019-11-23 20:27:39 +08:00
|
|
|
std::mutex _performMutex;
|
|
|
|
};
|
|
|
|
|
|
|
|
// end of base group
|
|
|
|
/** @} */
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
#endif // __CCSCHEDULER_H__
|