This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

Bz getIdleTime: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
Allejo (talk | contribs)
Created page with "{{apicall | name = bz_getIdleTime | description = Returns the amount of time a player has been idele in seconds | param1 = playerId | param1type = int | param1desc ..."
 
Allejo (talk | contribs)
m Changed documentation for the new return values
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{apicall
{{apicall
| name        = bz_getIdleTime
| name        = bz_getIdleTime
| description = Returns the amount of time a player has been idele in seconds
| description = Returns the amount of time a player has been idle in seconds. If the player ID does not exist or the player is an observer, it will return -1; otherwise it will return 0 if the player has not been idle.
| param1      = playerId
| param1      = playerId
| param1type  = int
| param1type  = int

Latest revision as of 05:06, 30 January 2014

int bz_getIdleTime (int playerId)


Minimum API Version: 2.4.3 or later
Returns the amount of time a player has been idle in seconds. If the player ID does not exist or the player is an observer, it will return -1; otherwise it will return 0 if the player has not been idle.

Parameters:
playerId  -  Player to lookup.
Returns:
Number of seconds of idle time