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
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
52 changed files with 94 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -71,7 +71,6 @@ Thumbs.db
/src/common/Makefile
/src/common/obj_all
/src/common/obj_sql
/src/common/svnversion.h
# /src/custom/
/src/custom
@ -83,7 +82,7 @@ Thumbs.db
# /src/map/
/src/map/Makefile
/src/map/obj_sql
/src/map/pcre.h
/src/map/pcre.hpp
# /src/tool/
/src/tool/Makefile

2
conf/battle/gm.conf
View File

@ -24,7 +24,7 @@ partial_name_scan: yes
// Duration of the ban, in minutes (default: 5). To disable the ban, set 0.
ban_hack_trade: 5
// requires RENEWAL_EXP or RENEWAL_DROP to be enabled (src/config/renewal.h)
// requires RENEWAL_EXP or RENEWAL_DROP to be enabled (src/config/renewal.hpp)
// modifies @mobinfo to display the users' real drop rate as per renewal_drop formula
// modifies @iteminfo to not display the minimum item drop rate (since it can't tell the mob level)
// modifies @whodrops to display the users' real drop rate as per renewal_drop formula

2
conf/battle/misc.conf
View File

@ -99,7 +99,7 @@ duel_only_on_same_map: no
// Set to 0 for no cell stacking checks and free movement.
// Custom - This variation will make every full cell to be considered a wall.
// NOTE: For the custom setting to take effect you have to use a server compiled
// with Cell Stack Limit support (see src/map/map.h)
// with Cell Stack Limit support (see src/map/map.hpp)
official_cell_stack_limit: 1
custom_cell_stack_limit: 1

4
conf/char_athena.conf
View File

@ -109,7 +109,7 @@ save_log: yes
// Starting point for new characters
// Format: <map_name>,<x>,<y>{:<map_name>,<x>,<y>...}
// Max number of start points is MAX_STARTPOINT in char.h (default 5)
// Max number of start points is MAX_STARTPOINT in char.hpp (default 5)
// Location is randomly picked on character creation.
// NOTE: For Doram, this requires client 20151001 or newer.
start_point: iz_int,18,26:iz_int01,18,26:iz_int02,18,26:iz_int03,18,26:iz_int04,18,26
@ -117,7 +117,7 @@ start_point_pre: new_1-1,53,111:new_2-1,53,111:new_3-1,53,111:new_4-1,53,111:new
start_point_doram: lasa_fild01,48,297
// Starting items for new characters
// Max number of items is MAX_STARTITEM in char.c (default 32)
// Max number of items is MAX_STARTITEM in char.cpp (default 32)
// Format: <id>,<amount>,<position>{:<id>,<amount>,<position>...}
// To auto-equip an item, include the position where it will be equipped; otherwise, use zero.
// NOTE: For Doram, this requires client 20151001 or newer.

2
conf/login_athena.conf
View File

@ -89,7 +89,7 @@ min_group_id_to_connect: -1
vip_group: 5
// How many characters are allowed per account?
// You cannot exceed the limit of MAX_CHARS slots, defined in mmo.h, or chars_per_account
// You cannot exceed the limit of MAX_CHARS slots, defined in mmo.hpp, or chars_per_account
// will default to MAX_CHARS.
// 0 will default to the value of MIN_CHARS. (default)
chars_per_account: 0

2
conf/motd.txt
View File

@ -1,2 +1,2 @@
// Internal default is limited to 128 lines. If you need more, you will need to modify the MOTD_LINE_SIZE definition in pc.c
// Internal default is limited to 128 lines. If you need more, you will need to modify the MOTD_LINE_SIZE definition in pc.cpp
Welcome to rAthena! Enjoy! Please report any bugs you find.

2
conf/msg_conf/map_msg.conf
View File

@ -1556,7 +1556,7 @@
1391: You do not possess a cart to be removed
1392: Cart Added.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: You can't use commands while dead.
// @clearstorage

2
conf/msg_conf/map_msg_chn.conf
View File

@ -1373,7 +1373,7 @@
1391: You do not possess a cart to be removed
1392: Cart Added.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: 角色死亡時不能使用指令。
// @clearstorage

