Class Index | File Index

Classes


Class GUI


Extends View.
root GUI object. Handles gamejs events, frames
Defined in: gamejs-gui.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GUI(surface)
Fields borrowed from class View:
children, parent, position, size, surface
Method Summary
Method Attributes Method Name and Description
 
 
despatch gamejs event
 
draw(force_redraw)
redraw GUI, if needed
 
Move a frame to the top
 
Does nothing! don't remove!
 
removeFrame(frame)
Remove a frame from GUI
 
update(msDuration)
Update GUI and its child objects
Methods borrowed from class View:
addChild, blitChild, center, destroy, getGUI, getPosition, getRect, getSize, hide, isFocused, isHovered, isVisible, move, moveRelative, on, refresh, removeChild, resize, show
Class Detail
GUI(surface)
Parameters:
{gamejs.Surface} surface
surface to render GUI on
Method Detail
blur_bg()

despatchEvent(event)
despatch gamejs event
Parameters:
{gamejs Event| GUI event} event
event generated by gamejs, or a GUI event if needed.

draw(force_redraw)
redraw GUI, if needed
Parameters:
{Bool} force_redraw
if true GUI is redrawn even if tehre are no internal changes

moveFrameToTop(frame)
Move a frame to the top
Parameters:
{Frame} frame

paint()
Does nothing! don't remove!

removeFrame(frame)
Remove a frame from GUI
Parameters:
{Frame|Id} frame
frame object or id of frame to remove

update(msDuration)
Update GUI and its child objects
Parameters:
{Number} msDuration
miliseconds since last update

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 15 2011 16:17:32 GMT+0300 (EEST)