Packageorg.wak.dialog.modern
Classpublic class ModernDialogController
InheritanceModernDialogController Inheritance flash.display.Sprite
ImplementsIDialogsController

Modern style Dialog controller.



Public Properties
 PropertyDefined by
  display : DisplayObject
[read-only] the display object of the dialog controller.
ModernDialogController
Protected Properties
 PropertyDefined by
  mBackPanel : DisplayObject = null
ModernDialogController
  mCurrentDialog : AdventureDialog = null
ModernDialogController
  mCurrentDialogMenu : DialogMenu = null
ModernDialogController
  mCurrentSayIterator : IIterator = null
ModernDialogController
  mDialogLayer : Sprite = null
ModernDialogController
  mDialogMngr : DialogManager = null
ModernDialogController
  mDialogsMenuArray : Array = null
ModernDialogController
  mDisplayInfoColor : uint = 0xFFFFFF
ModernDialogController
  mDisplayInfoY : Number = 0
ModernDialogController
  mDMenusY : Number = -1
ModernDialogController
  mGuiMngr : GuiManager = null
ModernDialogController
  mMask : Shape = null
ModernDialogController
  mMaskShrink : Number = 0
ModernDialogController
  mMenuOffsetX : Number = 0
ModernDialogController
  mMenuOffsetY : Number = 0
ModernDialogController
  mMenuTextBold : Boolean = true
ModernDialogController
  mMenuTextColor : uint = 0xFFFFFF
ModernDialogController
  mMenuTextColorOver : uint = 0xFF00FF
ModernDialogController
  mMenuTextFont : String = "acknowtt"
ModernDialogController
  mMenuTextSize : Number = 13
ModernDialogController
  mMenuTextUseEmbedFont : Boolean = true
ModernDialogController
  mModernGui : ModernGui = null
ModernDialogController
  mOnCharacterSayCompleted : Function = null
ModernDialogController
  mPlayerCharId : String = ""
ModernDialogController
  mPlayingTopic : Topic = null
ModernDialogController
  mPreviousDialog : AdventureDialog = null
ModernDialogController
  mPreviousDialogMenu : DialogMenu = null
ModernDialogController
  mResourceManager : Class = null
ModernDialogController
  mSceneMngr : SceneManager = null
ModernDialogController
  mScrollDownBtn : WakSimpleButton = null
ModernDialogController
  mScrollUpBtn : WakSimpleButton = null
ModernDialogController
  mSpokenTextBold : Boolean = true
ModernDialogController
  mSpokenTextFont : String = "acknowtt"
ModernDialogController
  mSpokenTextSize : Number = 13
ModernDialogController
  mSpokenTextUseEmbedFont : Boolean = true
ModernDialogController
  mStageHeight : Number = 0
ModernDialogController
  mStageWidth : Number = 0
ModernDialogController
  mTextHeadDistance : int = 0
ModernDialogController
  mTextOptionHeight : int = 30
ModernDialogController
  mTextOptionWidth : int = 100
ModernDialogController
  mTextSpeedFactor : Number = 60
ModernDialogController
Public Methods
 MethodDefined by
  
ModernDialogController(pLayer:Sprite, pSettings:XML)
Constructor
ModernDialogController
  
ActivateOption(pTopicId:String):void
ModernDialogController
  
CharacterSay(pChar:AdventureCharacter, pTextToSay:String, pOnComplete:Function = null):void
Makes a character say something.
ModernDialogController
  
DisplayInfo(pText:String, pOnCompleteFunction:Function = null):void
Display an information message.
ModernDialogController
  
Initialize():void
Initialize the Dialog controller
ModernDialogController
  
PlayTopic(pTopic:Topic, pOnCompleteFunc:Function):void
Start to play a dialog topic.
ModernDialogController
  
SetOptionVisible(pDialogId:String, pTopicId:String, value:Boolean):void
ModernDialogController
  
Starts a scumm dialog
ModernDialogController
Protected Methods
 MethodDefined by
  
CreateDialogMenu(pDialogId:String):DialogMenu
ModernDialogController
  
LoadSettings(pSettings:XML):void
Load the settings of the dialogs using the parameters in pSettings
ModernDialogController
  
StopDialog():void
Force to stop any dialog playing.
ModernDialogController
Protected Constants
 ConstantDefined by
  kPanelHPercent : Number = 27.5
ModernDialogController
Property detail
displayproperty
display:DisplayObject  [read-only]

the display object of the dialog controller.

Implementation
    public function get display():DisplayObject
mBackPanelproperty 
protected var mBackPanel:DisplayObject = null
mCurrentDialogproperty 
protected var mCurrentDialog:AdventureDialog = null
mCurrentDialogMenuproperty 
protected var mCurrentDialogMenu:DialogMenu = null
mCurrentSayIteratorproperty 
protected var mCurrentSayIterator:IIterator = null
mDialogLayerproperty 
protected var mDialogLayer:Sprite = null
mDialogMngrproperty 
protected var mDialogMngr:DialogManager = null
mDialogsMenuArrayproperty 
protected var mDialogsMenuArray:Array = null
mDisplayInfoColorproperty 
protected var mDisplayInfoColor:uint = 0xFFFFFF
mDisplayInfoYproperty 
protected var mDisplayInfoY:Number = 0
mDMenusYproperty 
protected var mDMenusY:Number = -1
mGuiMngrproperty 
protected var mGuiMngr:GuiManager = null
mMaskproperty 
protected var mMask:Shape = null
mMaskShrinkproperty 
protected var mMaskShrink:Number = 0
mMenuOffsetXproperty 
protected var mMenuOffsetX:Number = 0
mMenuOffsetYproperty 
protected var mMenuOffsetY:Number = 0
mMenuTextBoldproperty 
protected var mMenuTextBold:Boolean = true
mMenuTextColorproperty 
protected var mMenuTextColor:uint = 0xFFFFFF
mMenuTextColorOverproperty 
protected var mMenuTextColorOver:uint = 0xFF00FF
mMenuTextFontproperty 
protected var mMenuTextFont:String = "acknowtt"
mMenuTextSizeproperty 
protected var mMenuTextSize:Number = 13
mMenuTextUseEmbedFontproperty 
protected var mMenuTextUseEmbedFont:Boolean = true
mModernGuiproperty 
protected var mModernGui:ModernGui = null
mOnCharacterSayCompletedproperty 
protected var mOnCharacterSayCompleted:Function = null
mPlayerCharIdproperty 
protected var mPlayerCharId:String = ""
mPlayingTopicproperty 
protected var mPlayingTopic:Topic = null
mPreviousDialogproperty 
protected var mPreviousDialog:AdventureDialog = null
mPreviousDialogMenuproperty 
protected var mPreviousDialogMenu:DialogMenu = null
mResourceManagerproperty 
protected var mResourceManager:Class = null
mSceneMngrproperty 
protected var mSceneMngr:SceneManager = null
mScrollDownBtnproperty 
protected var mScrollDownBtn:WakSimpleButton = null
mScrollUpBtnproperty 
protected var mScrollUpBtn:WakSimpleButton = null
mSpokenTextBoldproperty 
protected var mSpokenTextBold:Boolean = true
mSpokenTextFontproperty 
protected var mSpokenTextFont:String = "acknowtt"
mSpokenTextSizeproperty 
protected var mSpokenTextSize:Number = 13
mSpokenTextUseEmbedFontproperty 
protected var mSpokenTextUseEmbedFont:Boolean = true
mStageHeightproperty 
protected var mStageHeight:Number = 0
mStageWidthproperty 
protected var mStageWidth:Number = 0
mTextHeadDistanceproperty 
protected var mTextHeadDistance:int = 0
mTextOptionHeightproperty 
protected var mTextOptionHeight:int = 30
mTextOptionWidthproperty 
protected var mTextOptionWidth:int = 100
mTextSpeedFactorproperty 
protected var mTextSpeedFactor:Number = 60
Constructor detail
ModernDialogController()constructor
public function ModernDialogController(pLayer:Sprite, pSettings:XML)

Constructor

Parameters
pLayer:Sprite — Sprite of the dialog layers of the adventure.
 
pSettings:XML — XML with the settings for the dialogs.
Method detail
ActivateOption()method
public function ActivateOption(pTopicId:String):void

Parameters
pTopicId:String
CharacterSay()method 
public function CharacterSay(pChar:AdventureCharacter, pTextToSay:String, pOnComplete:Function = null):void

Makes a character say something.

Parameters
pChar:AdventureCharacter — The speaker character.
 
pTextToSay:String — The text that the character will way.
 
pOnComplete:Function (default = null) — Callback function called when the character finished to talk.
CreateDialogMenu()method 
protected function CreateDialogMenu(pDialogId:String):DialogMenuParameters
pDialogId:String

Returns
DialogMenu
DisplayInfo()method 
public function DisplayInfo(pText:String, pOnCompleteFunction:Function = null):void

Display an information message.

Parameters
pText:String — message to display
 
pOnCompleteFunction:Function (default = null) — callback function to be called after the message was displayed.
Initialize()method 
public function Initialize():void

Initialize the Dialog controller

LoadSettings()method 
protected function LoadSettings(pSettings:XML):void

Load the settings of the dialogs using the parameters in pSettings

Parameters
pSettings:XML — XML with the settings.
PlayTopic()method 
public function PlayTopic(pTopic:Topic, pOnCompleteFunc:Function):void

Start to play a dialog topic.

Parameters
pTopic:Topic — the topic to play
 
pOnCompleteFunc:Function — callaback function called when the topic finish.
SetOptionVisible()method 
public function SetOptionVisible(pDialogId:String, pTopicId:String, value:Boolean):voidParameters
pDialogId:String
 
pTopicId:String
 
value:Boolean
StartDialog()method 
public function StartDialog(pDialog:AdventureDialog):void

Starts a scumm dialog

Parameters
pDialog:AdventureDialog — AdventureDialog to start.
StopDialog()method 
protected function StopDialog():void

Force to stop any dialog playing.

Constant detail
kPanelHPercentconstant
protected const kPanelHPercent:Number = 27.5