Packageorg.wak.gui.scumm
Classpublic class ScummGui
InheritanceScummGui Inheritance flash.display.Sprite
ImplementsIAdventureGui

Manages the scumm user interface



Public Properties
 PropertyDefined by
  display : DisplayObject
[read-only]
ScummGui
  enabled : Boolean
ScummGui
  enableHighlight : Boolean
[write-only] change the color of the feedback text if value is true.
ScummGui
  mouseCursor : DisplayObject
[read-only]
ScummGui
Public Methods
 MethodDefined by
  
ScummGui(pGuiSettings:XML = null)
Constructor
ScummGui
  
RemoveMouseCursor(pCursorLayer:Sprite):void
ScummGui
  
SetFeedbackText(pText:String):void
Set the feedback text of the interface with the content of pText
ScummGui
  
SetMouseCursor(pCursorLayer:Sprite):void
ScummGui
  
ToggleSelectedButton(pButtonId:String, pState:Boolean):void
Toggles selected a given button.
ScummGui
Protected Methods
 MethodDefined by
  
CreateButton(pButtonXml:XML):void
ScummGui
  
CreateDefaultButton(pButtonId:String):void
ScummGui
  
LoadSettings(pSettings:XML):void
Load the settings of the gui using the parameters in pSettings
ScummGui
  
OnAddedToStage(event:Event):void
ScummGui
  
OnMouseMove(event:MouseEvent):void
ScummGui
  
OnRemovedToStage(event:Event):void
ScummGui
  
ScummGui
  
ScummGui
Protected Constants
 ConstantDefined by
  kPanelHPercent : Number = 27.5
ScummGui
Property detail
displayproperty
display:DisplayObject  [read-only]Implementation
    public function get display():DisplayObject
enabledproperty 
enabled:Boolean  [read-write]Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
enableHighlightproperty 
enableHighlight:Boolean  [write-only]

change the color of the feedback text if value is true.

Implementation
    public function set enableHighlight(value:Boolean):void
mouseCursorproperty 
mouseCursor:DisplayObject  [read-only]Implementation
    public function get mouseCursor():DisplayObject
Constructor detail
ScummGui()constructor
public function ScummGui(pGuiSettings:XML = null)

Constructor

Parameters
pGuiSettings:XML (default = null) — an XML with the scumm gui config.
Method detail
CreateButton()method
protected function CreateButton(pButtonXml:XML):voidParameters
pButtonXml:XML
CreateDefaultButton()method 
protected function CreateDefaultButton(pButtonId:String):voidParameters
pButtonId:String
LoadSettings()method 
protected function LoadSettings(pSettings:XML):void

Load the settings of the gui using the parameters in pSettings

Parameters
pSettings:XML — XML with the settings.
OnAddedToStage()method 
protected function OnAddedToStage(event:Event):voidParameters
event:Event
OnMouseMove()method 
protected function OnMouseMove(event:MouseEvent):voidParameters
event:MouseEvent
OnRemovedToStage()method 
protected function OnRemovedToStage(event:Event):voidParameters
event:Event
RemoveInventoryDisplayListeners()method 
protected function RemoveInventoryDisplayListeners(pInvDisplay:ScummInventoryDisplay):voidParameters
pInvDisplay:ScummInventoryDisplay
RemoveMouseCursor()method 
public function RemoveMouseCursor(pCursorLayer:Sprite):voidParameters
pCursorLayer:Sprite
SetFeedbackText()method 
public function SetFeedbackText(pText:String):void

Set the feedback text of the interface with the content of pText

Parameters
pText:String — feedback text
SetInventoryDisplayListeners()method 
protected function SetInventoryDisplayListeners(pInvDisplay:ScummInventoryDisplay):voidParameters
pInvDisplay:ScummInventoryDisplay
SetMouseCursor()method 
public function SetMouseCursor(pCursorLayer:Sprite):voidParameters
pCursorLayer:Sprite
ToggleSelectedButton()method 
public function ToggleSelectedButton(pButtonId:String, pState:Boolean):void

Toggles selected a given button.

Parameters
pButtonId:String — button id
 
pState:Boolean
Constant detail
kPanelHPercentconstant
protected const kPanelHPercent:Number = 27.5