2
conf/msg_conf/map_msg_frn.conf
View File

@ -1386,7 +1386,7 @@
1391: Vous ne possédez pas de chariot.
1392: Chariot ajouté.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: Les morts ne pouvent pas utiliser de commande.
// @clearstorage

2
conf/msg_conf/map_msg_idn.conf
View File

@ -1477,7 +1477,7 @@
1391: Kamu tidak memiliki keranjang yang akan dihapus.
1392: Gerobak ditambahkan.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: Kamu tidak bisa menggunakan perintah ini ketika mati.
// @clearstorage

2
conf/msg_conf/map_msg_por.conf
View File

@ -1556,7 +1556,7 @@
1391: Você não possui um carrinho para remover
1392: Carrinho Adicionado.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: Você não pode utilizar comandos caso esteja morto.
// @clearstorage

2
conf/msg_conf/map_msg_rus.conf
View File

@ -1386,7 +1386,7 @@
1391: У вас нет телеги.
1392: Телега добавлена.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: Вы не можете использовать команды когда мертвы.
// @clearstorage

2
conf/msg_conf/map_msg_spn.conf
View File

@ -1527,7 +1527,7 @@
1391: No tienes ningún carro.
1392: Ahora tienes un carro.
// atccomand.c::is_atcommand
// atccomand.cpp::is_atcommand
1393: No puedes utilizar ningún comando porque estás muerto.
// @clearstorage

2
conf/msg_conf/map_msg_tha.conf
View File

@ -1379,7 +1379,7 @@
1391: へ充凌琳枚啖绻氛瑷信和汀.
1392: 翟吹验<E590B9>多㈢灌谜潞瞄吐.
// atcommand.c::is_atcommand
// atcommand.cpp::is_atcommand
1393: へ充凌室烈枚悛椁邮谚т撮愎⒊械衣吐罔.
// @clearstorage

2
configure vendored
View File

@ -1339,7 +1339,7 @@ Optional Features:
--enable-FEATURE[=ARG] include FEATURE [ARG=yes]
--enable-manager=ARG memory managers: no, builtin, memwatch, dmalloc,
gcollect, bcheck (defaults to builtin)
--enable-packetver=ARG Sets the PACKETVER define. (see src/common/mmo.h)
--enable-packetver=ARG Sets the PACKETVER define. (see src/common/mmo.hpp)
--enable-epoll use epoll(4) on Linux
--enable-debug[=ARG] Compiles extra debug code. (disabled by default)
(available options: yes, no, gdb)

2
db/mob_item_ratio.txt
View File

@ -18,7 +18,7 @@
//
// Notes:
// - By default you can list up to 10 MonsterIDs per ItemID.
// It can be changed in src/map/mob.c by adjusting MAX_ITEMRATIO_MOBS.
// It can be changed in src/map/mob.cpp by adjusting MAX_ITEMRATIO_MOBS.
// - Only ItemIDs up to MAX_ITEMDB are supported (default: 32768).
// - Does not override item_drop_*_min/max settings.
// - Does not affect card/item-granted drops. To adjust card/item-granted

2
db/pre-re/item_delay.txt
View File

@ -16,7 +16,7 @@
// 12659 cannot be used when this delay is active.
// Since this is optional, default is -1 will ignores the
// delay group and the delay will be stored in character's
// data that has limit set in src/map/itemdb.h as MAX_ITEMDELAYS.
// data that has limit set in src/map/itemdb.hpp as MAX_ITEMDELAYS.
// SC_REUSE_LIMIT_A
14538,300000,SC_REUSE_LIMIT_A //Glass_Of_Illusion

4
db/pre-re/skill_require_db.txt
View File

@ -26,11 +26,11 @@
// 'RequiredStatuses'
// Fill the value only with SC_STATUS (see db/const.txt for more details)
// Usage for multiple status requirements: SC_STATUS1:SC_STATUS2:SC_STATUS3
// Max. multiple value is 3 (skill.h: MAX_SKILL_STATUS_REQUIRE)
// Max. multiple value is 3 (skill.hpp: MAX_SKILL_STATUS_REQUIRE)
// Use any number or SC_ALL will disable status requirements
// 'RequiredEquipment'
// Specified equipment to be equipped. For multiple values, use : as delimiter.
// Max. multiple value is 10 (skill.h: MAX_SKILL_EQUIP_REQUIRE)
// Max. multiple value is 10 (skill.hpp: MAX_SKILL_EQUIP_REQUIRE)
//****
// SM Swordman

