diff options
Diffstat (limited to 'src/map/npc.c')
| -rw-r--r-- | src/map/npc.c | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/src/map/npc.c b/src/map/npc.c index c74038272..8bc874615 100644 --- a/src/map/npc.c +++ b/src/map/npc.c @@ -3562,9 +3562,32 @@ int npc_do_atcmd_event(struct map_session_data* sd, const char* command, const c return 0; } -/// Parses a function. -/// function%TAB%script%TAB%<function name>%TAB%{<code>} -const char* npc_parse_function(char* w1, char* w2, char* w3, char* w4, const char* start, const char* buffer, const char* filepath, int *retval) { +/** + * Parses a function. + * + * Example: + * @code + * function<TAB>script<TAB><function name><TAB>{ + * <code> + * } + * @endcode + * + * @param[in] w1 First tab-delimited part of the string to parse. + * @param[in] w2 Second tab-delimited part of the string to parse. + * @param[in] w3 Third tab-delimited part of the string to parse. + * @param[in] w4 Fourth tab-delimited part of the string to parse. + * @param[in] start Pointer to the beginning of the string inside buffer. + * This must point to the same buffer as `buffer`. + * @param[in] buffer Pointer to the buffer containing the script. For + * single-line mapflags not inside a script, this may be + * an empty (but initialized) single-character buffer. + * @param[in] filepath Source file path. + * @param[out] retval Pointer to return the success (EXIT_SUCCESS) or failure + * (EXIT_FAILURE) status. May be NULL. + * @return A pointer to the advanced buffer position. + */ +const char *npc_parse_function(const char *w1, const char *w2, const char *w3, const char *w4, const char *start, const char *buffer, const char *filepath, int *retval) +{ DBMap* func_db; DBData old_data; struct script_code *scriptroot; |