Timers

Timers

Timers in SplashKit can be used to track the passing of time.

Functions

Create Timer

Create and return a new Timer. The timer will not be started, and will have an initial ‘ticks’ of 0.

Parameters

Name	Type	Description
name	String	The name of the timer for resource tracking

Return Type - Timer

Signatures

C++

timer create_timer(string name)

C#

public static Timer SplashKit.CreateTimer(string name);
public Timer(string name);

Python

def create_timer(name):

Pascal

function CreateTimer(name: String): Timer

---

Free All Timers

Free all of timers that have been created.

Signatures

C++

void free_all_timers()

C#

public static void Timers.FreeAllTimers();
public static void SplashKit.FreeAllTimers();

Python

def free_all_timers():

Pascal

procedure FreeAllTimers()

---

Free Timer

Free the memory used to store this timer.

Parameters

Name	Type	Description
to_free	Timer	The time to be released.

Signatures

C++

void free_timer(timer to_free)

C#

public void Timer.FreeTimer();
public static void SplashKit.FreeTimer(Timer toFree);

Python

def free_timer(to_free):

Pascal

procedure FreeTimer(toFree: Timer)

---

Has Timer

Checks if SplashKit has a timer with the indicated name.

Parameters

Name	Type	Description
name	String	The name of the timer

Return Type - Boolean

Signatures

C++

bool has_timer(string name)

C#

public static bool Timers.HasTimer(string name);
public static bool SplashKit.HasTimer(string name);

Python

def has_timer__named(name):

Pascal

function HasTimer(name: String): Boolean

---

Pause Timer

Note

This function is overloaded. The following versions exist:

• Pause Timer (name: string, )
• Pause Timer (to_pause: timer, )

Pause Timer

Pause the timer, getting ticks from a paused timer will continue to return the same time.

Parameters

Name	Type	Description
name	String	The name of the timer

Signatures

C++

void pause_timer(string name)

C#

public static void Timers.PauseTimer(string name);
public static void SplashKit.PauseTimer(string name);

Python

def pause_timer__named(name):

Pascal

procedure PauseTimer(name: String)

---

Pause Timer

Pause the timer, getting ticks from a paused timer will continue to return the same time.

Parameters

Name	Type	Description
to_pause	Timer	The timer

Signatures

C++

void pause_timer(timer to_pause)

C#

public void Timer.PauseTimer();
public static void SplashKit.PauseTimer(Timer toPause);

Python

def pause_timer(to_pause):

Pascal

procedure PauseTimer(toPause: Timer)

---

Reset Timer

Note

This function is overloaded. The following versions exist:

• Reset Timer (name: string, )
• Reset Timer (tmr: timer, )

Reset Timer

Resets the named timer

Parameters

Name	Type	Description
name	String	The name of the timer

Signatures

C++

void reset_timer(string name)

C#

public static void Timers.ResetTimer(string name);
public static void SplashKit.ResetTimer(string name);

Python

def reset_timer__named(name):

Pascal

procedure ResetTimer(name: String)

---

Reset Timer

Resets the time of a given timer

Parameters

Name	Type	Description
tmr	Timer	The timer

Signatures

C++

void reset_timer(timer tmr)

C#

public void Timer.ResetTimer();
public static void SplashKit.ResetTimer(Timer tmr);

Python

def reset_timer(tmr):

Pascal

procedure ResetTimer(tmr: Timer)

---

Resume Timer

Note

This function is overloaded. The following versions exist:

• Resume Timer (name: string, )
• Resume Timer (to_resume: timer, )

Resume Timer

Resumes the named timer.

Parameters

Name	Type	Description
name	String	The name of the timer

Signatures

C++

void resume_timer(string name)

C#

public static void Timers.ResumeTimer(string name);
public static void SplashKit.ResumeTimer(string name);

Python

def resume_timer__named(name):

Pascal

procedure ResumeTimer(name: String)

---

Resume Timer

Resumes a paused timer.

Parameters

Name	Type	Description
to_resume	Timer	The timer

Signatures

C++

void resume_timer(timer to_resume)

C#

public void Timer.ResumeTimer();
public static void SplashKit.ResumeTimer(Timer toResume);

Python

def resume_timer(to_resume):

Pascal

procedure ResumeTimer(toResume: Timer)

---

Start Timer

Note

This function is overloaded. The following versions exist:

• Start Timer (name: string, )
• Start Timer (to_start: timer, )

Start Timer

Start a timer. The timer will then start recording the time that has passed. You can check how long has past since the timer was started using the Timer Ticks function.

Parameters

Name	Type	Description
name	String	The name of the timer

Signatures

C++

void start_timer(string name)

C#

public static void Timers.StartTimer(string name);
public static void SplashKit.StartTimer(string name);

Python

def start_timer__named(name):

Pascal

procedure StartTimer(name: String)

---

Start Timer

Start a timer. The timer will then start recording the time that has passed. You can check how long has past since the timer was started using the Timer Ticks function.

Parameters

Name	Type	Description
to_start	Timer	The timer

