API GetPlayerFaction: Difference between revisions

Latest revision as of 02:25, 20 October 2011

Definition

GetPlayerFaction( [ number charid ]) -> number factionid

Description

get nation of a player

Arguments

Type	Name	Description
number	charid	character id or nil. Use nil to get current player's faction (optional)

Returns

Type	Name	Description
number	factionid	number representing the faction (1-13, 99)

@@ Line 1: / Line 1: @@
-=== GetPlayerFaction ===
+{{Function
-'''Definition:'''
+| name         = GetPlayerFaction
-GetPlayerFaction(int charid) -> int factionid
+| desc         = get nation of a player
-<br>
+| arg1_name    = charid
-'''Description:'''<br>
+| arg1_type    = number
-get nation of a player
+| arg1_desc    = character id or nil.  Use nil to get current player's faction
-<br>
+| arg1_opt     = true
-'''Arguments:'''<br>
+| ret1_name    = [[factionid]]
-''charid'' character id or nil
+| ret1_type    = number
-<br>
+| ret1_desc    = number representing the faction (1-13, 99)
-'''Returns:'''<br>
+| notes        =
-''factionid'' number representing the faction (1-13, 99)
+}}
-<br>