Packageorg.wak.scene
Interfacepublic interface ISceneDefinition
ImplementorsSceneDefinition, XMLSceneDefinition

Interface for the definition of a Scene Contains all the data needed to create a Scene.



Public Properties
 PropertyDefined by
  actionspots : Array
[read-only] Array of ActionSpot s.
ISceneDefinition
  ambientalSoundId : String
[read-only] The id of the ambiental sound or music of the Scene.
ISceneDefinition
  backgroundId : String
[read-only] Scene's background id.
ISceneDefinition
  blockedForWalkArray : Array
[read-only] blocked for walk tiles array.
ISceneDefinition
  charactersOnScene : Array
[read-only] Array of SceneCharData holding the info of the position of a character on the Scene
ISceneDefinition
  debugEnabled : Boolean
[read-only] debug flag of the scene.
ISceneDefinition
  gatespots : Array
[read-only] Array of gatespots to jump from one scene to another.
ISceneDefinition
  playerCharacter : String
[read-only] Player character on the scene
ISceneDefinition
  playerStartingPoint : IntPoint
[read-only] player initial position in the scene the first time he enter in the Scene
ISceneDefinition
  playerWalkSpeed : Number
[read-only] player walk speed into the Scene.
ISceneDefinition
  scaleBase : Number
[read-only] Scale base of the scene This value is added to the scaling formula to give a greater max value of scaling.
ISceneDefinition
  scaleRate : Number
[read-only] Scale rate of the scene Scale decrement rate, for each pixel away from the camera the scale will be decreased 1X this value.
ISceneDefinition
  sceneId : String
[read-only] The id of the Scene
ISceneDefinition
  sceneItems : Array
[read-only] An array containing the items on the Scene
ISceneDefinition
  tileSize : int
[read-only] width and height of the tile.
ISceneDefinition
  walkBehinds : Array
[read-only] An array containing WalkBehindArea Definitions
ISceneDefinition
Property detail
actionspotsproperty
actionspots:Array  [read-only]

Array of ActionSpot s.

Implementation
    public function get actionspots():Array
ambientalSoundIdproperty 
ambientalSoundId:String  [read-only]

The id of the ambiental sound or music of the Scene.

Implementation
    public function get ambientalSoundId():String
backgroundIdproperty 
backgroundId:String  [read-only]

Scene's background id.

Implementation
    public function get backgroundId():String
blockedForWalkArrayproperty 
blockedForWalkArray:Array  [read-only]

blocked for walk tiles array.

Implementation
    public function get blockedForWalkArray():Array
charactersOnSceneproperty 
charactersOnScene:Array  [read-only]

Array of SceneCharData holding the info of the position of a character on the Scene

Implementation
    public function get charactersOnScene():Array
debugEnabledproperty 
debugEnabled:Boolean  [read-only]

debug flag of the scene.

Implementation
    public function get debugEnabled():Boolean
gatespotsproperty 
gatespots:Array  [read-only]

Array of gatespots to jump from one scene to another.

Implementation
    public function get gatespots():Array
playerCharacterproperty 
playerCharacter:String  [read-only]

Player character on the scene

Implementation
    public function get playerCharacter():String
playerStartingPointproperty 
playerStartingPoint:IntPoint  [read-only]

player initial position in the scene the first time he enter in the Scene

Implementation
    public function get playerStartingPoint():IntPoint
playerWalkSpeedproperty 
playerWalkSpeed:Number  [read-only]

player walk speed into the Scene.

Implementation
    public function get playerWalkSpeed():Number
scaleBaseproperty 
scaleBase:Number  [read-only]

Scale base of the scene This value is added to the scaling formula to give a greater max value of scaling.

Implementation
    public function get scaleBase():Number
scaleRateproperty 
scaleRate:Number  [read-only]

Scale rate of the scene Scale decrement rate, for each pixel away from the camera the scale will be decreased 1X this value.

Implementation
    public function get scaleRate():Number
sceneIdproperty 
sceneId:String  [read-only]

The id of the Scene

Implementation
    public function get sceneId():String
sceneItemsproperty 
sceneItems:Array  [read-only]

An array containing the items on the Scene

Implementation
    public function get sceneItems():Array
tileSizeproperty 
tileSize:int  [read-only]

width and height of the tile.

Implementation
    public function get tileSize():int
walkBehindsproperty 
walkBehinds:Array  [read-only]

An array containing WalkBehindArea Definitions

Implementation
    public function get walkBehinds():Array