GetPlayerIdleTime: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Fixed the example.)
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
{{New feature/item|3.0120|1.2||
'''Available only in MTA SA 1.2 and onwards'''
}}
This function gets the amount of time in milliseconds that a players position has not changed.
This function gets the amount of time in milliseconds that a players position has not changed.


Revision as of 09:50, 6 August 2012

This function gets the amount of time in milliseconds that a players position has not changed.

Syntax

int getPlayerIdleTime ( player thePlayer )

Required Arguments

  • thePlayer: The player you wish to get the idle time of.

Returns

Returns the amount of time in milliseconds that a player has been idle, false otherwise.

Example

Click to collapse [-]
Serverside example

This example will kick a player if they don't move for 5 minutes and the resource has access to "function.kickPlayer" 

function checkAFKPlayers()
    for index, thePlayer in ipairs(getElementsByType("player"))do -- Loop all online players
        if (getPlayerIdleTime(thePlayer) > 300000) then -- Player hasn't moved for 300,000ms (5 minutes)
            kickPlayer(thePlayer, "Idle for 5 minutes") -- Kick the idle player
        end
    end
end
setTimer(checkAFKPlayers, 30000, 0) -- Timer to execute every 30 seconds, checking for idlers

Requirements

This template will be deleted.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerIdleTime?oldid=32163"