Package | com.divillysausages.gameobjeditor |
Class | public class GUI |
Inheritance | GUI ![]() |
Property | Defined By | ||
---|---|---|---|
clickToSelect : Boolean [write-only]
Can we click to select the current objects?
| GUI | ||
currSelectedItem : *
Returns the currently selected item, if we have one, in our editable dropdown
| GUI | ||
highlightCurrObject : Boolean [write-only]
Should we highlight the current object or not?
| GUI | ||
visible : Boolean [override]
Makes the GUI visible and adds it to the stage
| GUI |
Method | Defined By | ||
---|---|---|---|
Creates the GUI
| GUI | ||
addEditComponentsForObject(obj:Object, editableVars:Vector.<EditableVar>):void
Adds the edit components for an object based on the params in it's EditableVar class
| GUI | ||
addObjectToAvailable(obj:*):void
Adds an object to the available array
| GUI | ||
clearPreviousEditComponents():void
Clears all the previous components for an object
| GUI | ||
log(msg:String, level:int = 1):void
Traces out a message to the console and the log panel
| GUI | ||
removeObjectFromAvailable(obj:*):void
Removes an object from the available array
| GUI | ||
updateComponentValues(obj:*, updateOnlyWatch:Boolean = true):void
Updates the values for the current object that we're displaying
| GUI |
clickToSelect | property |
clickToSelect:Boolean
[write-only] Can we click to select the current objects?
public function set clickToSelect(value:Boolean):void
currSelectedItem | property |
currSelectedItem:*
Returns the currently selected item, if we have one, in our editable dropdown
public function get currSelectedItem():*
public function set currSelectedItem(value:any):void
highlightCurrObject | property |
highlightCurrObject:Boolean
[write-only] Should we highlight the current object or not?
public function set highlightCurrObject(value:Boolean):void
visible | property |
visible:Boolean
[override]
Makes the GUI
visible and adds it to the stage
public function get visible():Boolean
public function set visible(value:Boolean):void
GUI | () | Constructor |
public function GUI(editor:Editor)
Creates the GUI
editor:Editor — A reference to the Editor that created us
|
addEditComponentsForObject | () | method |
public function addEditComponentsForObject(obj:Object, editableVars:Vector.<EditableVar>):void
Adds the edit components for an object based on the params in it's EditableVar class
Parameters
obj:Object — The object that we're adding edit components for
| |
editableVars:Vector.<EditableVar> — The Vector list of EditableVar info for the object
|
addObjectToAvailable | () | method |
public function addObjectToAvailable(obj:*):void
Adds an object to the available array
Parameters
obj:* — The object to add
|
clearPreviousEditComponents | () | method |
public function clearPreviousEditComponents():void
Clears all the previous components for an object
log | () | method |
public function log(msg:String, level:int = 1):void
Traces out a message to the console and the log panel
Parameters
msg:String — The message we're tracing
| |
level:int (default = 1 ) — The level of the message; this is used to colour code trace outputs if your IDE supports it
|
removeObjectFromAvailable | () | method |
public function removeObjectFromAvailable(obj:*):void
Removes an object from the available array
Parameters
obj:* — The object to remove
|
updateComponentValues | () | method |
public function updateComponentValues(obj:*, updateOnlyWatch:Boolean = true):void
Updates the values for the current object that we're displaying
Parameters
obj:* — The object that we're updating the values for
| |
updateOnlyWatch:Boolean (default = true ) — Update only the watch variables, or update everything?
|