summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2012-11-05 20:03:17 +0000
committerfrosch <frosch@openttd.org>2012-11-05 20:03:17 +0000
commit40c3cd46f1df19d4139d89a043c9db3bc5dde4fe (patch)
tree29f3abd1de4cee4fb1e706f557df60c9dc8fc813
parent3252d41dcc049657ae195cc7e026c6c62f204d35 (diff)
downloadopenttd-40c3cd46f1df19d4139d89a043c9db3bc5dde4fe.tar.xz
(svn r24665) -Doc [FS#5353]: [Script] Add note about the compatibility aspects of the enums in ScriptWindow.
-rw-r--r--src/script/api/script_window.hpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/script/api/script_window.hpp b/src/script/api/script_window.hpp
index a12973a03..9d3c6c53e 100644
--- a/src/script/api/script_window.hpp
+++ b/src/script/api/script_window.hpp
@@ -78,6 +78,11 @@
* good rule of thumb is: either the number is always 0, or the ID of the
* object in question.
* In the comment at the widget enum, it is mentioned how the number is used.
+ *
+ * Note, that the detailed window layout is very version specific.
+ * Enum values might be added, changed or removed in future versions without notice
+ * in the changelog, and there won't be any means of compatibility.
+ *
* @api game
*/
class ScriptWindow : public ScriptObject {