2
db/re/item_delay.txt
View File

@ -16,7 +16,7 @@
// 12659 cannot be used when this delay is active.
// Since this is optional, default is -1 will ignores the
// delay group and the delay will be stored in character's
// data that has limit set in src/map/itemdb.h as MAX_ITEMDELAYS.
// data that has limit set in src/map/itemdb.hpp as MAX_ITEMDELAYS.
// SC_REUSE_REFRESH
12725,120000,SC_REUSE_REFRESH //Runstone_Nosiege

4
db/re/skill_require_db.txt
View File

@ -26,11 +26,11 @@
// 'RequiredStatuses'
// Fill the value only with SC_STATUS (see db/const.txt for more details)
// Usage for multiple status requirements: SC_STATUS1:SC_STATUS2:SC_STATUS3
// Max. multiple value is 3 (skill.h: MAX_SKILL_STATUS_REQUIRE)
// Max. multiple value is 3 (skill.hpp: MAX_SKILL_STATUS_REQUIRE)
// Use any number or SC_ALL will disable status requirements
// 'RequiredEquipment'
// Specified equipment to be equipped. For multiple values, use : as delimiter.
// Max. multiple value is 10 (skill.h: MAX_SKILL_EQUIP_REQUIRE)
// Max. multiple value is 10 (skill.hpp: MAX_SKILL_EQUIP_REQUIRE)
//****
// SM Swordman

2
db/spellbook_db.txt
View File

@ -4,7 +4,7 @@
// SkillID,PreservePoints,Required Book
//
// NOTE:
// - To add more entries, increase MAX_SKILL_SPELLBOOK_DB in skill.h.
// - To add more entries, increase MAX_SKILL_SPELLBOOK_DB in skill.hpp.
// - To remove entry by importing, put 0 for 'PreservePoints'
//Mage

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.

2
npc/custom/jobmaster.txt
View File

