com.theoworlds.builder.settings.CharacterSettings

com.theoworlds.builder.settings.CharacterSettings

CharacterSettings class stores the settings of a Character object

Version

1.0

Author

© TheoWorlds.com, 2007-2009.

Summary
com.theoworlds.builder.settings.CharacterSettingsCharacterSettings class stores the settings of a Character object
Variables
netIDnet id of the character -- from server.
chatColorpredefined chat message color border.
displayNamethe name of the character displayed on the screen (can be different from nickname, id)
cCurrentTileElevationthe elevation of the current tile (elevation is the character own elevation -- can be different)
destinationTilethe coordinates of the tile the characters moves to
currentActionName-- the name of the current action
isICharacteris that character controllable
directionthe direction of the character
phasethe animation phase of the character
speedthe character speed.
selectableis the character selectable
brainType“brain” type (the character logic class) //OPT add some constants for the names?
brainAutoStartauto--start
brainInitObj
dressedClothesNameslooks like {name1:”name1” [,name2:”name2”]}.
actionsmore info in MapObject._actions
layersXML node that stores the layers
Functions
CharacterSettingsvar forMessage is true in cases, when CharacterSettings is used for messages to server
dressedClothesNamesFromString
dressedClothesNamesToString
_dressedClothesToStringString { clothesName
_dressedClothesFromStringconverts from String into an Object.
Properties
TYPE_SERVER_VARIABLES
TYPE_MOVING_CORRECTION
TYPE_MOVE

Variables

netID

public var netID: String

net id of the character -- from server.  String is used for cross--platforming

chatColor

public var chatColor: Number

predefined chat message color border. it helps differentiating the messages

displayName

public var displayName: String

the name of the character displayed on the screen (can be different from nickname, id)

cCurrentTileElevation

public var cCurrentTileElevation: Number

the elevation of the current tile (elevation is the character own elevation -- can be different)

destinationTile

public var destinationTile: Point

the coordinates of the tile the characters moves to

currentActionName

public var currentActionName: String

Returns

-- the name of the current action

isICharacter

public var isICharacter: Boolean

is that character controllable

direction

public var direction: Number

the direction of the character

phase

public var phase: Number

the animation phase of the character

speed

public var speed: Number

the character speed.  Not used yet.  In the future it will be used to change the character speed dinamically

selectable

public var selectable: Boolean

is the character selectable

brainType

public var brainType: String

”brain” type (the character logic class) //OPT add some constants for the names?

brainAutoStart

public var brainAutoStart: Boolean

auto--start

brainInitObj

public var brainInitObj: Object

dressedClothesNames

public var dressedClothesNames: Object

looks like {name1:”name1” [,name2:”name2”]}.  Everything that is linked to the layers (clothes) is set as XML or Object This is why this was left as an Object as well

actions

public var actions: Object

more info in MapObject._actions

layers

public var layers: XMLNode

XML node that stores the layers

Functions

CharacterSettings

function CharacterSettings(type: Number)

var forMessage is true in cases, when CharacterSettings is used for messages to server

dressedClothesNamesFromString

public static function dressedClothesNamesFromString(str: String):Object

dressedClothesNamesToString

public static function dressedClothesNamesToString(o: Object):String

_dressedClothesToString

function _dressedClothesToString():String

Returns

String { clothesName

_dressedClothesFromString

function _dressedClothesFromString(str: String):Void

converts from String into an Object.  //OPT Will be moved to Server

Properties

TYPE_SERVER_VARIABLES

public static function get TYPE_SERVER_VARIABLES():Number

TYPE_MOVING_CORRECTION

public static function get TYPE_MOVING_CORRECTION():Number

TYPE_MOVE

public static function get TYPE_MOVE():Number
This class and its inheritants is used to organize the map object parameters
public var netID: String
net id of the character -- from server.
public var chatColor: Number
predefined chat message color border.
public var displayName: String
the name of the character displayed on the screen (can be different from nickname, id)
public var cCurrentTileElevation: Number
the elevation of the current tile (elevation is the character own elevation -- can be different)
public var destinationTile: Point
the coordinates of the tile the characters moves to
public var currentActionName: String
-- the name of the current action
public var isICharacter: Boolean
is that character controllable
public var direction: Number
the direction of the character
public var phase: Number
the animation phase of the character
public var speed: Number
the character speed.
public var selectable: Boolean
is the character selectable
public var brainType: String
“brain” type (the character logic class) //OPT add some constants for the names?
public var brainAutoStart: Boolean
auto--start
public var brainInitObj: Object
public var dressedClothesNames: Object
looks like {name1:”name1” [,name2:”name2”]}.
public var actions: Object
more info in MapObject._actions
private var _actions: Object
name{name:String, [attributes:*]}
public var layers: XMLNode
XML node that stores the layers
function CharacterSettings(type: Number)
var forMessage is true in cases, when CharacterSettings is used for messages to server
public static function dressedClothesNamesFromString(str: String):Object
public static function dressedClothesNamesToString(o: Object):String
function _dressedClothesToString():String
String { clothesName
function _dressedClothesFromString(str: String):Void
converts from String into an Object.
public static function get TYPE_SERVER_VARIABLES():Number
public static function get TYPE_MOVING_CORRECTION():Number
public static function get TYPE_MOVE():Number
Close