GetPlayerIdleTime: Difference between revisions

Revision as of 23:26, 21 October 2011

Available only in MTA SA 1.2 and onwards This function gets the amount of time in miliseconds 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 miliseconds 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")) -- 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.

@@ Line 31: / Line 31: @@
 </syntaxhighlight>
 </section>
+==Requirements==
+{{Requirements|1.1.1-9.03316|n/a|}}
 ==See Also==
 {{Player functions}}