View source for GetPlayerGuild

<!-- This page is generated automatically from the function definition: getPlayerGuild. -->
= getPlayerGuild =
Returns a player's authoritative guild key.

== Syntax ==
<syntaxhighlight lang="lua">
string getPlayerGuild(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to inspect.
|}

== Returns ==
Returns the guild key, or <code>false</code> if the player is invalid.

== Examples ==
Display a player's guild:
<syntaxhighlight lang="lua" line>
local guild = getPlayerGuild(playerId)
if guild then
    outputChatBox("Guild: " .. guild, playerId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]