Squirrel/Server/Functions/Players/IdleTime

Revision as of 10:54, 11 October 2010

This function returns the player's Idle Time in ticks.

Syntax

int player.IdleTime

Example

This command gives the player's Idle Time when someone types '/idletime <playername>'.

 
function onPlayerCommand( pPlayer, szCommand, szText )
{
	if ( szCommand == "idletime" )
	{
		local pPlr;
		if ( szText )
		{
			pPlr = FindPlayer( szText );
			if ( pPlr ) MessagePlayer( pPlr.Name + "'s Idle Time is currently " + pPlr.IdleTime + " ticks.", pPlayer );
			else MessagePlayer( "Unknown player!", pPlayer );
		}
		else MessagePlayer( "Your Idle Time is currently " + pPlayer.IdleTime + " ticks.", pPlayer );
	}
	
	return 1;
}
 

Notes

The functions MessagePlayer and FindPlayer and Player.Name and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions

Template:Squirrel/Functions/Players