Donut Team is a labor of love, built and maintained by a small group of passionate developers. We invest our own time and resources to offer our tools, mods, and web services completely free of charge.

We don't run ads, and we will never sell your data - period.

If you've enjoyed anything we've created, please consider supporting our work with a one-time or monthly donation via our Ko-fi page . Every contribution helps us continue building great experiences for the community.

Dismiss
  • Modding Tools
  • Simpsons Hit & Run Multiplayer Server
  • Lua API Reference
  • Server Functions
  • Server.Players Functions

Server.Players.GetPlayer

Available since Version 1.0.

Finds and returns a single player by name and discriminator. Can be called with a combined PlayerName#Discriminator string, or with the name and discriminator as two separate arguments.

Syntax

Server.Players.GetPlayer( nameAndDiscriminator )
Server.Players.GetPlayer( name, discriminator )

Arguments

  • nameAndDiscriminator (string): The player's full identifier in the form PlayerName#Discriminator.

or

  • name (string): The player's name.
  • discriminator (string): The player's discriminator.

Return Values

  • (Player): The matching Player object if found.
  • (boolean, string): Returns false and an error message string if the arguments are invalid or no matching player is found.

Examples

local ok, result = Server.Players.GetPlayer("Homer#1234")
if ok then
    print(result.Name)
else
    print("Error: " .. result)
end

local ok2, result2 = Server.Players.GetPlayer("Homer", "1234")
if ok2 then
    print(result2.Name)
else
    print("Error: " .. result2)
end