Signatures

C++

void start_timer(timer to_start)

C#

public void Timer.StartTimer();
public static void SplashKit.StartTimer(Timer toStart);

Python

def start_timer(to_start):

Pascal

procedure StartTimer(toStart: Timer)

---

Stop Timer

Note

This function is overloaded. The following versions exist:

• Stop Timer (name: string, )
• Stop Timer (to_stop: timer, )

Stop Timer

Stop the timer. The time is reset to 0 and you must recall start to begin the timer ticking again.

Parameters

Name	Type	Description
name	String	The name of the timer

Signatures

C++

void stop_timer(string name)

C#

public static void Timers.StopTimer(string name);
public static void SplashKit.StopTimer(string name);

Python

def stop_timer__named(name):

Pascal

procedure StopTimer(name: String)

---

Stop Timer

Stop the timer. The time is reset to 0 and you must recall start to begin the timer ticking again.

Parameters

Name	Type	Description
to_stop	Timer	The timer

Signatures

C++

void stop_timer(timer to_stop)

C#

public void Timer.StopTimer();
public static void SplashKit.StopTimer(Timer toStop);

Python

def stop_timer(to_stop):

Pascal

procedure StopTimer(toStop: Timer)

---

Timer Named

Get the timer created with the indicated name.

Parameters

Name	Type	Description
name	String	The name of the timer to fetch

Return Type - Timer

Signatures

C++

timer timer_named(string name)

C#

public static Timer Timers.TimerNamed(string name);
public static Timer SplashKit.TimerNamed(string name);

Python

def timer_named(name):

Pascal

function TimerNamed(name: String): Timer

---

Timer Paused

Note

This function is overloaded. The following versions exist:

• Timer Paused (name: string, )
• Timer Paused (to_get: timer, )

Timer Paused

Indicates if the timer is paused.

Parameters

Name	Type	Description
name	String	The name of the timer

Return Type - Boolean

Signatures

C++

bool timer_paused(string name)

C#

public static bool Timers.TimerPaused(string name);
public static bool SplashKit.TimerPaused(string name);

Python

def timer_paused__named(name):

Pascal

function TimerPaused(name: String): Boolean

---

Timer Paused

Indicates if the timer is paused.

Parameters

Name	Type	Description
to_get	Timer	The timer

Return Type - Boolean

Signatures

C++

bool timer_paused(timer to_get)

C#

public bool Timer.IsPaused { get }
public static bool SplashKit.TimerPaused(Timer toGet);

Python

def timer_paused(to_get):

Pascal

function TimerPaused(toGet: Timer): Boolean

---

Timer Started

Note

This function is overloaded. The following versions exist:

• Timer Started (name: string, )
• Timer Started (to_get: timer, )

Timer Started

Indicates if the timer is started.

Parameters

Name	Type	Description
name	String	The name of the timer

Return Type - Boolean

Signatures

C++

bool timer_started(string name)

C#

public static bool Timers.TimerStarted(string name);
public static bool SplashKit.TimerStarted(string name);

Python

def timer_started__named(name):

Pascal

function TimerStarted(name: String): Boolean

---

Timer Started

Indicates if the timer is started.

Parameters

Name	Type	Description
to_get	Timer	The timer

Return Type - Boolean

Signatures

C++

bool timer_started(timer to_get)

C#

public bool Timer.IsStarted { get }
public static bool SplashKit.TimerStarted(Timer toGet);

Python

def timer_started(to_get):

Pascal

function TimerStarted(toGet: Timer): Boolean

---

Timer Ticks

Note

This function is overloaded. The following versions exist:

• Timer Ticks (name: string, )
• Timer Ticks (to_get: timer, )

Timer Ticks

Gets the number of ticks (milliseconds) that have passed since the timer was started/reset. When paused the timer’s ticks will not advance until the timer is once again resumed.

Parameters

Name	Type	Description
name	String	The name of the Timer

Return Type - undefined

Signatures

C++

unsigned int timer_ticks(string name)

C#

public static uint Timers.TimerTicks(string name);
public static uint SplashKit.TimerTicks(string name);

Python

def timer_ticks__named(name):

Pascal

function TimerTicks(name: String): Cardinal

---

Timer Ticks

Gets the number of ticks (milliseconds) that have passed since the timer was started/reset. When paused the timer’s ticks will not advance until the timer is once again resumed.

Parameters

Name	Type	Description
to_get	Timer	The timer

Return Type - undefined

Signatures

C++

unsigned int timer_ticks(timer to_get)

C#

public uint Timer.Ticks { get }
public static uint SplashKit.TimerTicks(Timer toGet);

Python

def timer_ticks(to_get):

Pascal

function TimerTicks(toGet: Timer): Cardinal

---

Types

Timer

Timers in SplashKit can be used to track the passing of time. In general you will create a timer, start it, then use it to track time by asking for the timer’s ticks (milliseconds).

Timers in SplashKit can be used to track the passing of time. In general you will create a timer, start it, then use it to track time by asking for the timer’s ticks (milliseconds).

---