Bottle 2D - Lua API 1.0.0
All you need to create games using bottle2D.
Public Member Functions | Public Attributes

Timer Class Reference

Timer event, to send event at regular interval, see Screen::RegisterTimer to register a timer event. More...

#include <header.hpp>

Inheritance diagram for Timer:
EventHandlerBase

List of all members.

Public Member Functions

number GetInterval ()
 Get the timer interval (time between two events).
nil SetInterval (number numbererval)
 Set the timer interval (time between two events).
nil Start ()
 Start the timer.
nil Stop ()
 Stop / pause the timer.
bool IsRunning ()
 Return true if the timer is running, false overwise.

Public Attributes

float interval
 Access the timer interval (time between two events).

Detailed Description

Timer event, to send event at regular interval, see Screen::RegisterTimer to register a timer event.


Member Function Documentation

number Timer::GetInterval ( )

Get the timer interval (time between two events).

bool Timer::IsRunning ( )

Return true if the timer is running, false overwise.

nil Timer::SetInterval ( number  numbererval)

Set the timer interval (time between two events).

nil Timer::Start ( )

Start the timer.

nil Timer::Stop ( )

Stop / pause the timer.


Member Data Documentation

Access the timer interval (time between two events).


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables