| Package | org.wak.dialog.scumm |
| Class | public class ScummDialogController |
| Inheritance | ScummDialogController  flash.display.Sprite |
| Implements | IDialogsController |
| Property | Defined by | ||
|---|---|---|---|
| display : DisplayObject [read-only]
the display object of the dialog controller.
| ScummDialogController | ||
| Property | Defined by | ||
|---|---|---|---|
| mBackPanel : Shape = null | ScummDialogController | ||
| mCurrentDialog : AdventureDialog = null | ScummDialogController | ||
| mCurrentDialogMenu : DialogMenu = null | ScummDialogController | ||
| mCurrentSayIterator : IIterator = null | ScummDialogController | ||
| mDialogLayer : Sprite = null | ScummDialogController | ||
| mDialogMngr : DialogManager = null | ScummDialogController | ||
| mDialogsMenuArray : Array = null | ScummDialogController | ||
| mGuiMngr : GuiManager = null | ScummDialogController | ||
| mMask : Shape = null | ScummDialogController | ||
| mMenuTextBold : Boolean = true | ScummDialogController | ||
| mMenuTextColor : uint = 0xFFFFFF | ScummDialogController | ||
| mMenuTextColorOver : uint = 0xFF00FF | ScummDialogController | ||
| mMenuTextFont : String = "acknowtt" | ScummDialogController | ||
| mMenuTextSize : Number = 13 | ScummDialogController | ||
| mMenuTextUseEmbedFont : Boolean = true | ScummDialogController | ||
| mOnCharacterSayCompleted : Function = null | ScummDialogController | ||
| mPanelColor : uint = 0x000000 | ScummDialogController | ||
| mPlayerCharId : String = "" | ScummDialogController | ||
| mPlayingTopic : Topic = null | ScummDialogController | ||
| mPreviousDialog : AdventureDialog = null | ScummDialogController | ||
| mPreviousDialogMenu : DialogMenu = null | ScummDialogController | ||
| mResourceManager : Class = null | ScummDialogController | ||
| mSceneMngr : SceneManager = null | ScummDialogController | ||
| mScrollDownBtn : WakSimpleButton = null | ScummDialogController | ||
| mScrollUpBtn : WakSimpleButton = null | ScummDialogController | ||
| mSpokenTextBold : Boolean = true | ScummDialogController | ||
| mSpokenTextFont : String = "acknowtt" | ScummDialogController | ||
| mSpokenTextSize : Number = 13 | ScummDialogController | ||
| mSpokenTextUseEmbedFont : Boolean = true | ScummDialogController | ||
| mStageHeight : Number = 0 | ScummDialogController | ||
| mStageWidth : Number = 0 | ScummDialogController | ||
| mTextHeadDistance : int = 0 | ScummDialogController | ||
| mTextOptionHeight : int = 30 | ScummDialogController | ||
| mTextOptionWidth : int = 100 | ScummDialogController | ||
| mTextSpeedFactor : Number = 60 | ScummDialogController | ||
| Method | Defined by | ||
|---|---|---|---|
|
ScummDialogController(pLayer:Sprite, pSettings:XML)
Constructor
| ScummDialogController | ||
|
ActivateOption(pTopicId:String):void
| ScummDialogController | ||
|
CharacterSay(pChar:AdventureCharacter, pTextToSay:String, pOnComplete:Function = null):void
Makes a character say something.
| ScummDialogController | ||
|
DisplayInfo(pText:String, pOnCompleteFunction:Function = null):void
Display an information message.
| ScummDialogController | ||
|
Initialize():void
Initialize the Dialog controller
| ScummDialogController | ||
|
Start to play a dialog topic.
| ScummDialogController | ||
|
SetOptionVisible(pDialogId:String, pTopicId:String, value:Boolean):void
| ScummDialogController | ||
|
StartDialog(pDialog:AdventureDialog):void
Starts a scumm dialog
| ScummDialogController | ||
| Method | Defined by | ||
|---|---|---|---|
|
CreateDialogMenu(pDialogId:String):DialogMenu
| ScummDialogController | ||
|
LoadSettings(pSettings:XML):void
Load the settings of the dialogs using the parameters in pSettings
| ScummDialogController | ||
|
StopDialog():void
Force to stop any dialog playing.
| ScummDialogController | ||
| Constant | Defined by | ||
|---|---|---|---|
| kPanelHPercent : Number = 27.5 | ScummDialogController | ||
| display | property |
display:DisplayObject [read-only]the display object of the dialog controller.
Implementation public function get display():DisplayObject
| mBackPanel | property |
protected var mBackPanel:Shape = null
| mCurrentDialog | property |
protected var mCurrentDialog:AdventureDialog = null
| mCurrentDialogMenu | property |
protected var mCurrentDialogMenu:DialogMenu = null
| mCurrentSayIterator | property |
protected var mCurrentSayIterator:IIterator = null
| mDialogLayer | property |
protected var mDialogLayer:Sprite = null
| mDialogMngr | property |
protected var mDialogMngr:DialogManager = null
| mDialogsMenuArray | property |
protected var mDialogsMenuArray:Array = null
| mGuiMngr | property |
protected var mGuiMngr:GuiManager = null
| mMask | property |
protected var mMask:Shape = null
| mMenuTextBold | property |
protected var mMenuTextBold:Boolean = true
| mMenuTextColor | property |
protected var mMenuTextColor:uint = 0xFFFFFF
| mMenuTextColorOver | property |
protected var mMenuTextColorOver:uint = 0xFF00FF
| mMenuTextFont | property |
protected var mMenuTextFont:String = "acknowtt"
| mMenuTextSize | property |
protected var mMenuTextSize:Number = 13
| mMenuTextUseEmbedFont | property |
protected var mMenuTextUseEmbedFont:Boolean = true
| mOnCharacterSayCompleted | property |
protected var mOnCharacterSayCompleted:Function = null
| mPanelColor | property |
protected var mPanelColor:uint = 0x000000
| mPlayerCharId | property |
protected var mPlayerCharId:String = ""
| mPlayingTopic | property |
protected var mPlayingTopic:Topic = null
| mPreviousDialog | property |
protected var mPreviousDialog:AdventureDialog = null
| mPreviousDialogMenu | property |
protected var mPreviousDialogMenu:DialogMenu = null
| mResourceManager | property |
protected var mResourceManager:Class = null
| mSceneMngr | property |
protected var mSceneMngr:SceneManager = null
| mScrollDownBtn | property |
protected var mScrollDownBtn:WakSimpleButton = null
| mScrollUpBtn | property |
protected var mScrollUpBtn:WakSimpleButton = null
| mSpokenTextBold | property |
protected var mSpokenTextBold:Boolean = true
| mSpokenTextFont | property |
protected var mSpokenTextFont:String = "acknowtt"
| mSpokenTextSize | property |
protected var mSpokenTextSize:Number = 13
| mSpokenTextUseEmbedFont | property |
protected var mSpokenTextUseEmbedFont:Boolean = true
| mStageHeight | property |
protected var mStageHeight:Number = 0
| mStageWidth | property |
protected var mStageWidth:Number = 0
| mTextHeadDistance | property |
protected var mTextHeadDistance:int = 0
| mTextOptionHeight | property |
protected var mTextOptionHeight:int = 30
| mTextOptionWidth | property |
protected var mTextOptionWidth:int = 100
| mTextSpeedFactor | property |
protected var mTextSpeedFactor:Number = 60
| ScummDialogController | () | constructor |
public function ScummDialogController(pLayer:Sprite, pSettings:XML)Constructor
ParameterspLayer:Sprite — Sprite of the dialog layers of the adventure.
|
|
pSettings:XML — XML with the settings for the dialogs.
|
| ActivateOption | () | method |
public function ActivateOption(pTopicId:String):voidParameters
pTopicId:String |
| CharacterSay | () | method |
public function CharacterSay(pChar:AdventureCharacter, pTextToSay:String, pOnComplete:Function = null):voidMakes a character say something.
ParameterspChar:AdventureCharacter — The speaker character.
|
|
pTextToSay:String — The text that the character will way.
|
|
pOnComplete:Function (default = null) |
| CreateDialogMenu | () | method |
protected function CreateDialogMenu(pDialogId:String):DialogMenuParameters
pDialogId:String |
DialogMenu |
| DisplayInfo | () | method |
public function DisplayInfo(pText:String, pOnCompleteFunction:Function = null):voidDisplay an information message.
ParameterspText:String — message to display
|
|
pOnCompleteFunction:Function (default = null) |
| Initialize | () | method |
public function Initialize():voidInitialize the Dialog controller
| LoadSettings | () | method |
protected function LoadSettings(pSettings:XML):voidLoad the settings of the dialogs using the parameters in pSettings
ParameterspSettings:XML — XML with the settings.
|
| PlayTopic | () | method |
public function PlayTopic(pTopic:Topic, pOnCompleteFunc:Function):voidStart to play a dialog topic.
ParameterspTopic: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):voidStarts a scumm dialog
ParameterspDialog:AdventureDialog — AdventureDialog to start.
|
| StopDialog | () | method |
protected function StopDialog():voidForce to stop any dialog playing.
| kPanelHPercent | constant |
protected const kPanelHPercent:Number = 27.5