Mirroristas/rathena
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Converted remaining C comments (#3927)

Browse Source 
* Converted remaining documentation that references .c or .h files.
This commit is contained in:
Aleos
2019-02-09 15:08:45 -05:00
committed by GitHub
parent 35611e78e1
commit c5a5c54518
52 changed files with 94 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/atcommands.txt
View File

@@ -14,7 +14,7 @@ This file describes the usage of in-game commands and assumes that
charcommand_symbol: "#"
Some commands cannot be used from console or script command to prevent map-server crashed.
See atcommand.c::atcommand_basecommands for restricted commands. Please tell us if any
See atcommand.cpp::atcommand_basecommands for restricted commands. Please tell us if any
other atcommand that causes map-server crashed executed by console or script commands.
To search for a command, write "@" before the command name (ex. @commands).
@@ -811,7 +811,7 @@ If no coordinates are entered, a random location will be chosen.
Warps to predefined locations in major cities.
If no ID is given, all available maps will be displayed in the chat window.
Locations and coordinates are stored in '/src/map/atcommand.c'.
Locations and coordinates are stored in '/src/map/atcommand.cpp'.
Restriction:
- Used from console
@@ -1143,7 +1143,7 @@ Give or remove a cart to a player and also change the cart skin based on ID:
Changes the language attached to the player's account (#langtype).
If no parameter is given, a list of available languages is displayed.
All languages are defined in '/src/common/msg_conf.h'.
All languages are defined in '/src/common/msg_conf.hpp'.
---------------------------------------

2
doc/ea_job_system.txt
View File

@@ -13,7 +13,7 @@ Preface:
-------------------------------------------------------------------------------
Most scripters are aware of the class values used in RO and their constants
specified in src/map/script_constants.h. Each class has a number associated
specified in src/map/script_constants.hpp. Each class has a number associated
to it for referencing, so when someone's class is 9 that means they are a
wizard. However, this list of job numbers has no real order behind it, and
no logic behind it's assignation.

4
doc/item_group.txt
View File

@@ -38,7 +38,7 @@ The table below explains which fields are accessed in each.
---------------------------------------
GroupID: See the "Item Group ID" section in 'src/map/itemdb.h' and the "item groups" section in 'src/map/script_constants.h'.
GroupID: See the "Item Group ID" section in 'src/map/itemdb.hpp' and the "item groups" section in 'src/map/script_constants.hpp'.
Supports IG_* constants.
---------------------------------------
@@ -65,7 +65,7 @@ Amount: Amount of item that will be obtained.
Random: Set this to '0' and the item will always be obtained ("must" item).
Random value will allocates where the item will be stored at random group.
(max. random group is 4, defined as MAX_ITEMGROUP_RANDGROUP in 'src/map/itemdb.c'.)
(max. random group is 4, defined as MAX_ITEMGROUP_RANDGROUP in 'src/map/itemdb.cpp'.)
Item Group:
IG_MyItemGroup,Knife,0,1,0 //a "must" item

4
doc/packet_interserv.txt
View File

@@ -24,7 +24,7 @@ The format of this file is as follows:
============
| 1. Notes |
============
Currently the max packet size is 0xFFFF (see 'WFIFOSET()' in 'src/common/socket.c').
Currently the max packet size is 0xFFFF (see 'WFIFOSET()' in 'src/common/socket.cpp').
=========================
| 2. Login-Char Packets |
@@ -520,7 +520,7 @@ Currently the max packet size is 0xFFFF (see 'WFIFOSET()' in 'src/common/socket.
len: 7
parameter:
- cmd : packet identification (0x3002)
- id: whisper id, identifier to match current whisper session that store in inter.c::wis_db
- id: whisper id, identifier to match current whisper session that store in inter.cpp::wis_db
- flag: 0=success, 1=target not found, 2=ignored by target
desc:
- Inform the char-server of the result of the whisper

36
doc/script_commands.txt
View File

@@ -521,7 +521,7 @@ forever, and no trace remains of it even if it was stored with character or
account data.
Some variables are special, that is, they are already defined for you by the
scripting engine. You can see the full list in 'src/map/script_constants.h', which
scripting engine. You can see the full list in 'src/map/script_constants.hpp', which
is a file you should read, since it also allows you to replace lots of numbered
arguments for many commands with easier to read text. The special variables most
commonly used are all permanent character-based variables:
@@ -565,7 +565,7 @@ setting it will make the character own this number of Zeny.
If you try to set Zeny to a negative number, the script will be terminated with an error.
Some source-end constants can also be accessed in scripts. This list is located in
'src/map/script_constants.h', which contains constants such as server defines and status options:
'src/map/script_constants.hpp', which contains constants such as server defines and status options:
PACKETVER, MAX_LEVEL, MAX_STORAGE, MAX_INVENTORY, MAX_CART, MAX_ZENY, MAX_PARTY,
MAX_GUILD, MAX_GUILDLEVEL, MAX_GUILD_STORAGE, MAX_BG_MEMBERS, MAX_CHAT_USERS,
@@ -1002,7 +1002,7 @@ and called label is in NPC that has trigger area, that label must end with
"Global" to work globally (i.e. if RID is outside of the trigger area, which
usually happens since otherwise there would be no point calling the label with
doevent, because OnTouch would do the job). For further reference look for
npc_event in npc.c.
npc_event in npc.cpp.
Scripting commands and functions
--------------------------------
@@ -2391,7 +2391,7 @@ Also useful when passing arrays to functions or accessing another npc's arrays:
This function will return the specified stat of the invoking character, or, if a
character name or character id is specified, of that player. The stat can either
be a number or parameter name, defined in 'src/map/script_constants.h'.
be a number or parameter name, defined in 'src/map/script_constants.hpp'.
Some example parameters:
@@ -3747,7 +3747,7 @@ list (cloak, cart, ruwach, etc). if flag is 1 (default when omitted),
the option will be added to what the character currently has; if 0, the option is removed.
This is definitely not a complete list of available option flag numbers. Ask a
core developer (or read the source: src/map/status.h) for the full list.
core developer (or read the source: src/map/status.hpp) for the full list.
---------------------------------------
@@ -3921,7 +3921,7 @@ more:
*checkre(<type>)
Checks if a renewal feature is enabled or not in renewal.h, and returns 1 if
Checks if a renewal feature is enabled or not in renewal.hpp, and returns 1 if
enabled and 0 for disabled.
The renewal feature to check is determined by type.
@@ -4283,7 +4283,7 @@ This command will change the job class of the invoking character.
This command does work with numbers, but you can also use job names. The full
list of job names and the numbers they correspond to can be found in
'src/map/script_constants.h'.
'src/map/script_constants.hpp'.
// This would change your player into a Swordman
jobchange Job_Swordman;
@@ -4509,7 +4509,7 @@ you can look at: 'npc/custom/stylist.txt'
This command will push the currently attached player to given direction by given
amount of square cells. Direction is the same as used when declaring NPCs, and
can be specified by using one of the DIR_* constants (src/map/script_constants.h).
can be specified by using one of the DIR_* constants (src/map/script_constants.hpp).
The knock-back is not restricted by items or map flags, only obstacles are taken
into account. If there is not enough space to perform the push (e.g. due to a
@@ -5634,8 +5634,8 @@ Used in reset NPC's (duh!)
These commands will bestow a status effect on a character.
The <effect type> determines which status is invoked. This can be either a number
or constant, with the common statuses (mostly negative) found in 'src/map/script_constants.h'
with the 'SC_' prefix. A full list is located in 'src/map/status.h', though
or constant, with the common statuses (mostly negative) found in 'src/map/script_constants.hpp'
with the 'SC_' prefix. A full list is located in 'src/map/status.hpp', though
they are not currently documented.
The duration of the status is given in <ticks>, or milleseconds.
@@ -5920,7 +5920,7 @@ Types:
1: Buff
2: Debuff
Status_icon: See "Status Icon" section in 'src/map/script_constants.h'. Default is SI_BLANK (-1).
Status_icon: See "Status Icon" section in 'src/map/script_constants.hpp'. Default is SI_BLANK (-1).
Example:
// Apple gives you +5 Str bonus for 1 minute when it's consumed.
@@ -6756,7 +6756,7 @@ This command will broadcast a message to all or most players, similar to
The region the broadcast is heard in (target), source of the broadcast
and the color the message will come up as is determined by the flags.
The flag values are coded as constants in 'src/map/script_constants.h' to make them easier to use.
The flag values are coded as constants in 'src/map/script_constants.hpp' to make them easier to use.
Target flags:
- bc_all: Broadcast message is sent server-wide (default).
@@ -7514,7 +7514,7 @@ must be used.
This command makes an object display an emotion sprite above their own as
if they were doing that emotion. For a full list of emotion numbers,
see 'src/map/script_constants.h' under 'ET_'. The not so obvious ones are 'ET_QUESTION'
see 'src/map/script_constants.pph' under 'ET_'. The not so obvious ones are 'ET_QUESTION'
(a question mark) and 'ET_SURPRISE' (the exclamation mark).
The optional target parameter specifies who will get the emotion on top of
@@ -8120,7 +8120,7 @@ Parameter (indexes) for NPCs are:
*Notes:
- *_SIZE: small (0); medium (1); large (2)
- *_MAPID: this refers to the map_data index (from src/map/map.c), not the mapindex_db index (from src/common/mapindex.c)
- *_MAPID: this refers to the map_data index (from src/map/map.cpp), not the mapindex_db index (from src/common/mapindex.cpp)
-- For 'setunitdata', map name can also be passed in as a valid value instead of map ID
- *_SPEED: 20 - 1000
- *_MODE: see doc/mob_db_mode_list.txt
@@ -8707,7 +8707,7 @@ Each of these can be 'on' or 'off'. Together they define a cell's behavior.
This command lets you alter these flags for all map cells in the specified
(x1,y1)-(x2,y2) rectangle. The 'flag' can be 0 or 1 (0:clear flag, 1:set flag).
The 'type' defines which flag to modify. Possible options see 'src/map/script_constants.h'.
The 'type' defines which flag to modify. Possible options see 'src/map/script_constants.hpp'.
Example:
@@ -8741,7 +8741,7 @@ remove a nonwalkable row of cells after the barricade mobs.
This command will return 1 or 0, depending on whether the specified cell has
the 'type' flag set or not. There are various types to check, all mimicking
the server's cell_chk enumeration. The types can be found in 'src/map/script_constants.h'.
the server's cell_chk enumeration. The types can be found in 'src/map/script_constants.hpp'.
The meaning of the individual types can be confusing, so here's an overview:
- cell_chkwall/water/cliff
@@ -9462,7 +9462,7 @@ NOTE: Currently ONLY supported for bonuses that used by 'bonus' script.
This command will make the pet cure a specified status condition. The curing
actions will occur once every Delay seconds. For a full list of status
conditions that can be cured, see the list of 'SC_' status condition constants
in 'src/map/script_constants.h'.
in 'src/map/script_constants.hpp'.
---------------------------------------
@@ -9946,7 +9946,7 @@ solution rather than sending the map and the monster_id.
This will set a Hat Effect onto the player. The state field allows you to
enable (true) or disable (false) the effect on the player.
The Hat Effect constants can be found in 'src/map/script_constants.h' starting
The Hat Effect constants can be found in 'src/map/script_constants.hpp' starting
with HAT_EF_*.
Requires client 2015-05-13aRagEXE or newer.

8
doc/skill_require_db.txt
View File

@@ -128,8 +128,8 @@ RequiredStatuses: The active statuses needed to use the skill.
Up to 3 ':'-separated values can be used, e.g.
SC_STATUS1:SC_STATUS2:SC_STATUS3
See MAX_SKILL_STATUS_REQUIRE in 'src/map/skill.h' to modify the max number
of possible values, and 'db/const.txt' for a list of status constants.
See MAX_SKILL_STATUS_REQUIRE in 'src/map/skill.hpp' to modify the max number
of possible values, and 'src/map/script_constants.hpp' for a list of status constants.
Use any number or SC_ALL to disable status requirements.
@@ -153,11 +153,11 @@ RequiredEquipment: Specific equipment IDs needed to use the skill.
Up to 10 ':'-separated values can be used, e.g.
item1:item2:item3
See MAX_SKILL_EQUIP_REQUIRE in 'src/map/skill.h' to modify the max number
See MAX_SKILL_EQUIP_REQUIRE in 'src/map/skill.hpp' to modify the max number
of possible values.
---------------------------------------
NOTE: On some fields, the ':' delimiter means for each skill level, but there
are some level dependent checks. See 'skill_get_requirement()' in
'src/map/skill.c'.
'src/map/skill.cpp'.

20
doc/source_doc.txt
View File

@@ -191,17 +191,17 @@ The following list describes each module and its purpose.
malloc handles runtime memory allocation (so that memory manager could check for leaks)
mapindex handles the processing and reading of the mapcache.dat
md5calc offers md5 encryption
mmo.h common structures and defines across serv
mmo.hpp common structures and defines across serv
msg_conf handles msg in src from configuration
nullpo checks and dumps info for debug mode
random generation of random numbers
showmsg display messages in console with a certain color
socket handling of sockets (listening, close, open, etc.)
sql.c MySQL database proxy
strlib.c string handling
timer.c timer-related functions
utils.c misc functions
winapi.h Windows redefine and include
sql.cpp MySQL database proxy
strlib.cpp string handling
timer.cpp timer-related functions
utils.cpp misc functions
winapi.hpp Windows redefine and include
==============
| Login-serv |
@@ -265,7 +265,7 @@ The following list describes each module and its purpose.
guild functions for the guild system
homunculus functions for Alchemist Homunculi processing (create, delete, get stats, death, etc.)
instance functions for instance system
intif map-serv <=> inter-serv interface (meant to communicate with 'char/inter.c' or its submodules)
intif map-serv <=> inter-serv interface (meant to communicate with 'char/inter.cpp' or its submodules)
itemdb functions for the item database
log functions for server log system
mail functions for mail system
@@ -286,7 +286,7 @@ The following list describes each module and its purpose.
searchstore functions for the Vendor Shop Search feature
skill functions for skills (skill_casttime calculation, skill behaviours, skill_chk_cast, requirement checks, 'db/skill_*.txt' processing)
status functions for statuses on a bl (add, remove, calculation of effects as a temporary bonus)
status is a struct available by most units as common attributes (bl_type only attribute are dealt in bl specific files, like 'pc.c' or 'mob.c')
status is a struct available by most units as common attributes (bl_type only attribute are dealt in bl specific files, like 'pc.cpp' or 'mob.cpp')
storage functions for the storage system: Kafra, cart, guild, inventory (add, transfer, remove items between containers)
also ensures container mutex (e.g. guild_storage) and preparation for save requests
trade functions to perform a trade (request, accept, add items/Zeny, checks, complete trade)
@@ -300,7 +300,7 @@ The following are standard naming conventions used by rAthena.
Type Prefix Example
---- ------ -------
function module_ pc_addspiritball -> located in pc.c file
function module_ pc_addspiritball -> located in pc.cpp file
structure s_ s_quest_db
enum e_ e_race
status SC_ SC_INTOABYSS
@@ -347,7 +347,7 @@ The following variables are commonly used in the source code.
===============
| 8. Building |
===============
When adding a new src file or library (new.c and its header, new.h), you'll also
When adding a new src file or library (new.cpp and its header, new.hpp), you'll also
need to update the following files to fully integrate it into the project so that
users can compile it.