Name Tags

Older/Work In Progress Page

• This page was initially written for an older version of Helix, has not been updated, and may be out of date!
• Contributions are more than welcome (see buttons at the top right of the page).

How to add Name Tags to Characters.

Add the following code to Server/Index.lua file inside the package.

Client/Index.lua

-- Function to add a Nametag to a Player
function AddNametag(player, character)
    -- Try to get it's character
    if (character == nil) then
        character = player:GetControlledCharacter()
        if (character == nil) then return end
    end

    -- Spawns the Nametag (TextRender),
    local nametag = TextRender(
        Vector(),               -- Any Location
        Rotator(),              -- Any Rotation
        player:GetName(),       -- Player Name
        Vector(0.5, 0.5, 0.5),  -- 50% Scale
        Color(1, 1, 1),         -- White
        FontType.Roboto,        -- Roboto Font
        TextRenderAlignCamera.AlignCameraRotation -- Follow Camera Rotation
    )

    -- Attaches it to the character and saves it to the player's values
    nametag:AttachTo(character)
    nametag:SetRelativeLocation(Vector(0, 0, 250))

    player:SetValue("Nametag", nametag)
end

-- Function to remove a Nametag from  a Player
function RemoveNametag(player, character)
    -- Try to get it's character
    if (character == nil) then
        character = player:GetControlledCharacter()
        if (character == nil) then return end
    end

    -- Gets the Nametag from the player, if any, and destroys it
    local text_render = player:GetValue("Nametag")
    if (text_render and text_render:IsValid()) then
        text_render:Destroy()
    end
end

-- Adds a new Nametag to a character which was possessed
Character.Subscribe("Possessed", function(character, player)
    AddNametag(player, character)
end)

-- Removes the Nametag from a character which was unpossessed
Character.Subscribe("UnPossessed", function(character, player)
    RemoveNametag(player, character)
end)

-- When a Player is spawned - for when you connect and there is already Player's connected
Player.Subscribe("Spawn", function(player)
    RemoveNametag(player)
    AddNametag(player)
end)

To add a character, add this code from the initial setup page.