Packageorg.wak.scene
Classpublic class XMLItemDefinition
ImplementsISceneItemDefinition

XML Definition of an SceneItem



Public Properties
 PropertyDefined by
  baseline : int
[read-only] Coordinate value in Y axis which determines when this item should be displayed over the player's character or in the back.
XMLItemDefinition
  defaultAction : String
[read-only] Action id as default
XMLItemDefinition
  description : String
[read-only] The description of this item.
XMLItemDefinition
  enabled : Boolean
[read-only] Flag to set the item enable or disable for action.
XMLItemDefinition
  interactionBehaviour : String
[read-only] animation behaviour to set to the player's character display after walked to the interaction point.
XMLItemDefinition
  interactionPoint : IntPoint
[read-only] Usually the player's character should walk to the item to interact with it.
XMLItemDefinition
  itemId : String
[read-only] Id of this Scene Item.
XMLItemDefinition
  itemName : String
[read-only] The name of this item .
XMLItemDefinition
  startingPoint : IntPoint
[read-only] The coordinates x,y of where this item is placed on the Scene.
XMLItemDefinition
  unitaryUse : Boolean
[read-only]
XMLItemDefinition
  viewStates : Array
[read-only] Array of view states of the scene item.
XMLItemDefinition
  visible : Boolean
[read-only] Flag to set the item visible or invisible.
XMLItemDefinition
Public Methods
 MethodDefined by
  
XMLItemDefinition(pXMLDef:XML)
constructor
XMLItemDefinition
Property detail
baselineproperty
baseline:int  [read-only]

Coordinate value in Y axis which determines when this item should be displayed over the player's character or in the back.

Implementation
    public function get baseline():int
defaultActionproperty 
defaultAction:String  [read-only]

Action id as default

Implementation
    public function get defaultAction():String
descriptionproperty 
description:String  [read-only]

The description of this item. Is what the character usually says when he look at this item.

Implementation
    public function get description():String
enabledproperty 
enabled:Boolean  [read-only]

Flag to set the item enable or disable for action.

Implementation
    public function get enabled():Boolean
interactionBehaviourproperty 
interactionBehaviour:String  [read-only]

animation behaviour to set to the player's character display after walked to the interaction point.

Implementation
    public function get interactionBehaviour():String
interactionPointproperty 
interactionPoint:IntPoint  [read-only]

Usually the player's character should walk to the item to interact with it. Well this is the point where the player will walk before interact with this item in some way.

Implementation
    public function get interactionPoint():IntPoint
itemIdproperty 
itemId:String  [read-only]

Id of this Scene Item.

Implementation
    public function get itemId():String
itemNameproperty 
itemName:String  [read-only]

The name of this item .

Implementation
    public function get itemName():String
startingPointproperty 
startingPoint:IntPoint  [read-only]

The coordinates x,y of where this item is placed on the Scene.

Implementation
    public function get startingPoint():IntPoint
unitaryUseproperty 
unitaryUse:Boolean  [read-only]

Implementation
    public function get unitaryUse():Boolean
viewStatesproperty 
viewStates:Array  [read-only]

Array of view states of the scene item.

Implementation
    public function get viewStates():Array
visibleproperty 
visible:Boolean  [read-only]

Flag to set the item visible or invisible.

Implementation
    public function get visible():Boolean
Constructor detail
XMLItemDefinition()constructor
public function XMLItemDefinition(pXMLDef:XML)

constructor

Parameters
pXMLDef:XML — xml input of an scene item.