| Package | org.wak.character.display |
| Class | public class AbstractCharacterDisplay |
| Inheritance | AbstractCharacterDisplay  flash.display.Sprite |
| Implements | ISceneInteractable |
| Subclasses | SingleBmpCharacterDisplay, TestPlayerDisplay |
| Property | Defined by | ||
|---|---|---|---|
| baseline : int [read-only]
| AbstractCharacterDisplay | ||
| currentBehaviour : String [read-only]
The current animation behaviour.
| AbstractCharacterDisplay | ||
| currentTile : IntPoint
[read-only]
| AbstractCharacterDisplay | ||
| defaultAction : String [read-only]
| AbstractCharacterDisplay | ||
| deltaX : Number [read-only]
Returns the deltaX of the screen coordinates.
| AbstractCharacterDisplay | ||
| deltaY : Number [read-only]
Returns the deltaY of the screen coordinates.
| AbstractCharacterDisplay | ||
| description : String [read-only]
| AbstractCharacterDisplay | ||
| dialogX : Number [read-only]
| AbstractCharacterDisplay | ||
| dialogY : Number [read-only]
| AbstractCharacterDisplay | ||
| displayObject : DisplayObject [read-only]
| AbstractCharacterDisplay | ||
| enabled : Boolean [read-only]
| AbstractCharacterDisplay | ||
| interactableId : String [read-only]
| AbstractCharacterDisplay | ||
| interactionBehaviour : String [read-only]
| AbstractCharacterDisplay | ||
| interactionName : String [read-only]
| AbstractCharacterDisplay | ||
| interactionPointX : Number [read-only]
| AbstractCharacterDisplay | ||
| interactionPointY : Number [read-only]
| AbstractCharacterDisplay | ||
| isMoving : Boolean [read-only]
Getter to know if the player is moving through the scene.
| AbstractCharacterDisplay | ||
| moveSpeed : Number | AbstractCharacterDisplay | ||
| perspectiveEnabled : Boolean [read-only]
| AbstractCharacterDisplay | ||
| pfGoal : IntPoint | AbstractCharacterDisplay | ||
| pfStart : IntPoint | AbstractCharacterDisplay | ||
| portrait : MovieClip [read-only]
Portrait display object of this CharacterDisplay
| AbstractCharacterDisplay | ||
| sceneId : String | AbstractCharacterDisplay | ||
| stageX : Number [read-only]
| AbstractCharacterDisplay | ||
| stageY : Number [read-only]
| AbstractCharacterDisplay | ||
| unitaryUse : Boolean [read-only]
| AbstractCharacterDisplay | ||
| walkIndex : int | AbstractCharacterDisplay | ||
| walkPoints : Array | AbstractCharacterDisplay | ||
| Property | Defined by | ||
|---|---|---|---|
| mCurrentTile : IntPoint | AbstractCharacterDisplay | ||
| mDisplayId : String = "" | AbstractCharacterDisplay | ||
| mEnabled : Boolean = true | AbstractCharacterDisplay | ||
| mIsMoving : Boolean | AbstractCharacterDisplay | ||
| mMoveSpeed : Number = 90 | AbstractCharacterDisplay | ||
| mMovingAngle : Number = 0 | AbstractCharacterDisplay | ||
| mMovingTilesAngle : Number = 0 | AbstractCharacterDisplay | ||
| mPortrait : MovieClip = null | AbstractCharacterDisplay | ||
| mPrevTile : IntPoint | AbstractCharacterDisplay | ||
| mUpdatePerspective : Boolean = true | AbstractCharacterDisplay | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor
| AbstractCharacterDisplay | ||
|
CurrentTileIsEqual(pTile:IntPoint):Boolean
Method to test if the param pTile is equal to the current tile where the player is.
| AbstractCharacterDisplay | ||
|
ResetPosition(pX:Number, pY:Number):void
| AbstractCharacterDisplay | ||
|
ResetTilePosition(pX:Number, pY:Number):void
| AbstractCharacterDisplay | ||
|
SetAnimBehaviour(pAnimBehaviour:String, pPlays:int = 1, pOnPlayed:Function = null):void
Set an animation behaviour and play it.
| AbstractCharacterDisplay | ||
|
SetCurrentTile(pX:int, pY:int):void
This method is called by the Scene containing this PlayerRenderer
to set the current tile inside the background tile map.
| AbstractCharacterDisplay | ||
|
SetInteractionPoint(pX:Number, pY:Number):void
Method to set the interaction point for this Character display.
| AbstractCharacterDisplay | ||
|
SetInteractionPointBehaviour(pB:String):void
| AbstractCharacterDisplay | ||
|
SetOwner(pOwner:AdventureCharacter):void
| AbstractCharacterDisplay | ||
|
StartWalk(pOnCompleteHandler:Function = null):void
| AbstractCharacterDisplay | ||
|
StopWalk():void
| AbstractCharacterDisplay | ||
|
Update(event:Event):void
Handler of the ENTER_FRAME event.
| AbstractCharacterDisplay | ||
|
WalkDestinationReached():void
| AbstractCharacterDisplay | ||
| Method | Defined by | ||
|---|---|---|---|
|
OnAddedToStage(event:Event):void
Handler of the ADDED_TO_STAGE event.
| AbstractCharacterDisplay | ||
|
OnRemovedFromStage(event:Event):void
Handler of the REMOVED_FROM_STAGE event.
| AbstractCharacterDisplay | ||
| baseline | property |
baseline:int [read-only]Implementation
public function get baseline():int
| currentBehaviour | property |
currentBehaviour:String [read-only]The current animation behaviour.
Implementation public function get currentBehaviour():String
| currentTile | property |
| defaultAction | property |
defaultAction:String [read-only]Implementation
public function get defaultAction():String
| deltaX | property |
deltaX:Number [read-only]Returns the deltaX of the screen coordinates.
Implementation public function get deltaX():Number
| deltaY | property |
deltaY:Number [read-only]Returns the deltaY of the screen coordinates.
Implementation public function get deltaY():Number
| description | property |
description:String [read-only]Implementation
public function get description():String
| dialogX | property |
dialogX:Number [read-only]Implementation
public function get dialogX():Number
| dialogY | property |
dialogY:Number [read-only]Implementation
public function get dialogY():Number
| displayObject | property |
displayObject:DisplayObject [read-only]Implementation
public function get displayObject():DisplayObject
| enabled | property |
enabled:Boolean [read-only]Implementation
public function get enabled():Boolean
| interactableId | property |
interactableId:String [read-only]Implementation
public function get interactableId():String
| interactionBehaviour | property |
interactionBehaviour:String [read-only]Implementation
public function get interactionBehaviour():String
| interactionName | property |
interactionName:String [read-only]Implementation
public function get interactionName():String
| interactionPointX | property |
interactionPointX:Number [read-only]Implementation
public function get interactionPointX():Number
| interactionPointY | property |
interactionPointY:Number [read-only]Implementation
public function get interactionPointY():Number
| isMoving | property |
isMoving:Boolean [read-only]Getter to know if the player is moving through the scene.
Implementation public function get isMoving():Boolean
| mCurrentTile | property |
protected var mCurrentTile:IntPoint
| mDisplayId | property |
protected var mDisplayId:String = ""
| mEnabled | property |
protected var mEnabled:Boolean = true
| mIsMoving | property |
protected var mIsMoving:Boolean
| mMoveSpeed | property |
protected var mMoveSpeed:Number = 90
| mMovingAngle | property |
protected var mMovingAngle:Number = 0
| mMovingTilesAngle | property |
protected var mMovingTilesAngle:Number = 0
| moveSpeed | property |
moveSpeed:Number [read-write]Implementation
public function get moveSpeed():Number
public function set moveSpeed(value:Number):void
| mPortrait | property |
protected var mPortrait:MovieClip = null
| mPrevTile | property |
protected var mPrevTile:IntPoint
| mUpdatePerspective | property |
protected var mUpdatePerspective:Boolean = true
| perspectiveEnabled | property |
perspectiveEnabled:Boolean [read-only]Implementation
public function get perspectiveEnabled():Boolean
| pfGoal | property |
pfGoal:IntPoint [read-write]Implementation
public function get pfGoal():IntPoint
public function set pfGoal(value:IntPoint):void
| pfStart | property |
pfStart:IntPoint [read-write]Implementation
public function get pfStart():IntPoint
public function set pfStart(value:IntPoint):void
| portrait | property |
portrait:MovieClip [read-only]Portrait display object of this CharacterDisplay
Implementation public function get portrait():MovieClip
| sceneId | property |
sceneId:String [read-write]Implementation
public function get sceneId():String
public function set sceneId(value:String):void
| stageX | property |
stageX:Number [read-only]Implementation
public function get stageX():Number
| stageY | property |
stageY:Number [read-only]Implementation
public function get stageY():Number
| unitaryUse | property |
unitaryUse:Boolean [read-only]Implementation
public function get unitaryUse():Boolean
| walkIndex | property |
walkIndex:int [read-write]Implementation
public function get walkIndex():int
public function set walkIndex(value:int):void
| walkPoints | property |
walkPoints:Array [read-write]Implementation
public function get walkPoints():Array
public function set walkPoints(value:Array):void
| AbstractCharacterDisplay | () | constructor |
public function AbstractCharacterDisplay()Constructor
| CurrentTileIsEqual | () | method |
public function CurrentTileIsEqual(pTile:IntPoint):BooleanMethod to test if the param pTile is equal to the current tile where the player is.
ParameterspTile:IntPoint — IntPoint with the coordinates of a tile.
|
Boolean — true if pTile is equal to the current tile of the player.
|
| OnAddedToStage | () | method |
protected function OnAddedToStage(event:Event):voidHandler of the ADDED_TO_STAGE event.
Parametersevent:Event |
| OnRemovedFromStage | () | method |
protected function OnRemovedFromStage(event:Event):voidHandler of the REMOVED_FROM_STAGE event.
Parametersevent:Event |
| ResetPosition | () | method |
public function ResetPosition(pX:Number, pY:Number):voidParameters
pX:Number |
|
pY:Number |
| ResetTilePosition | () | method |
public function ResetTilePosition(pX:Number, pY:Number):voidParameters
pX:Number |
|
pY:Number |
| SetAnimBehaviour | () | method |
public function SetAnimBehaviour(pAnimBehaviour:String, pPlays:int = 1, pOnPlayed:Function = null):voidSet an animation behaviour and play it.
ParameterspAnimBehaviour:String — the id of the anim behaviour.
|
|
pPlays:int (default = 1) |
|
pOnPlayed:Function (default = null) |
| SetCurrentTile | () | method |
public function SetCurrentTile(pX:int, pY:int):voidThis method is called by the Scene containing this PlayerRenderer to set the current tile inside the background tile map.
ParameterspX:int — current horizontal coordinate of the tile where the player
|
|
pY:int — current vertical coordinate of the tile where the player
|
| SetInteractionPoint | () | method |
public function SetInteractionPoint(pX:Number, pY:Number):voidMethod to set the interaction point for this Character display.
ParameterspX:Number — horizontal coordinate of the interaction point.
|
|
pY:Number — vertical coordinate of the interaction point.
|
| SetInteractionPointBehaviour | () | method |
public function SetInteractionPointBehaviour(pB:String):voidParameters
pB:String |
| SetOwner | () | method |
| StartWalk | () | method |
public function StartWalk(pOnCompleteHandler:Function = null):voidParameters
pOnCompleteHandler:Function (default = null) |
| StopWalk | () | method |
public function StopWalk():void
| Update | () | method |
public function Update(event:Event):voidHandler of the ENTER_FRAME event. Main Loop of the AbstractPlayerRenderer.
Parametersevent:Event |
| WalkDestinationReached | () | method |
public function WalkDestinationReached():void