getPlayerIdleTime | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getPlayerIdleTime

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

OOP Syntax Help! I don't understand this!

  • Method:player:getIdleTime(...)
  • Variable: .idleTime

Syntax 

int getPlayerIdleTime ( player thePlayer )
Required Arguments
  • thePlayer: The player you wish to get the idle time of.

Returns

  • int: value

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

Code Examples

shared

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

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

See Also

Player Functions
Player Events
Reference