A simple addon for Garry's Mod that allows a player to toggle being AFK by typing !afk in chat.
Features:
- Allows you to provide a reason.
- Stops other players from interacting with you.
- Blocks the player from doing anything when there AFK.
- Informs other players that your AFK.
- Remembers your weapons.
- Remembers your active weapon.
- Remembers your ammo.
- Change AFK reason while your AFK.
- Admins can set 'AFK Locations' where the player will be teleported to.
This addon includes a few hooks and functions for developers to use, examples:
-- All hooks are in both server and client realms.
-- afkSystemPlayerEnter is called when the player becomes AFK.
hook.Add("afkSystemPlayerEnter", "playerEnteredAFK", function(ply, reason)
print(ply:Nick() .. " is now AFK because " .. reason)
end)
-- afkSystemPlayerUpdate is called when the player updates their reason.
hook.Add("afkSystemPlayerUpdate", "playerUpdateReason", function(ply, reason)
print(ply:Nick() .. " updated their AFK reason to " .. reason)
end)
-- afkSystemPlayerLeave is called when the player returns to the game.
hook.Add("afkSystemPlayerLeave", "playerLeftAFK", function(ply)
print(ply:Nick() .. " has returned to the game.")
end)
-- All functions are in both server and client realms.
-- 'PLAYER' in this case is a player entity.
PLAYER:isAFK() -- Is the player AFK? Returns a boolean either true or false.
PLAYER:afkReason() -- Reason for AFK. Returns a string.
PLAYER:afkTime() -- Time they started being AFK. Returns a timestamp integer. (`os.time()`)This addon is also available on the Steam Workshop here.