builtin clan member - boyism80/fb GitHub Wiki

Built-in Functions Documentation (Clan Member)

This document describes functions available to clan member type objects.

• name
• position

---

name

name()

• Description:
  Returns the name of the clan member.
• Parameters:
  • None
• Return Value:
  • string: Member name
• Example:

  -- This is a real usage example from game scripts
  local clan = me:clan()
  if clan then
      for _, member in pairs(clan:members()) do
          me:message("Clan member: " .. member:name())
      end
  end
  

---

position

position()

• Description:
  Returns the position/rank of the clan member within the clan hierarchy.
• Parameters:
  • None
• Return Value:
  • number: Member position/rank value
• Example:

  -- This is a real usage example from game scripts
  local clan = me:clan()
  if clan then
      for _, member in pairs(clan:members()) do
          local member_position = member:position()
          me:message(member:name() .. " has position: " .. member_position)
      end
  end