diff --git a/src/script/api/script_info_docs.hpp b/src/script/api/script_info_docs.hpp index 36d2b859ab..fad4b152df 100644 --- a/src/script/api/script_info_docs.hpp +++ b/src/script/api/script_info_docs.hpp @@ -218,20 +218,27 @@ public: * store the current configuration of Scripts. Required. * - description A single line describing the setting. Required. * - min_value The minimum value of this setting. Required for integer - * settings and not allowed for boolean settings. + * settings and not allowed for boolean settings. The value will be + * clamped in the range [MIN(int32), MAX(int32)] (inclusive). * - max_value The maximum value of this setting. Required for integer - * settings and not allowed for boolean settings. + * settings and not allowed for boolean settings. The value will be + * clamped in the range [MIN(int32), MAX(int32)] (inclusive). * - easy_value The default value if the easy difficulty level - * is selected. Required. + * is selected. Required. The value will be clamped in the range + * [MIN(int32), MAX(int32)] (inclusive). * - medium_value The default value if the medium difficulty level - * is selected. Required. + * is selected. Required. The value will be clamped in the range + * [MIN(int32), MAX(int32)] (inclusive). * - hard_value The default value if the hard difficulty level - * is selected. Required. + * is selected. Required. The value will be clamped in the range + * [MIN(int32), MAX(int32)] (inclusive). * - custom_value The default value if the custom difficulty level - * is selected. Required. + * is selected. Required. The value will be clamped in the range + * [MIN(int32), MAX(int32)] (inclusive). * - random_deviation If this property has a nonzero value, then the * actual value of the setting in game will be randomized in the range * [user_configured_value - random_deviation, user_configured_value + random_deviation] (inclusive). + * random_deviation sign is ignored and the value is clamped in the range [0, MAX(int32)] (inclusive). * Not allowed if the CONFIG_RANDOM flag is set, otherwise optional. * - step_size The increase/decrease of the value every time the user * clicks one of the up/down arrow buttons. Optional, default is 1.