Unreal Engine — Players

Players

Calls shown via the official C++ SDK (compiled into your UE module). Blueprint projects: same endpoints over FHttpModule/VaRest — see Getting Started.

registerPlayer
players::Players::registerPlayer(client, name, playerData?)

Registers a player. Returns playerId, privateKey (player credential — persist via FSaveGame/config) and playerTag.

authenticatePlayer
players::Players::authenticatePlayer(client, playerToken)

Authenticates a player by token — returns profile + data.

sendPlayerHeartbeat
players::Players::sendPlayerHeartbeat(client, playerToken)

Keeps the player online — call on a timer during the session.

logoutPlayer
players::Players::logoutPlayer(client, playerToken)

Ends the session cleanly.

renamePlayer
players::Players::renamePlayer(client, playerToken, newName)

Renames the player; validated against the game's name rules server-side.

rotatePlayerKey
players::Players::rotatePlayerKey(client, playerToken)

Rotates the credential — store the new privateKey.

getAllPlayers (admin)
Games::getAllPlayers(client)

Lists all players. Requires the private token — server-only.

banPlayer / unbanPlayer (admin)
players::Players::banPlayer(client, playerId, duration?, reason?)
players::Players::unbanPlayer(client, playerId)

Timed/permanent bans — admin scope.

getPlayerData / updatePlayerData
players::Players::getPlayerData(client, playerToken)
players::Players::updatePlayerData(client, playerToken, data)

Per-player JSON storage — stats, unlocks, progression. Leaderboards rank these fields.