From 40c3cd46f1df19d4139d89a043c9db3bc5dde4fe Mon Sep 17 00:00:00 2001 From: frosch Date: Mon, 5 Nov 2012 20:03:17 +0000 Subject: (svn r24665) -Doc [FS#5353]: [Script] Add note about the compatibility aspects of the enums in ScriptWindow. --- src/script/api/script_window.hpp | 5 +++++ 1 file changed, 5 insertions(+) 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 { -- cgit v1.2.3-70-g09d2