summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMurilo Pereti Tavares <murilopereti@gmail.com>2018-01-25 01:15:08 -0200
committerMurilo Pereti Tavares <murilopereti@gmail.com>2018-01-25 01:15:08 -0200
commitfc1684c82d92de81e5688e33a8386cde3c2407db (patch)
treecb6af3fd8e9f940cc4cb9f2181e78c2dc751d203 /doc
parent33982166de006d777aa2d95a9d95b2778db1c65a (diff)
downloadhercules-fc1684c82d92de81e5688e33a8386cde3c2407db.tar.gz
hercules-fc1684c82d92de81e5688e33a8386cde3c2407db.tar.bz2
hercules-fc1684c82d92de81e5688e33a8386cde3c2407db.tar.xz
hercules-fc1684c82d92de81e5688e33a8386cde3c2407db.zip
Implementation of Official Clan System
All official features work including the autokick for inactive members And the system is completely customizable.
Diffstat (limited to 'doc')
-rw-r--r--doc/atcommands.txt37
-rw-r--r--doc/script_commands.txt36
2 files changed, 73 insertions, 0 deletions
diff --git a/doc/atcommands.txt b/doc/atcommands.txt
index fdafb6c90..18d3de4e4 100644
--- a/doc/atcommands.txt
+++ b/doc/atcommands.txt
@@ -1455,3 +1455,40 @@ Sets the intimacy level of your homunculus, with 1000 being "Loyal".
Sets the hunger level of your homunculus, with 100 being "Stuffed".
---------------------------------------
+
+@cvcon
+
+Set the mapflag cvc on the map (Turn on Clans vs Clans mode)
+
+---------------------------------------
+
+@cvcoff
+
+Unset the mapflag cvc on the map (Turn off Clans vs Clans mode)
+
+---------------------------------------
+
+@claninfo
+
+Lists all informations of all clans
+
+---------------------------------------
+
+@joinclan <ClanID>
+
+Joins the Clan with the given ID if it exists.
+
+---------------------------------------
+
+@leaveclan
+
+Leaves the Clan if any.
+
+---------------------------------------
+
+@reloadclans
+
+Reloads the 'conf/clans.conf' file.
+Obs: it will reload 'db/clans.conf' too since it's included inside 'conf/clans.conf'
+
+---------------------------------------
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index a91a212e7..e14e80444 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -2381,6 +2381,7 @@ the invoking character. Whatever it returns is determined by type.
(1) PC_PARTY - The name of the party they're in if any.
(2) PC_GUILD - The name of the guild they're in if any.
(3) PC_MAP - The name of the map the character is in.
+(4) PC_CLAN - The name of the clan they're in if any.
If <GID> is passed, it will return the value of the specified player instead
the attached player. If the player is not found, it will return
@@ -2522,6 +2523,7 @@ Type is the kind of associated ID number required:
(2) CHAR_ID_GUILD - Guild ID number.
(3) CHAR_ID_ACCOUNT - Account ID number.
(4) CHAR_ID_BG - Battle ground ID
+(5) CHAR_ID_CLAN - Clan ID number.
For most purposes other than printing it, a number is better to have than
a name (people do horrifying things to their character names).
@@ -9952,3 +9954,37 @@ Changes the name of a unit.
Supported Types - [ MOB | HOM | PET ].
returns 1 on success, 0 on failure.
+
+---------------------------------------
+//=====================================
+13 - Clan System Related Commands
+//=====================================
+---------------------------------------
+
+*join_clan(<ClanID>{,<RID>})
+
+Joins a player into the given clan.
+If no RID is given, will run with the current attached player.
+
+returns true on success, false on failure.
+
+---------------------------------------
+
+*clan_leave({<RID>})
+
+Removes a player from its clan.
+If no RID is given, will run with the current attached player.
+
+returns true on success, false on failure.
+
+---------------------------------------
+
+*clan_master(<ClanID>)
+
+Enables the Emblem of the given Clan to the current NPC
+
+---------------------------------------
+//=====================================
+13 - End of Clan System Related Commands
+//=====================================
+--------------------------------------- \ No newline at end of file