| Package | org.wak.gui.sci |
| Class | public class SciGui |
| Inheritance | SciGui  flash.display.Sprite |
| Implements | IAdventureGui |
| Property | Defined by | ||
|---|---|---|---|
| display : DisplayObject [read-only]
Returns the display object of the gui.
| SciGui | ||
| enabled : Boolean | SciGui | ||
| mouseCursor : DisplayObject [read-only]
| SciGui | ||
| Method | Defined by | ||
|---|---|---|---|
|
SciGui(pGuiSettings:XML = null)
Constructor.
| SciGui | ||
|
DrawActionIcon(pBtn:Sprite, pAction:String):void
[static]
| SciGui | ||
|
HideInventory():void
Hide the player's inventory.
| SciGui | ||
|
RemoveMouseCursor(pCursorLayer:Sprite):void
Remove the mouse cursor to the cursor Layer.
| SciGui | ||
|
SetMouseCursor(pCursorLayer:Sprite):void
Add the mouse cursor to the cursor Layer.
| SciGui | ||
|
SetMouseIconAction(pActionId:String):void
Set the mouse icon to certain action.
| SciGui | ||
|
ShowingInventory():Boolean
| SciGui | ||
|
ShowInventory():void
Shows the player's inventory.
| SciGui | ||
| Method | Defined by | ||
|---|---|---|---|
|
CreateButton(pAction:String):WakSimpleButton
| SciGui | ||
|
CreateButtons(pActionsArr:Array, pButtonsArr:Array):void
| SciGui | ||
|
CreateCustomButton(pButtonXml:XML, pSaveArray:Array, pUseHorizontal:Boolean):void
| SciGui | ||
|
CreateDefaultMouseIcons(pIconsArr:Array, pActionsArr:Array, pCursorLayer:DisplayObjectContainer):void
| SciGui | ||
|
CreateScrollCustomButton(pButtonXml:XMLList):WakSimpleButton
| SciGui | ||
|
DrawDefaultButtonBg(pBtn:Sprite, pW:Number, pH:Number, pColor:uint):void
| SciGui | ||
|
LoadSettings(pSettings:XML):void
| SciGui | ||
|
OnActionSelected(event:Event):void
| SciGui | ||
|
OnAddedToStage(event:Event):void
Listener for the event ADDED_TO_STAGE.
| SciGui | ||
|
OnButtonPanelMouseOut(event:MouseEvent):void
| SciGui | ||
|
OnInventoryActionSelected(event:GuiEvent):void
| SciGui | ||
|
OnInventoryItemSelected(event:GuiEvent):void
| SciGui | ||
|
OnInventoryOk(event:Event):void
| SciGui | ||
|
OnMouseMove(event:MouseEvent):void
Listener for the event MOUSE_MOVE.
| SciGui | ||
|
OnRemovedToStage(event:Event):void
Listener for the event REMOVED_FROM_STAGE.
| SciGui | ||
|
OnUseInventoryItem(event:GuiEvent):void
| SciGui | ||
|
RemoveInventoryDisplayListeners(pInvDisplay:SciInventoryDisplay):void
| SciGui | ||
|
SetActionSelected(pButtonName:String, pSetMouse:Boolean = true):void
| SciGui | ||
|
SetInventoryDisplayListeners(pInvDisplay:SciInventoryDisplay):void
| SciGui | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when an action button is clicked | SciGui | |||
| Dispatched when an inventory item button is selected in the inventory window. | SciGui | |||
| Constant | Defined by | ||
|---|---|---|---|
| CLOSE_INVENTORY : String = "close_inventory" [static]
Internal action for the button close inventory.
| SciGui | ||
| OPEN_INVENTORY : String = "open_inventory" [static]
Internal action for the button open inventory.
| SciGui | ||
| SELECT_INVENTORY : String = "select_item" [static]
Internal inventory display action for the button select.
| SciGui | ||
| display | property |
display:DisplayObject [read-only]Returns the display object of the gui.
Implementation public function get display():DisplayObject
| enabled | property |
enabled:Boolean [read-write]Implementation
public function get enabled():Boolean
public function set enabled(value:Boolean):void
| mouseCursor | property |
mouseCursor:DisplayObject [read-only]Implementation
public function get mouseCursor():DisplayObject
| SciGui | () | constructor |
public function SciGui(pGuiSettings:XML = null)Constructor.
ParameterspGuiSettings:XML (default = null) |
| CreateButton | () | method |
protected function CreateButton(pAction:String):WakSimpleButtonParameters
pAction:String |
WakSimpleButton |
| CreateButtons | () | method |
protected function CreateButtons(pActionsArr:Array, pButtonsArr:Array):voidParameters
pActionsArr:Array |
|
pButtonsArr:Array |
| CreateCustomButton | () | method |
protected function CreateCustomButton(pButtonXml:XML, pSaveArray:Array, pUseHorizontal:Boolean):voidParameters
pButtonXml:XML |
|
pSaveArray:Array |
|
pUseHorizontal:Boolean |
| CreateDefaultMouseIcons | () | method |
protected function CreateDefaultMouseIcons(pIconsArr:Array, pActionsArr:Array, pCursorLayer:DisplayObjectContainer):voidParameters
pIconsArr:Array |
|
pActionsArr:Array |
|
pCursorLayer:DisplayObjectContainer |
| CreateScrollCustomButton | () | method |
protected function CreateScrollCustomButton(pButtonXml:XMLList):WakSimpleButtonParameters
pButtonXml:XMLList |
WakSimpleButton |
| DrawActionIcon | () | method |
public static function DrawActionIcon(pBtn:Sprite, pAction:String):voidParameters
pBtn:Sprite |
|
pAction:String |
| DrawDefaultButtonBg | () | method |
protected function DrawDefaultButtonBg(pBtn:Sprite, pW:Number, pH:Number, pColor:uint):voidParameters
pBtn:Sprite |
|
pW:Number |
|
pH:Number |
|
pColor:uint |
| HideInventory | () | method |
public function HideInventory():voidHide the player's inventory.
| LoadSettings | () | method |
protected function LoadSettings(pSettings:XML):voidParameters
pSettings:XML |
| OnActionSelected | () | method |
protected function OnActionSelected(event:Event):voidParameters
event:Event |
| OnAddedToStage | () | method |
protected function OnAddedToStage(event:Event):voidListener for the event ADDED_TO_STAGE.
Parametersevent:Event |
| OnButtonPanelMouseOut | () | method |
protected function OnButtonPanelMouseOut(event:MouseEvent):voidParameters
event:MouseEvent |
| OnInventoryActionSelected | () | method |
| OnInventoryItemSelected | () | method |
| OnInventoryOk | () | method |
protected function OnInventoryOk(event:Event):voidParameters
event:Event |
| OnMouseMove | () | method |
protected function OnMouseMove(event:MouseEvent):voidListener for the event MOUSE_MOVE.
Parametersevent:MouseEvent |
| OnRemovedToStage | () | method |
protected function OnRemovedToStage(event:Event):voidListener for the event REMOVED_FROM_STAGE.
Parametersevent:Event |
| OnUseInventoryItem | () | method |
| RemoveInventoryDisplayListeners | () | method |
protected function RemoveInventoryDisplayListeners(pInvDisplay:SciInventoryDisplay):voidParameters
pInvDisplay:SciInventoryDisplay |
| RemoveMouseCursor | () | method |
public function RemoveMouseCursor(pCursorLayer:Sprite):voidRemove the mouse cursor to the cursor Layer.
ParameterspCursorLayer:Sprite — the cursor layer sprite
|
| SetActionSelected | () | method |
protected function SetActionSelected(pButtonName:String, pSetMouse:Boolean = true):voidParameters
pButtonName:String |
|
pSetMouse:Boolean (default = true) |
| SetInventoryDisplayListeners | () | method |
protected function SetInventoryDisplayListeners(pInvDisplay:SciInventoryDisplay):voidParameters
pInvDisplay:SciInventoryDisplay |
| SetMouseCursor | () | method |
public function SetMouseCursor(pCursorLayer:Sprite):voidAdd the mouse cursor to the cursor Layer.
ParameterspCursorLayer:Sprite — the cursor layer sprite
|
| SetMouseIconAction | () | method |
public function SetMouseIconAction(pActionId:String):voidSet the mouse icon to certain action.
ParameterspActionId:String — action id.
|
| ShowingInventory | () | method |
public function ShowingInventory():BooleanReturns
Boolean — true . If the gui is displaying the inventory.
|
| ShowInventory | () | method |
public function ShowInventory():voidShows the player's inventory.
| ACTION_SELECTED | event |
| INVENTORY_ITEM_SELECTED | event |
org.wak.gui.events.GuiEvent
Dispatched when an inventory item button is selected in the inventory window.
| CLOSE_INVENTORY | constant |
public static const CLOSE_INVENTORY:String = "close_inventory"Internal action for the button close inventory.
| OPEN_INVENTORY | constant |
public static const OPEN_INVENTORY:String = "open_inventory"Internal action for the button open inventory.
| SELECT_INVENTORY | constant |
public static const SELECT_INVENTORY:String = "select_item"Internal inventory display action for the button select.