PlayerMeta

Extensions to the Player meta-table added by the Fazbear's Hunt gamemode.

Player role SHARED

PLAYER:IsSurvivor()

Returns true if the player is a survivor.

if ply:IsSurvivor() then
    print(ply:Nick() .. " is a survivor")
end

PLAYER:IsAnimatronic()

Returns true if the player is an animatronic.

if ply:IsAnimatronic() then
    ply:ChatPrint("Happy hunting!")
end

Important

If you put a survivor into the TEAM_PILLS team (or 2701), the game will return true here.

PLAYER:GetPill()

Returns the player's Pill entity.

local ent = ply:GetPill()
if IsValid(ent) then
	print("Pill is present!")
end

Important

This method directly calls pills.getMappedEnt(ply), so it is recommended to use the latter for optimization.

---

Events SHARED

PLAYER:IsJumpscared()

Is the player currently being screamed?

PLAYER:SetJumpscared()

Sets whether the player is currently being screamed.

Note

This function is already used automatically inside performJumpscare

ENTITY:IsInvisible()

Is the player invisible?

Note

For it to return true, entity must have models/null material, or have :GetNoDraw() == true.

This function can be used on both PLAYER and ENTITY.

---

Spawn and position SERVER

PLAYER:ReturnToSpawn()

Changes the player's position to the spawn point. Unlike ENTITY:Spawn(), does not recreate the player — weapons, health, etc. are preserved.

ply:ReturnToSpawn()

PLAYER:SuppressRagdollSpawn(bool)

Allows canceling the spawn of a death ragdoll. Automatically resets to false after one spawn attempt.

hook.Add("DoPlayerDeath", "NoRagdoll", function(ply)
    ply:SuppressRagdollSpawn(true)
end)

---

Getting stuck SERVER

PLAYER:IsStuck()

Checks the player's hitbox for getting stuck in geometry or other entities. Unlike ENTITY:IsInWorld(), accounts for the hitbox.

PLAYER:Unstuck()

Attempts to teleport the player to a place where they are not stuck. Use together with IsStuck():

hook.Add("PlayerLeaveVehicle", "CheckStuck", function(ply, ply)
    timer.Simple(0.5, function()
        if IsValid(ply) and ply:IsStuck() then
            ply:Unstuck()
        end
    end)
end)

---

Pushing SERVER

PLAYER:SetPushImmune(bool)

Sets immunity to being pushed by other players.

PLAYER:IsPushImmune()

Does the player have immunity to being pushed?

PLAYER:SetPushBlocked(bool)

Can the player push others?

PLAYER:IsPushBlocked()

Is the player forbidden from pushing others?

-- I won't push them, and they won't push me.
ply:SetPushImmune(true)
ply:SetPushBlocked(true)

---

Voice chat SERVER

PLAYER:SetAudible(bool)

Is the player audible to other players in voice chat?

PLAYER:GetAudible()

Returns the current audibility status.

PLAYER:ForceListenPlayer(Player)

Forces the player to hear only the specified player (disable all others).

PLAYER:ResetListenPlayer()

Resets forced listening.

-- Force the victim to hear only the animatronic
victim:ForceListenPlayer(killer)

-- After 10 seconds, return to normal state
timer.Simple(10, function()
    if IsValid(victim) then victim:ResetListenPlayer() end
end)

---

Golden Freddy SERVER

PLAYER:SetGFreddyImmune(bool)

Immunity to Golden Freddy's ability (Outworld Dimension).

PLAYER:GetGFreddyImmune()

Returns the current immunity status.

-- All admins are immune to Golden Freddy
hook.Add("PlayerSpawn", "AdminGFImmune", function(ply)
    if ply:IsAdmin() then
        ply:SetGFreddyImmune(true)
    end
end)

---

Gifts SERVER

Already used by the gamemode

These functions are used by the gamemode by default — they do not give out a second gift until the first one is picked up. Use them if you know what you are doing.

PLAYER:SetGiftOwnership(bool)

Sets the gift ownership flag.

PLAYER:GetGiftOwnership()

Does the player have an uncollected gift?

if not ply:GetGiftOwnership() then
    -- spawn a new gift
end