Packageorg.wak.scene
Classpublic class SceneDefinition
ImplementsISceneDefinition

SceneDefinitions is a class to groups all the parameters involved in the creation of a Scene and it is used to create a new Scene.



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

Array of ActionSpot s.

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

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

Implementation
    public function get ambientalSoundId():String
    public function set ambientalSoundId(value:String):void
backgroundIdproperty 
backgroundId:String  [read-write]Implementation
    public function get backgroundId():String
    public function set backgroundId(value:String):void
blockedForWalkArrayproperty 
blockedForWalkArray:Array  [read-only]Implementation
    public function get blockedForWalkArray():Array
charactersOnSceneproperty 
charactersOnScene:Array  [read-write]

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

Implementation
    public function get charactersOnScene():Array
    public function set charactersOnScene(value:Array):void
debugEnabledproperty 
debugEnabled:Boolean  [read-write]

Getter of debug flag of the Scene.

Implementation
    public function get debugEnabled():Boolean
    public function set debugEnabled(value:Boolean):void
gatespotsproperty 
gatespots:Array  [read-write]

Array of gatespots to jump from one scene to another.

Implementation
    public function get gatespots():Array
    public function set gatespots(value:Array):void
playerCharacterproperty 
playerCharacter:String  [read-write]Implementation
    public function get playerCharacter():String
    public function set playerCharacter(value:String):void
playerRendererproperty 
playerRenderer:AbstractCharacterDisplay  [read-write]

Getter of the player renderer on the Scene

Implementation
    public function get playerRenderer():AbstractCharacterDisplay
    public function set playerRenderer(value:AbstractCharacterDisplay):void
playerStartingPointproperty 
playerStartingPoint:IntPoint  [read-write]

Getter of the player initial position in the Scene

Implementation
    public function get playerStartingPoint():IntPoint
    public function set playerStartingPoint(value:IntPoint):void
playerWalkSpeedproperty 
playerWalkSpeed:Number  [read-write]

Getter of the player walk speed into the Scene

Implementation
    public function get playerWalkSpeed():Number
    public function set playerWalkSpeed(value:Number):void
scaleBaseproperty 
scaleBase:Number  [read-write]

Getter of the 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
    public function set scaleBase(value:Number):void
scaleRateproperty 
scaleRate:Number  [read-write]

Getter of the 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
    public function set scaleRate(value:Number):void
sceneIdproperty 
sceneId:String  [read-write]Implementation
    public function get sceneId():String
    public function set sceneId(value:String):void
sceneItemsproperty 
sceneItems:Array  [read-only]

An array containing the items on the Scene

Implementation
    public function get sceneItems():Array
SceneItemsproperty 
SceneItems:Array  [write-only]

Implementation
    public function set SceneItems(value:Array):void
tileSizeproperty 
tileSize:int  [read-write]

Getter of the width and height of the tile.

Implementation
    public function get tileSize():int
    public function set tileSize(value:int):void
walkBehindsproperty 
walkBehinds:Array  [read-write]

An array containing WalkBehindArea Definitions

Implementation
    public function get walkBehinds():Array
    public function set walkBehinds(value:Array):void
Constructor detail
SceneDefinition()constructor
public function SceneDefinition()
Method detail
SetblockedForWalkArray()method
public function SetblockedForWalkArray(value:Array):void

Setter of blocked for walk tiles array.

Parameters
value:Array — with IntPoints indicating which tiles are blocked for walk.