@ -132,7 +132,7 @@ function Job_Options {
.@rebirth_possible = Can_Rebirth();
.@first_eac = .@eac&EAJ_BASEMASK;
.@second_eac = .@eac&EAJ_UPPERMASK;
// Note: These are already set in pc.c
// Note: These are already set in pc.cpp
// BaseClass = roclass(.@eac&EAJ_BASEMASK) which is the players First Class
// BaseJob = roclass(.@eac&EAJ_UPPERMASK) which is the players Second Class
//dispbottom "Debug: eac ("+.@eac+"), third ("+.@third_possible+"), rebirth("+.@rebirth_possible+"), BaseClass ("+BaseClass+"), BaseJob ("+BaseJob+")";

2
npc/re/jobs/3-1/rune_knight.txt
View File

@ -785,7 +785,7 @@ job3_rune01,55,50,3 script Rune Knight, Renoa 469,2,2,{
mes "Find the sage, Serpeone who's been studying and helping the Rune Knights who are out in the Rune-Midgard's camp at Ash-Vacuum.";
next;
mes "[Rune Knight, Renoa]";
mes "The sage has already been in touch with us for a long time so you don't need to worry about understanding Serpeone's language.c";
mes "The sage has already been in touch with us for a long time so you don't need to worry about understanding Serpeone's language.";
next;
mes "[Rune Knight, Renoa]";
mes "If you are ready I'll guide you to the warp that moves you directly to Serpeone. Meet her and get instructions from her.";

2
src/char/char.cpp
View File

@ -36,7 +36,7 @@
#include "int_party.hpp"
#include "int_storage.hpp"
//definition of exported var declared in .h
//definition of exported var declared in header
int login_fd=-1; //login file descriptor
int char_fd=-1; //char file descriptor
struct Schema_Config schema_config;

2
src/char/char_mapif.cpp
View File

@ -766,7 +766,7 @@ int chmapif_parse_fwlog_changestatus(int fd){
// if( acc != -1 && isGM(acc) < isGM(account_id) )
// result = 2; // 2-gm level too low
else {
//! NOTE: See src/char/chrif.h::enum chrif_req_op for the number
//! NOTE: See src/char/chrif.hpp::enum chrif_req_op for the number
switch( operation ) {
case CHRIF_OP_LOGIN_BLOCK: // block
WFIFOHEAD(login_fd,10);

2
src/char/int_clan.cpp
View File

@ -176,7 +176,7 @@ static void mapif_parse_clan_member_joined( int fd ){
// Communication from the map server
// - Can analyzed only one by one packet
// Data packet length that you set to inter.c
// Data packet length that you set to inter.cpp
//- Shouldn't do checking and packet length, RFIFOSKIP is done by the caller
// Must Return
// 1 : ok

2
src/char/int_guild.cpp
View File

@ -1876,7 +1876,7 @@ int mapif_parse_GuildMasterChange(int fd, int guild_id, const char* name, int le
// Communication from the map server
// - Can analyzed only one by one packet
// Data packet length that you set to inter.c
// Data packet length that you set to inter.cpp
//- Shouldn't do checking and packet length, RFIFOSKIP is done by the caller
// Must Return
// 1 : ok

2
src/char/int_party.cpp
View File

@ -804,7 +804,7 @@ int mapif_parse_PartyShareLevel(int fd,unsigned int share_lvl)
// Communication from the map server
//-Analysis that only one packet
// Data packet length is set to inter.c that you
// Data packet length is set to inter.cpp that you
// Do NOT go and check the packet length, RFIFOSKIP is done by the caller
// Return :
// 0 : error

2
src/char/inter.cpp
View File

@ -72,7 +72,7 @@ struct WisData {
static DBMap* wis_db = NULL; // int wis_id -> struct WisData*
static int wis_dellist[WISDELLIST_MAX], wis_delnum;
/* from pc.c due to @accinfo. any ideas to replace this crap are more than welcome. */
/* from pc.cpp due to @accinfo. any ideas to replace this crap are more than welcome. */
const char* job_name(int class_) {
switch (class_) {
case JOB_NOVICE:

2
src/common/mmo.hpp
View File

@ -1027,7 +1027,7 @@ struct clan{
#error MAX_ZENY is too big
#endif
// This sanity check is required, because some other places(like skill.c) rely on this
// This sanity check is required, because some other places(like skill.cpp) rely on this
#if MAX_PARTY < 2
#error MAX_PARTY is too small, you need at least 2 players for a party
#endif

2
src/common/showmsg.cpp
View File

@ -675,7 +675,7 @@ int _vShowMessage(enum msg_type flag, const char *string, va_list ap)
return 1;
}
/**
* For the buildbot, these result in a EXIT_FAILURE from core.c when done reading the params.
* For the buildbot, these result in a EXIT_FAILURE from core.cpp when done reading the params.
**/
#if defined(BUILDBOT)
if( flag == MSG_WARNING ||

2
src/custom/battle_config_struct.inc
View File

@ -5,7 +5,7 @@
* Custom battle config structure
* Place the definition of custom battle configuration structure members in this file.
*
* Make sure that the name you want is not already taken by looking into battle.h
* Make sure that the name you want is not already taken by looking into battle.hpp
* Do not forget to add initilization logic to battle_config_init.inc
*
* Format:

2
src/login/login.cpp
View File

@ -36,7 +36,7 @@ using namespace rathena;
#define LOGIN_MAX_MSG 30 /// Max number predefined in msg_conf
static char* msg_table[LOGIN_MAX_MSG]; /// Login Server messages_conf
//definition of exported var declared in .h
//definition of exported var declared in header
struct mmo_char_server ch_server[MAX_SERVERS]; /// char server data
struct Login_Config login_config; /// Configuration of login-serv
std::unordered_map<uint32,struct online_login_data> online_db;

2
src/login/loginlog.cpp
View File

@ -13,7 +13,7 @@
#include "../common/sql.hpp"
#include "../common/strlib.hpp"
// global sql settings (in ipban_sql.c)
// global sql settings (in ipban_sql.cpp)
static char global_db_hostname[64] = "127.0.0.1"; // Doubled to reflect the change on commit #0f2dd7f
static uint16 global_db_port = 3306;
static char global_db_username[32] = "ragnarok";

2
src/map/battle.hpp
View File

@ -81,7 +81,7 @@ struct Damage {
bool isspdamage; /// Display blue damage numbers in clif_damage
};
//(Used in read pc.c,) attribute table (battle_attr_fix)
//(Used in read pc.cpp) attribute table (battle_attr_fix)
extern int attr_fix_table[MAX_ELE_LEVEL][ELE_MAX][ELE_MAX];
// Damage Calculation

2
src/map/clif.cpp
View File

@ -238,7 +238,7 @@ void clif_setbindip(const char* ip)
/*==========================================
* Sets map port to 'port'
* is run from map.c upon loading map server configuration
* is run from map.cpp upon loading map server configuration
*------------------------------------------*/
void clif_setport(uint16 port)
{

2
src/map/mapreg.cpp
View File

@ -333,7 +333,7 @@ void mapreg_final(void)
void mapreg_init(void)
{
regs.vars = i64db_alloc(DB_OPT_BASE);
mapreg_ers = ers_new(sizeof(struct mapreg_save), "mapreg.c:mapreg_ers", ERS_OPT_CLEAN);
mapreg_ers = ers_new(sizeof(struct mapreg_save), "mapreg.cpp:mapreg_ers", ERS_OPT_CLEAN);
skip_insert = false;
regs.arrays = NULL;

2
src/map/mercenary.hpp
View File

@ -84,7 +84,7 @@ int mercenary_checkskill(struct mercenary_data *md, uint16 skill_id);
short mercenary_skill_get_index(uint16 skill_id);
/**
* atcommand.c required
* atcommand.cpp required
**/
void mercenary_readdb(void);
void mercenary_read_skilldb(void);

2
src/map/npc.hpp
View File

@ -59,7 +59,7 @@ struct npc_data {
unsigned short str, agi, vit, int_, dex, luk;
} params;
void* chatdb; // pointer to a npc_parse struct (see npc_chat.c)
void* chatdb; // pointer to a npc_parse struct (see npc_chat.cpp)
char* path;/* path dir */
enum npc_subtype subtype;
bool trigger_on_hidden;

2
src/map/pc.cpp
View File

@ -5008,7 +5008,7 @@ int pc_useitem(struct map_session_data *sd,int n)
//Since most delay-consume items involve using a "skill-type" target cursor,
//perform a skill-use check before going through. [Skotlex]
//resurrection was picked as testing skill, as a non-offensive, generic skill, it will do.
//FIXME: Is this really needed here? It'll be checked in unit.c after all and this prevents skill items using when silenced [Inkfish]
//FIXME: Is this really needed here? It'll be checked in unit.cpp after all and this prevents skill items using when silenced [Inkfish]
if( id->flag.delay_consume && ( sd->ud.skilltimer != INVALID_TIMER /*|| !status_check_skilluse(&sd->bl, &sd->bl, ALL_RESURRECTION, 0)*/ ) )
return 0;

2
src/map/pet.cpp
View File

@ -706,7 +706,7 @@ int pet_catch_process2(struct map_session_data* sd, int target_id)
/**
* Is invoked _only_ when a new pet has been created is a product of packet 0x3880
* see mapif_pet_created@int_pet.c for more information.
* see mapif_pet_created@int_pet.cpp for more information.
* Handles new pet data from inter-server and prepares item information to add pet egg.
* @param account_id : account ID of owner
* @param pet_class : class of pet

8
src/map/script.cpp
View File

@ -11311,7 +11311,7 @@ BUILDIN_FUNC(sc_start)
tick = skill_get_time(status_sc2skill(type), val1);
}
if(potion_flag == 1 && potion_target) { //skill.c set the flags before running the script, this is a potion-pitched effect.
if(potion_flag == 1 && potion_target) { //skill.cpp set the flags before running the script, this is a potion-pitched effect.
bl = map_id2bl(potion_target);
tick /= 2;// Thrown potions only last half.
val4 = 1;// Mark that this was a thrown sc_effect
@ -15336,7 +15336,7 @@ BUILDIN_FUNC(cardscnt)
if (id <= 0)
continue;
index = current_equip_item_index; //we get CURRENT WEAPON inventory index from status.c [Lupus]
index = current_equip_item_index; //we get CURRENT WEAPON inventory index from status.cpp [Lupus]
if(index < 0) continue;
if(!sd->inventory_data[index])
@ -18385,7 +18385,7 @@ BUILDIN_FUNC(unittalk)
///
/// unitemote <unit_id>,<emotion>;
///
/// @see ET_* in script_constants.h
/// @see ET_* in script_constants.hpp
BUILDIN_FUNC(unitemote)
{
int emotion;
@ -24032,7 +24032,7 @@ BUILDIN_FUNC(achievement_condition){
#include "../custom/script.inc"
// declarations that were supposed to be exported from npc_chat.c
// declarations that were supposed to be exported from npc_chat.cpp
#ifdef PCRE_SUPPORT
BUILDIN_FUNC(defpattern);
BUILDIN_FUNC(activatepset);

4
src/map/status.cpp
View File

@ -2099,7 +2099,7 @@ bool status_check_skilluse(struct block_list *src, struct block_list *target, ui
if (!status_has_mode(status,MD_CANATTACK))
return false;
// Dead state is not checked for skills as some skills can be used
// on dead characters, said checks are left to skill.c [Skotlex]
// on dead characters, said checks are left to skill.cpp [Skotlex]
if (target && status_isdead(target))
return false;
}
@ -2240,7 +2240,7 @@ bool status_check_skilluse(struct block_list *src, struct block_list *target, ui
if (tsc && tsc->count) {
/**
* Attacks in invincible are capped to 1 damage and handled in batte.c.
* Attacks in invincible are capped to 1 damage and handled in battle.cpp.
* Allow spell break and eske for sealed shrine GDB when in INVINCIBLE state.
**/
if( tsc->data[SC_INVINCIBLE] && !tsc->data[SC_INVINCIBLEOFF] && skill_id && !(skill_id&(SA_SPELLBREAKER|SL_SKE)) )

4
src/map/unit.cpp
View File

@ -41,7 +41,7 @@
// 1 0 7
// 2 . 6
// 3 4 5
// See also path.c walk_choices
// See also path.cpp walk_choices
const short dirx[DIR_MAX]={0,-1,-1,-1,0,1,1,1}; ///lookup to know where will move to x according dir
const short diry[DIR_MAX]={1,1,0,-1,-1,-1,0,1}; ///lookup to know where will move to y according dir
@ -1350,7 +1350,7 @@ int unit_is_walking(struct block_list *bl)
/**
* Checks if a unit is able to move based on status changes
* View the StatusChangeStateTable in status.c for a list of statuses
* View the StatusChangeStateTable in status.cpp for a list of statuses
* Some statuses are still checked here due too specific variables
* @author [Skotlex]
* @param bl: Object to check

4
tools/check-doc.pl
View File

@ -93,7 +93,7 @@ sub Chk { my($raA,$raB) = @_;
}
sub Script_GetCmd {
my @aSct_src = ("../src/map/script.c","../src/custom/script_def.inc");
my @aSct_src = ("../src/map/script.cpp","../src/custom/script_def.inc");
my @aDef_sct = ();
foreach my $sSct_srcf (@aSct_src){
unless(open FILE_SRC, "<$sSct_srcf") {
@ -173,7 +173,7 @@ sub Script_Chk { my ($raDef_sct) = @_;
}
sub Atc_GetCmd {
my @aAct_src = ("../src/map/atcommand.c","../src/custom/atcommand_def.inc");
my @aAct_src = ("../src/map/atcommand.cpp","../src/custom/atcommand_def.inc");
my @aDef_act = ();
foreach my $sAct_srcf (@aAct_src){
unless(open FILE_SRC, "<$sAct_srcf"){