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

Drawable Class Reference

A Drawable is a base class which contains fonctions common to every Drawable object (Group, Sprite, Text...). More...

#include <header.hpp>

Inheritance diagram for Drawable:
Object Group ParticleSource PostFX ScreenRenderer Shape Sprite Text Screen

List of all members.

Public Member Functions

number GetZpos ()
 Get the object's z order.
nil SetZpos (number val)
 Set the object's z order (an object with a low z order will be in the background)
number GetLowZPos ()
 Get the low pos (the low zPos is a creation order, for the object that have the same zPos)
nil Show (bool visible=true)
 Show / hide an object.
nil Hide ()
 Hide and object.
bool IsVisible ()
 Return truc if the object is visible, false otherwise.
bool IsUpperThan (Drawable drawableToCompare)
 Return true if this Drawable is on to of the the given one (higher Zpos)

Public Attributes

int zPos
 Access the object's z order (an object with a low z order will be in the background)
bool visible
 Hide / show the object.

Detailed Description

A Drawable is a base class which contains fonctions common to every Drawable object (Group, Sprite, Text...).

It should not be used directly.


Member Function Documentation

number Drawable::GetLowZPos ( )

Get the low pos (the low zPos is a creation order, for the object that have the same zPos)

number Drawable::GetZpos ( )

Get the object's z order.

nil Drawable::Hide ( )

Hide and object.

bool Drawable::IsUpperThan ( Drawable  drawableToCompare)

Return true if this Drawable is on to of the the given one (higher Zpos)

bool Drawable::IsVisible ( )

Return truc if the object is visible, false otherwise.

nil Drawable::SetZpos ( number  val)

Set the object's z order (an object with a low z order will be in the background)

nil Drawable::Show ( bool  visible = true)

Show / hide an object.


Member Data Documentation

Hide / show the object.

Access the object's z order (an object with a low z order will be in the background)


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