| Package | org.wak.gui.modern |
| Class | public class ModernGui |
| Inheritance | ModernGui  flash.display.Sprite |
| Implements | IAdventureGui |
| Property | Defined by | ||
|---|---|---|---|
| CharMouseCursor : String = "char_cursor" [static]
| ModernGui | ||
| currentMouseCursorId : String [read-only]
| ModernGui | ||
| display : DisplayObject [read-only]
Returns the display object of the gui.
| ModernGui | ||
| enabled : Boolean | ModernGui | ||
| ExitMouseCursor : String = "exit_cursor" [static]
| ModernGui | ||
| GrabingItemMouseCursor : String = "grabitem_cursor" [static]
| ModernGui | ||
| ItemMouseCursor : String = "item_cursor" [static]
| ModernGui | ||
| mouseCursor : DisplayObject [read-only]
The custom mouse pointer container.
| ModernGui | ||
| mouseInfoDescription : Boolean [read-only]
| ModernGui | ||
| NormalMouseCursor : String = "normal_cursor" [static]
| ModernGui | ||
| prevMouseCursorId : String [read-only]
| ModernGui | ||
| Property | Defined by | ||
|---|---|---|---|
| mCharOverMouseCursor : Sprite = null | ModernGui | ||
| mCurrentMouseCursorId : String = "" | ModernGui | ||
| mDefaultMouseCursor : Sprite = null | ModernGui | ||
| mEnabled : Boolean = true | ModernGui | ||
| mGatespotOverMouseCursor : Sprite = null | ModernGui | ||
| mInfoBox : MouseInfoBox = null | ModernGui | ||
| mInfoBoxBackgroundId : String = "" | ModernGui | ||
| mInfoBoxDescriptionEnabled : Boolean = false | ModernGui | ||
| mInfoBoxEnabled : Boolean = false | ModernGui | ||
| mInfoBoxFlatBgColor : uint = 0x000000 | ModernGui | ||
| mInfoBoxFlatBorderColor : uint = 0x000000 | ModernGui | ||
| mInfoBoxFont : String = "" | ModernGui | ||
| mInfoBoxFontBold : Boolean = false | ModernGui | ||
| mInfoBoxFontColor : uint = 0xFFFFFF | ModernGui | ||
| mInfoBoxFontSize : int = 14 | ModernGui | ||
| mInfoBoxFontUseEmbed : Boolean = false | ModernGui | ||
| mInfoBoxLeading : int = 0 | ModernGui | ||
| mInfoBoxOutlineEnabled : Boolean = true | ModernGui | ||
| mInfoBoxWidth : Number = 0 | ModernGui | ||
| mInventory : ModernInventoryDisplay = null | ModernGui | ||
| mInventoryArrowLeft : WakSimpleButton = null | ModernGui | ||
| mInventoryArrowRight : WakSimpleButton = null | ModernGui | ||
| mInventoryBg : DisplayObject = null | ModernGui | ||
| mInventoryColumns : int = 4 | ModernGui | ||
| mInventoryItemH : Number = 50 | ModernGui | ||
| mInventoryItemSpace : Number = 10 | ModernGui | ||
| mInventoryItemsY : Number = 1 | ModernGui | ||
| mInventoryItemW : Number = 50 | ModernGui | ||
| mInventoryX : Number = 0 | ModernGui | ||
| mInventoryY : Number = 300 | ModernGui | ||
| mItemOverMouseCursor : Sprite = null | ModernGui | ||
| mItemVisualHelp : Shape = null | ModernGui | ||
| mMouseCursor : Sprite = null | ModernGui | ||
| mMouseCursorsArr : Array = null | ModernGui | ||
| mMouseInfo : MouseInfoBox = null | ModernGui | ||
| mMouseInfoBackgroundId : String = "" | ModernGui | ||
| mMouseInfoDescriptionEnabled : Boolean = false | ModernGui | ||
| mMouseInfoEnabled : Boolean = true | ModernGui | ||
| mMouseInfoFlatBgColor : uint = 0x000000 | ModernGui | ||
| mMouseInfoFlatBorderColor : uint = 0x000000 | ModernGui | ||
| mMouseInfoFont : String = "" | ModernGui | ||
| mMouseInfoFontBold : Boolean = false | ModernGui | ||
| mMouseInfoFontColor : uint = 0xFFFFFF | ModernGui | ||
| mMouseInfoFontSize : int = 14 | ModernGui | ||
| mMouseInfoFontUseEmbed : Boolean = false | ModernGui | ||
| mMouseInfoOutlineEnabled : Boolean = true | ModernGui | ||
| mMouseInfoWidth : Number = 0 | ModernGui | ||
| mPlayerChar : AdventureCharacter = null | ModernGui | ||
| mPrevMouseCursorId : String = "" | ModernGui | ||
| mResources : Class = null | ModernGui | ||
| Method | Defined by | ||
|---|---|---|---|
|
ModernGui(pGuiSettings:XML = null)
Constructor
| ModernGui | ||
|
ChangeMouseCursorTo(pCursorId:String):void
Change the current mouse cursor to other mouse cursor state.
| ModernGui | ||
|
GrabItem(pItem:DisplayObject):void
Change the mouse cursor to grab an item.
| ModernGui | ||
|
ReleaseItem():void
Release the previously grabbed items.
| ModernGui | ||
|
RemoveMouseCursor(pCursorLayer:Sprite):void
Remove the mouse cursor to the cursor Layer.
| ModernGui | ||
|
SetInfoBoxText(value:String):void
Set text into the gui info box.
| ModernGui | ||
|
SetMouseCursor(pCursorLayer:Sprite):void
Add the mouse cursor to the cursor Layer.
| ModernGui | ||
|
SetMouseInfoText(value:String):void
| ModernGui | ||
| Method | Defined by | ||
|---|---|---|---|
|
CreateDefaultCursor():DisplayObject
| ModernGui | ||
|
CreateDefaultItemCursor():DisplayObject
| ModernGui | ||
|
CreateInventoryButton(pBtn:XML):WakSimpleButton
| ModernGui | ||
|
CreateItemVisualHelp():Shape
| ModernGui | ||
|
LoadInventorySettings(pSettings:XML):void
| ModernGui | ||
|
LoadMouseInfoSettings(pSettings:XML):void
| ModernGui | ||
|
LoadMouseOverChar(pSettings:XML):void
| ModernGui | ||
|
LoadMouseOverGatespot(pSettings:XML):void
| ModernGui | ||
|
LoadMouseOverItemCursor(pSettings:XML):void
| ModernGui | ||
|
LoadNormalCursor(pSettings:XML):void
| ModernGui | ||
|
LoadSettings(pSettings:XML):void
| ModernGui | ||
|
OnAddedToStage(event:Event):void
| ModernGui | ||
|
OnMouseMove(event:MouseEvent):void
| ModernGui | ||
|
OnRemovedFromStage(event:Event):void
| ModernGui | ||
|
RemoveInventoryDisplayListeners(pInvDisplay:ModernInventoryDisplay):void
| ModernGui | ||
|
SetInventoryDisplayListeners(pInvDisplay:ModernInventoryDisplay):void
| ModernGui | ||
| Constant | Defined by | ||
|---|---|---|---|
| kInventoryArrowLeft : String = "ScrollLeft" | ModernGui | ||
| kInventoryArrowRight : String = "ScrollRight" | ModernGui | ||
| CharMouseCursor | property |
public static var CharMouseCursor:String = "char_cursor"
| currentMouseCursorId | property |
currentMouseCursorId:String [read-only]Implementation
public function get currentMouseCursorId():String
| 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
| ExitMouseCursor | property |
public static var ExitMouseCursor:String = "exit_cursor"
| GrabingItemMouseCursor | property |
public static var GrabingItemMouseCursor:String = "grabitem_cursor"
| ItemMouseCursor | property |
public static var ItemMouseCursor:String = "item_cursor"
| mCharOverMouseCursor | property |
protected var mCharOverMouseCursor:Sprite = null
| mCurrentMouseCursorId | property |
protected var mCurrentMouseCursorId:String = ""
| mDefaultMouseCursor | property |
protected var mDefaultMouseCursor:Sprite = null
| mEnabled | property |
protected var mEnabled:Boolean = true
| mGatespotOverMouseCursor | property |
protected var mGatespotOverMouseCursor:Sprite = null
| mInfoBox | property |
protected var mInfoBox:MouseInfoBox = null
| mInfoBoxBackgroundId | property |
protected var mInfoBoxBackgroundId:String = ""
| mInfoBoxDescriptionEnabled | property |
protected var mInfoBoxDescriptionEnabled:Boolean = false
| mInfoBoxEnabled | property |
protected var mInfoBoxEnabled:Boolean = false
| mInfoBoxFlatBgColor | property |
protected var mInfoBoxFlatBgColor:uint = 0x000000
| mInfoBoxFlatBorderColor | property |
protected var mInfoBoxFlatBorderColor:uint = 0x000000
| mInfoBoxFont | property |
protected var mInfoBoxFont:String = ""
| mInfoBoxFontBold | property |
protected var mInfoBoxFontBold:Boolean = false
| mInfoBoxFontColor | property |
protected var mInfoBoxFontColor:uint = 0xFFFFFF
| mInfoBoxFontSize | property |
protected var mInfoBoxFontSize:int = 14
| mInfoBoxFontUseEmbed | property |
protected var mInfoBoxFontUseEmbed:Boolean = false
| mInfoBoxLeading | property |
protected var mInfoBoxLeading:int = 0
| mInfoBoxOutlineEnabled | property |
protected var mInfoBoxOutlineEnabled:Boolean = true
| mInfoBoxWidth | property |
protected var mInfoBoxWidth:Number = 0
| mInventory | property |
protected var mInventory:ModernInventoryDisplay = null
| mInventoryArrowLeft | property |
protected var mInventoryArrowLeft:WakSimpleButton = null
| mInventoryArrowRight | property |
protected var mInventoryArrowRight:WakSimpleButton = null
| mInventoryBg | property |
protected var mInventoryBg:DisplayObject = null
| mInventoryColumns | property |
protected var mInventoryColumns:int = 4
| mInventoryItemH | property |
protected var mInventoryItemH:Number = 50
| mInventoryItemSpace | property |
protected var mInventoryItemSpace:Number = 10
| mInventoryItemsY | property |
protected var mInventoryItemsY:Number = 1
| mInventoryItemW | property |
protected var mInventoryItemW:Number = 50
| mInventoryX | property |
protected var mInventoryX:Number = 0
| mInventoryY | property |
protected var mInventoryY:Number = 300
| mItemOverMouseCursor | property |
protected var mItemOverMouseCursor:Sprite = null
| mItemVisualHelp | property |
protected var mItemVisualHelp:Shape = null
| mMouseCursor | property |
protected var mMouseCursor:Sprite = null
| mMouseCursorsArr | property |
protected var mMouseCursorsArr:Array = null
| mMouseInfo | property |
protected var mMouseInfo:MouseInfoBox = null
| mMouseInfoBackgroundId | property |
protected var mMouseInfoBackgroundId:String = ""
| mMouseInfoDescriptionEnabled | property |
protected var mMouseInfoDescriptionEnabled:Boolean = false
| mMouseInfoEnabled | property |
protected var mMouseInfoEnabled:Boolean = true
| mMouseInfoFlatBgColor | property |
protected var mMouseInfoFlatBgColor:uint = 0x000000
| mMouseInfoFlatBorderColor | property |
protected var mMouseInfoFlatBorderColor:uint = 0x000000
| mMouseInfoFont | property |
protected var mMouseInfoFont:String = ""
| mMouseInfoFontBold | property |
protected var mMouseInfoFontBold:Boolean = false
| mMouseInfoFontColor | property |
protected var mMouseInfoFontColor:uint = 0xFFFFFF
| mMouseInfoFontSize | property |
protected var mMouseInfoFontSize:int = 14
| mMouseInfoFontUseEmbed | property |
protected var mMouseInfoFontUseEmbed:Boolean = false
| mMouseInfoOutlineEnabled | property |
protected var mMouseInfoOutlineEnabled:Boolean = true
| mMouseInfoWidth | property |
protected var mMouseInfoWidth:Number = 0
| mouseCursor | property |
mouseCursor:DisplayObject [read-only]The custom mouse pointer container.
Implementation public function get mouseCursor():DisplayObject
| mouseInfoDescription | property |
mouseInfoDescription:Boolean [read-only]Implementation
public function get mouseInfoDescription():Boolean
| mPlayerChar | property |
protected var mPlayerChar:AdventureCharacter = null
| mPrevMouseCursorId | property |
protected var mPrevMouseCursorId:String = ""
| mResources | property |
protected var mResources:Class = null
| NormalMouseCursor | property |
public static var NormalMouseCursor:String = "normal_cursor"
| prevMouseCursorId | property |
prevMouseCursorId:String [read-only]Implementation
public function get prevMouseCursorId():String
| ModernGui | () | constructor |
public function ModernGui(pGuiSettings:XML = null)Constructor
ParameterspGuiSettings:XML (default = null) |
| ChangeMouseCursorTo | () | method |
public function ChangeMouseCursorTo(pCursorId:String):voidChange the current mouse cursor to other mouse cursor state. Valid mouse cursors id are the ModernGui vars : ItemMouseCursor, CharMouseCursor, ExitMouseCursor , NormalMouseCursor .
ParameterspCursorId:String — an MouseCursor id see ModernGui constants.
|
See also
| CreateDefaultCursor | () | method |
protected function CreateDefaultCursor():DisplayObject
Returns
DisplayObject |
| CreateDefaultItemCursor | () | method |
protected function CreateDefaultItemCursor():DisplayObject
Returns
DisplayObject |
| CreateInventoryButton | () | method |
protected function CreateInventoryButton(pBtn:XML):WakSimpleButtonParameters
pBtn:XML |
WakSimpleButton |
| CreateItemVisualHelp | () | method |
protected function CreateItemVisualHelp():Shape
Returns
Shape |
| GrabItem | () | method |
public function GrabItem(pItem:DisplayObject):voidChange the mouse cursor to grab an item.
ParameterspItem:DisplayObject — Mouse icon DisplayObject.
|
| LoadInventorySettings | () | method |
protected function LoadInventorySettings(pSettings:XML):voidParameters
pSettings:XML |
| LoadMouseInfoSettings | () | method |
protected function LoadMouseInfoSettings(pSettings:XML):voidParameters
pSettings:XML |
| LoadMouseOverChar | () | method |
protected function LoadMouseOverChar(pSettings:XML):voidParameters
pSettings:XML |
| LoadMouseOverGatespot | () | method |
protected function LoadMouseOverGatespot(pSettings:XML):voidParameters
pSettings:XML |
| LoadMouseOverItemCursor | () | method |
protected function LoadMouseOverItemCursor(pSettings:XML):voidParameters
pSettings:XML |
| LoadNormalCursor | () | method |
protected function LoadNormalCursor(pSettings:XML):voidParameters
pSettings:XML |
| LoadSettings | () | method |
protected function LoadSettings(pSettings:XML):voidParameters
pSettings:XML |
| OnAddedToStage | () | method |
protected function OnAddedToStage(event:Event):voidParameters
event:Event |
| OnMouseMove | () | method |
protected function OnMouseMove(event:MouseEvent):voidParameters
event:MouseEvent |
| OnRemovedFromStage | () | method |
protected function OnRemovedFromStage(event:Event):voidParameters
event:Event |
| ReleaseItem | () | method |
public function ReleaseItem():voidRelease the previously grabbed items.
| RemoveInventoryDisplayListeners | () | method |
protected function RemoveInventoryDisplayListeners(pInvDisplay:ModernInventoryDisplay):voidParameters
pInvDisplay:ModernInventoryDisplay |
| RemoveMouseCursor | () | method |
public function RemoveMouseCursor(pCursorLayer:Sprite):voidRemove the mouse cursor to the cursor Layer.
ParameterspCursorLayer:Sprite — the cursor layer sprite
|
| SetInfoBoxText | () | method |
public function SetInfoBoxText(value:String):voidSet text into the gui info box.
Parametersvalue:String — String with the text to set.
|
| SetInventoryDisplayListeners | () | method |
protected function SetInventoryDisplayListeners(pInvDisplay:ModernInventoryDisplay):voidParameters
pInvDisplay:ModernInventoryDisplay |
| SetMouseCursor | () | method |
public function SetMouseCursor(pCursorLayer:Sprite):voidAdd the mouse cursor to the cursor Layer.
ParameterspCursorLayer:Sprite — the cursor layer sprite
|
| SetMouseInfoText | () | method |
public function SetMouseInfoText(value:String):voidParameters
value:String |
| kInventoryArrowLeft | constant |
protected const kInventoryArrowLeft:String = "ScrollLeft"
| kInventoryArrowRight | constant |
protected const kInventoryArrowRight:String = "ScrollRight"