Player python

From WiCWiki

Revision as of 15:55, 21 November 2007 by Tabu (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search

Contents

Player

Python interface to the players.


Members

Id

Type
int
Description
-


CurrentAP

Type
int
Description
The current amount of aquisition points.


MaxAP

Type
int
Description
The maximum amount of AP the Player can aquire.


CurrentTA

Type
int
Description
The current amount of tactical aid.


MaxTA

Type
int
Description
The maximum amount of TA the Player can aquire.


Team

Type
int
Description
The team the player currently belong to.



Methods

ChatMessage

Syntax
import wic
wic.game.Player.ChatMessage( aMessage [, aTeamChatFlag] )
Description
Sends aMessage to this Player. If aTeamChatFlag is true the message will be flagged as a team chat message.
Exceptions
-
See also
-



AddSupportWeapon

Syntax
import wic
wic.game.Player.AddSupportWeapon( aTAName )
Description
Gives this Player access to the support weapon corresponding to aTAName.
Exceptions
TypeError - aTAName wasn't a string.
See also
#RemoveSupportWeapon



RemoveSupportWeapon

Syntax
import wic
wic.game.Player.RemoveSupportWeapon( aTAName )
Description
Revokes this Players access to aTAName
Exceptions
TypeError - aTAName isn't a string.
See also
#AddSupportWeapon



ClearSupportWeapons

Syntax
import wic
wic.game.Player.ClearSupportWeapons()
Description
Revokes all support weapons for this Player
Exceptions
-
See also
-



AddObjective

Syntax
import wic
wic.game.Player( anObjectiveName[, anObjectiveTarget[, anObjectiveType[, anObjectiveCount]]] )
Description
Gives this Player a new objective.
anObjectiveName gives the name of the objective.
anObjectiveTarget gives the target of the objective. Either a Unit Id or a Vector3. Defaults to -1 for a non targeted objective.
anObjectiveType gives the objective type. Defaults to wic.game.OBJECTIVE_TYPE_PRIMARY
anObjectiveCount gives the number of sub objectives. Defaults to 0 for no subobjectives.
Exceptions
TypeError - an argument was of the wrong type.
ValueError - anObjectiveType have an illegal value.
See also
#SetObjective
#UpdateObjective



SetObjective

Syntax
import wic
wic.game.Player.SetObjective( anObjectiveName, anObjectiveState[, anObjectiveType] )
Description
Sets a new state for a given objective.
Exceptions
ValueError
anObjectiveType or anObjectiveState have an illegal value
See also
#AddObjective
#UpdateObjective



UpdateObjective

Syntax
import wic
wic.game.Player.UpdateObjective( anObjectiveName[, anObjectiveTarget[, anObjectiveType[, anObjectiveCounter[, aNewObjectiveName]]]] )
Description
Updates the objective.
Exceptions
TypeError
anObjectiveTarget is of the wrong type.
ValueError
anObjectiveType have an illegal value
See also
#AddObjective
#UpdateObjective


Personal tools
User Created Content