From 4577aba6e310cb1255123af46cff707e56db4b4b Mon Sep 17 00:00:00 2001 From: Andrei Karas Date: Mon, 23 Oct 2017 17:51:25 +0300 Subject: Update documentation from hercules. --- server/scripts/constants.md | 21 +++++++++++++- server/scripts/script_commands.txt | 56 ++++++++++++++++++++++++++++++++++---- 2 files changed, 71 insertions(+), 6 deletions(-) diff --git a/server/scripts/constants.md b/server/scripts/constants.md index 97dffcc..98c22bb 100644 --- a/server/scripts/constants.md +++ b/server/scripts/constants.md @@ -358,7 +358,8 @@ - `mf_reset`: 52 - `mf_notomb`: 53 - `mf_nocashshop`: 54 -- `mf_noviewid`: 55 +- `mf_noautoloot`: 55 +- `mf_noviewid`: 56 ### Cell Properties @@ -4004,6 +4005,11 @@ - `DATATYPE_VAR`: 4096 - `DATATYPE_LABEL`: 8192 +### Logmes types + +- `LOGMES_NPC`: 0 +- `LOGMES_ATCOMMAND`: 1 + ### Item Subtypes (Weapon types) - `W_FIST`: 0 @@ -4054,6 +4060,19 @@ - `ITEMUPPER_THIRDBABY`: 32 - `ITEMUPPER_ALL`: 63 +### dressroom modes + +- `DRESSROOM_OPEN`: 1 +- `DRESSROOM_CLOSE`: 0 + +### getmapinfo options + +- `MAPINFO_NAME`: 0 +- `MAPINFO_ID`: 1 +- `MAPINFO_SIZE_X`: 2 +- `MAPINFO_SIZE_Y`: 3 +- `MAPINFO_ZONE`: 4 + ### Renewal - `RENEWAL`: 1 diff --git a/server/scripts/script_commands.txt b/server/scripts/script_commands.txt index c9bdce7..5c73010 100644 --- a/server/scripts/script_commands.txt +++ b/server/scripts/script_commands.txt @@ -3305,6 +3305,27 @@ Notice that NPC objects disabled with disablenpc() will still be located. --------------------------------------- +*getmapinfo({, ""}) +*getmapinfo({, }) + +This command returns various information about a specific map. If the second +argument is omitted, it will try to use the map of the attached NPC, or the +map of the attached player if the NPC can't be found. + +Valid are: + MAPINFO_NAME name of the map + MAPINFO_ID numeric ID of the map + MAPINFO_ZONE name of the zone used by the map + MAPINFO_SIZE_X width of the map (cells on the x axis) + MAPINFO_SIZE_Y height of the map (cells on the y axis) + +Examples: + getmapinfo(MAPINFO_ID, "map name"); // ID from name + getmapinfo(MAPINFO_NAME, 3); // name from ID + getmapinfo(MAPINFO_ZONE); // zone, ie Normal, PvP, Jail, ... + +--------------------------------------- + *getunits(, , , ""{, , , , }) This function searches a whole map or area for units and adds their GID to @@ -5621,6 +5642,23 @@ character. openauction(); end; +--------------------------------------- + +*dressroom({}) + +This command controls the dressing room for the attached player. If no +is passed, DRESSROOM_OPEN is used by default. + +Valid for dressroom() are: + DRESSROOM_OPEN opens the dressing room window + DRESSROOM_CLOSE closes the dressing room window + +Example: + mes("Close this window to open the Dress Room window."); + close2(); + dressroom(DRESSROOM_OPEN); + end; + --------------------------------------- //===================================== 4.2 - Guild-Related Commands @@ -7489,13 +7527,21 @@ window). It will not be displayed anywhere else. debugmes("\033[38D\033[K ==Message== \n"); // enable colour code. --------------------------------------- -*logmes("") +*logmes(""{, }) + +This command will write the message given to the map server log files, as +specified in 'conf/map/logs.conf'. If SQL logging is enabled, the message will +go to the specified log table. If logs are not enabled, nothing will happen. + +Log types are: -This command will write the message given to the map server NPC log file, -as specified in 'conf/map/logs.conf'. If SQL logging is enabled, the message -will go to the 'npclog' table. +LOGMES_NPC - log to the 'npclog' table (Default) +LOGMES_ATCOMMAND - log to the 'atcommandlog' table + +Example: -If logs are not enabled for NPCs, nothing will happen. + logmes("foobar"); + logmes("foobar", LOGMES_ATCOMMAND); --------------------------------------- -- cgit v1.2.3-60-g2f50