Metatable:Guild - novasdream/forgottenserver GitHub Wiki

No description available at the moment. ###Available methods: addMember(player)
[addRank(id, name, level)](#addRank{id, name, level})
getId()
getMembersOnline()
getMotd()
getName()
getRankById(id)
getRankByLevel(level)
removeMember(player)
setMotd(motd)

---

###### addMember(player) > **Description:** N/A > **Parameters:**

• _player_ - _No description_

> **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:addMember(some_userdata) ``` > **Added in version:** 1.0

---

###### addRank(id, name, level) > **Description:** N/A > **Parameters:**

• _id_ - _No description_
• _name_ - _No description_
• _level_ - _No description_

> **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:addRank(some_id, some_name, 1) ``` > **Added in version:** 1.0

---

###### getId() > **Description:** N/A > **Parameters:** None > **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:getId() ``` > **Added in version:** 1.0

---

###### getMembersOnline() > **Description:** N/A > **Parameters:** None > **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:getMembersOnline() ``` > **Added in version:** 1.0

---

###### getMotd() > **Description:** N/A > **Parameters:** None > **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:getMotd() ``` > **Added in version:** 1.0

---

###### getName() > **Description:** N/A > **Parameters:** None > **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:getName() ``` > **Added in version:** 1.0

---

###### getRankById(id) > **Description:** N/A > **Parameters:**

• _id_ - _No description_

> **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:getRankById(some_id) ``` > **Added in version:** 1.0

---

###### getRankByLevel(level) > **Description:** N/A > **Parameters:**

• _level_ - _No description_

> **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:getRankByLevel(1) ``` > **Added in version:** 1.0

---

###### removeMember(player) > **Description:** N/A > **Parameters:**

• _player_ - _No description_

> **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:removeMember(some_userdata) ``` > **Added in version:** 1.0

---

###### setMotd(motd) > **Description:** N/A > **Parameters:**

• _motd_ - _No description_

> **Returns:** N/A > **Example:** ```Lua local guild = Guild(...) guild:setMotd(any_string) ``` > **Added in version:** 1.0