Lua Player Plus Vita
Documentation of lpp-vita
Functions
Timer

Module that handles system timers. More...

Functions

int Timer::new (void)
 Create a new system timer. More...
 
int Timer::getTime (int timer)
 Get a system timer time. More...
 
void Timer::setTime (int timer, int msecs)
 Set a system timer time. More...
 
void Timer::destroy (int timer)
 Destroy a system timer. More...
 
void Timer::pause (int timer)
 Pause a system timer. More...
 
void Timer::resume (int timer)
 Resume a system timer. More...
 
void Timer::reset (int timer)
 Reset a system timer time. More...
 
bool Timer::isPlaying (int timer)
 Check if a system timer is in playing state. More...
 

Detailed Description

Module that handles system timers.

Function Documentation

◆ new()

int Timer::new ( void  )

Create a new system timer.

Usage example:
tmr = Timer.new()
Timer
Definition: luaTimer.cpp:6
Timer::new
int new(void)
Create a new system timer.
Returns
The system timer ID.
Note
The created timer will be already in playing state.

◆ getTime()

int Timer::getTime ( int  timer)

Get a system timer time.

Usage example:
time = Timer.getTime(tmr)
Timer::getTime
int getTime(int timer)
Get a system timer time.
Parameters
timer- The timer ID to get the time of.
Returns
The time of the given timer in milliseconds.

◆ setTime()

void Timer::setTime ( int  timer,
int  msecs 
)

Set a system timer time.

Usage example:
Timer.setTime(tmr, 1000)
Timer::setTime
void setTime(int timer, int msecs)
Set a system timer time.
Parameters
timer- The timer ID to set the time of.
msecs- The time to set in milliseconds.

◆ destroy()

void Timer::destroy ( int  timer)

Destroy a system timer.

Usage example:
Timer.destroy(tmr)
Timer::destroy
void destroy(int timer)
Destroy a system timer.
Parameters
timer- The timer ID to destroy.

◆ pause()

void Timer::pause ( int  timer)

Pause a system timer.

Usage example:
Timer.pause(tmr)
Timer::pause
void pause(int timer)
Pause a system timer.
Parameters
timer- The timer ID to pause.

◆ resume()

void Timer::resume ( int  timer)

Resume a system timer.

Usage example:
Timer.resume(tmr)
Timer::resume
void resume(int timer)
Resume a system timer.
Parameters
timer- The timer ID to resume.

◆ reset()

void Timer::reset ( int  timer)

Reset a system timer time.

Usage example:
Timer.reset(tmr)
Timer::reset
void reset(int timer)
Reset a system timer time.
Parameters
timer- The timer ID to reset.

◆ isPlaying()

bool Timer::isPlaying ( int  timer)

Check if a system timer is in playing state.

Usage example:
if Timer.isPlaying(tmr) then
Timer.pause(tmr)
end
Timer::isPlaying
bool isPlaying(int timer)
Check if a system timer is in playing state.
Parameters
timer- The timer ID to check.
Returns
true if playing, false otherwise.