• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    User

    Represents a Highrise user account with their profile information. Access via player.user to get user details for any player.

    Available on: Client and Server scripts

    Properties

    id

    string
    ClientAndServer
    ReadOnly

    The unique user ID for this Highrise account. This ID is persistent across all worlds and sessions. Use this for storage keys, leaderboards, and identifying users.

    -- Store user-specific data using their ID
    local userId = player.user.id
    Storage.SetPlayerValue(player, "Score", 100)
    
    -- Check if player owns something
    Storage.GetValue("ItemOwner_sword", function(ownerId, error)
        if ownerId == player.user.id then
            print(player.name .. " owns the sword!")
        end
    end)
    
    -- Use in leaderboards
    Leaderboard.SetScore("global", player.user.id, player.name, 1000)
    

    isAgeVerifiedAbove18

    boolean
    ClientAndServer
    ReadOnly

    True if the user has verified their age as 18 or older. Use this to restrict access to age-gated content or features.

    -- Restrict access to mature content
    if player.user.isAgeVerifiedAbove18 then
        -- Allow access to adult-only area
        server.MovePlayerToScene(player, adultScene)
    else
        print("Age verification required for this area")
    end
    
    -- Filter chat for non-verified users
    if not player.user.isAgeVerifiedAbove18 then
        -- Apply stricter chat filters
    end
    

    isSubscriber

    boolean
    ClientAndServer
    ReadOnly

    True if the user has an active Highrise+ subscription. Use this to provide exclusive features or rewards for subscribers.

    if player.user.isSubscriber then
        print(player.name .. " is a Highrise+ subscriber!")
        -- Grant subscriber perks
        local transaction = InventoryTransaction.new()
        transaction:GivePlayer(player, "subscriber_badge", 1)
        Inventory.CommitTransaction(transaction)
    else
        print(player.name .. " is not a subscriber")
    end
    

    name

    string
    ClientAndServer
    ReadOnly

    The display name of the user as it appears in Highrise. This is the same as player.name for convenience.

    local userName = player.user.name
    print("Welcome, " .. userName .. "!")
    
    -- Note: player.name is a shortcut for player.user.name
    print(player.name == player.user.name) -- true
    

    Updated 19 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.