2 Exposed_Player_Functions

anton edited this page 2009-01-27 14:09:15 +00:00

Table of Contents

• Player Methods
• toString
• setColour()
• getColour()
• setDiplomaticStance()
• getDiplomaticStance()
• Entity Properties
• name
• id
• active
• controlled

Pyrogenesis Object Model : PlayerClass

Player Methods

toString

• Overview:
• None
• Syntax:
• Player.toString();
• Parameters:
• None
• Returns:
• string: "[Player: [PlayerName]object]" where PlayerName is player's name.
• Notes:
• None

setColour()

• Overview:
• None
• Syntax:
• None
• Parameters:
• None
• Returns:
• None
• Notes:
• None

getColour()

• Overview:
• None
• Syntax:
• None
• Parameters:
• None
• Returns:
• None
• Notes:
• None

setDiplomaticStance()

• Overview:
• None
• Syntax:
• None
• Parameters:
• None
• Returns:
• None
• Notes:
• None

getDiplomaticStance()

• Overview:
• None
• Syntax:
• None
• Parameters:
• None
• Returns:
• None
• Notes:
• None

Entity Properties

name

• Overview:
• Gets player's name
• Type:
• string
• Notes:

id

• Overview:
• Gets player's id
• Type:
• int
• Notes:

active

• Overview:
• Returns true if the player is active, otherwise returns false.
• Type:
• string
• Notes:

controlled

• Overview:
• Returns an array with all the Entity objects that this player is controlling.
• Type:
• array
• Notes: