From eb64857ceb055fd85e18298d473220fc5b795987 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 24 Mar 2024 18:52:10 +0100 Subject: [PATCH] Codefix: Script API documentation about IDs was incomplete --- src/script/api/script_types.hpp | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/src/script/api/script_types.hpp b/src/script/api/script_types.hpp index 9deba0681d..20289bdf39 100644 --- a/src/script/api/script_types.hpp +++ b/src/script/api/script_types.hpp @@ -46,6 +46,14 @@ * game start \ref newgrf_changes "(1)" * never \ref newgrf_changes "(1)" * no + * #ObjectType NewGRF object type + * game start \ref newgrf_changes "(1)" + * never \ref newgrf_changes "(1)" + * no + * #ScriptErrorType error message + * OpenTTD start \ref transient_id "(3)" + * OpenTTD exit + * no * #SignID sign * construction * deletion @@ -54,10 +62,22 @@ * construction * expiration of 'grey' station sign after deletion * yes + * #StringID translatable text + * OpenTTD start \ref transient_id "(3)" + * OpenTTD exit + * no * #SubsidyID subsidy * offer announcement * (offer) expiration * yes + * #StoryPageID story page + * creation + * deletion + * yes + * #StoryPageElementID story page element + * creation + * deletion + * yes * #TileIndex tile on map * game start * never @@ -75,6 +95,7 @@ * @remarks * \li \anchor newgrf_changes (1) in-game changes of newgrfs may reassign/invalidate IDs (will also cause other trouble though). * \li \anchor dynamic_engines (2) engine IDs are reassigned/invalidated on changing 'allow multiple newgrf engine sets' (only allowed as long as no vehicles are built). + * \li \anchor transient_id (3) string/error IDs are only valid during a session, and may be reassigned/invalidated when loading savegames (so you cannot store them). */ #ifndef SCRIPT_TYPES_HPP