ScriptClan

This class corresponds to a clan within the game and provides information related to the specific clan.

Method

form	explanation
DateTime createdAt { get; }	This is when the clan was created.
long id { get; }	This is the unique ID of the clan.
long masterPlayerID { get; }	This is the ID of the clan master player.
long[] memberIDs { get; }	Gets the IDs of all members of the clan in array format.
Table customData { get; set; }	This is the clan's custom data.
string name { get; }	The unique name of the clan.

Function

form	explanation
string GetMemberName(long id)	Get the name of the user whose ID is id among the clan members.
void Invalidate()	Update clan information.

Example

Print when the clan was created

local myClan = unit.player.clan; 
print(myClan.createdAt.ToLocalTime());

Print out the clan ID

local myClan = unit.player.clan; 
print(myClan.id);

Print all clan members' IDs

local memberIDs = unit.player.clan.memberIDs;

for i = 0, #memberIDs do
  print(memberIDs[i]);
end

Print the clan name

local myClan = unit.player.clan;
print(myClan.name);