LuaDocs/UInputManager

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
m (1 revision)
m
Line 1: Line 1:
 +
===Has no parent class===
-
'''UInputManager'''
+
'''Generic Class.'''  
 +
The input manager, detects controls made by the user including buttons, mouse movements and game pad controls.
-
 
+
[[LuaDocs/Index|'''Go back to Class Index''']]
-
 
+
-
    LuaDocs/IntRect
+
-
   
+
-
     
+
-
'''Generic Class:''' '''IntRect'''
+
-
 
+
-
 
+
-
 
+
-
    LuaDocs/Scene
+
-
   
+
-
     
+
-
'''Concrete Class:''' '''Scene'''
+
-
 
+
-
 
+
-
Contains everything that defines a complete scene.
+
-
 
+
-
Parent: Entity
+
-
 
+
-
 
+
-
 
+
-
Property:
+
-
 
+
-
'''ClassName'''
+
-
The class name of this Entity.
+
-
A string with the friendly-formatted type name of this object.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Property:
+
-
 
+
-
'''Location'''
+
-
The specified location of this scene on the planet view
+
-
A Vector showing the location of this scene on the planet view.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Read-Only Property:
+
-
 
+
-
'''Dimensions'''
+
-
The total dimensions (width and height) of the scene, in pixels.
+
-
A Vector describing the scene dimensions.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Read-Only Property:
+
-
 
+
-
'''Width'''
+
-
The total width of the scene, in pixels.
+
-
An int describing the scene width.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Read-Only Property:
+
-
 
+
-
'''Height'''
+
-
The total height of the scene, in pixels.
+
-
An int describing the scene width.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Read-Only Property:
+
-
 
+
-
'''WrapsX'''
+
-
Indicates whether the scene wraps its scrolling around the X axis.
+
-
Whether the scene wraps around the X axis or not.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Read-Only Property:
+
-
 
+
-
'''WrapsY'''
+
-
Indicates whether the scene wraps its scrolling around the Y axis.
+
-
Whether the scene wraps around the Y axis or not.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Function:
+
-
 
+
-
'''GetArea'''
+
-
Gets a specific Area identified by a name. Ownership is NOT transferred!
+
-
 
+
-
'''Arguments:'''
+
-
The name of the Area to try to get.
+
-
 
+
-
'''Return value:'''
+
-
A pointer to the Area asked for. 0 if no Area of that name was found.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Function:
+
-
 
+
-
'''WithinArea'''
+
-
Checks if a point is within a specific named Area of this Scene. If no Area of the name is found, this just returns false without error.
+
-
 
+
-
'''Arguments:'''
+
-
The name of the Area to try to check against.
+
-
The point to see if it's within the specified Area.
+
-
 
+
-
'''Return value:'''
+
-
Whether any Area of that name was found, AND the point falls within it.
+
-
 
+
-
 
+
-
 
+
-
 
+
-
Read-Only Property:
+
-
 
+
-
'''GlocalAcc'''
+
-
The global acceleration (in m/s^2) that is applied to all movable objects' velocities during every frame. Typically models gravity.
+
-
A Vector describing the global acceleration.
+

Revision as of 18:00, 11 July 2012

Has no parent class

Generic Class. The input manager, detects controls made by the user including buttons, mouse movements and game pad controls.

Go back to Class Index