summaryrefslogtreecommitdiff
path: root/src/map/script.h
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2014-10-18 21:34:29 +0200
committerHaru <haru@dotalux.com>2014-10-27 00:38:45 +0100
commitce85609f42d6f0f2fd1db6e76bce9744e231074e (patch)
tree5972802a7c25dae8b1845967ee82479d7ecfde2e /src/map/script.h
parentc151e8714304dc4f95d9ce91b98fc84bf0958d94 (diff)
downloadhercules-ce85609f42d6f0f2fd1db6e76bce9744e231074e.tar.gz
hercules-ce85609f42d6f0f2fd1db6e76bce9744e231074e.tar.bz2
hercules-ce85609f42d6f0f2fd1db6e76bce9744e231074e.tar.xz
hercules-ce85609f42d6f0f2fd1db6e76bce9744e231074e.zip
Added source support to mark script commands as deprecated
- Commands marked as deprecated will trigger a warning when the script is loaded. (there are currently no commands marked as such, but some will come soon) Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'src/map/script.h')
-rw-r--r--src/map/script.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/map/script.h b/src/map/script.h
index 54b3835a7..75ba8d5ce 100644
--- a/src/map/script.h
+++ b/src/map/script.h
@@ -30,6 +30,8 @@ struct eri;
#define DeprecationCaseWarning2(func, bad, good, where) ShowError("%s: detected possible use of wrong case in a script. Found '%s', probably meant to be '%s' (in '%s').\n", (func), (bad), (good), get_script_source(where))
#define disp_deprecation_message(func, good, p) disp_warning_message(func": use of deprecated keyword (use '"good"' instead).", (p))
+#define DeprecationWarning(p) disp_warning_message("This command is deprecated and it will be removed in a future update. Please see the script documentation for an alternative.\n", (p))
+
#define NUM_WHISPER_VAR 10
/// Maximum amount of elements in script arrays
@@ -433,6 +435,7 @@ struct script_function {
bool (*func)(struct script_state *st);
char *name;
char *arg;
+ bool deprecated;
};
// String buffer structures.
@@ -445,6 +448,7 @@ struct str_data_struct {
bool (*func)(struct script_state *st);
int val;
int next;
+ uint8 deprecated : 1;
};
struct script_label_entry {