Search
AMXX-BG.INFO › settings_api.inc
Constants Functions Forwards Enums

settings_api

Browse all symbols documented inside this include file.

Constants

Name Description
_settings_api_included —
MAX_OPTION_LENGTH = 32
MAX_STR_VALUE_LENGTH = 64
RESERVER_OPTION_END = "#reserved_option_end"

Functions

Name Description
register_players_option_cell Register option for players (int/float/bool value) note: should be called in plugin_precache @param optionName option name @param fieldType see `OptionFieldType` constants @param defaultValue default value @noreturn
register_players_option_str Register option for players (string value) note: should be called in plugin_precache @param optionName option name @param defaultValue default value @noreturn
find_option_by_name Get option id by its name note: should not be called in plugin_precache @param optionName option name @return -1 if option does not exist, id >= 0 otherwise
get_option_cell —
set_option_cell —
get_option_string —
set_option_string —

Forwards

Name Description
OnConnectionIsReady Calls from `settings_mysql` when connection is ready @noreturn
OnOptionsInitialized Calls after all options were created in database @noreturn
OnRegisterOption Calls when option is ready to be initialized (after `OnConnectionIsReady`) @param optionName option name @param fieldType see `OptionFieldType` constants @param defaultValue default value
OnCellValueChanged —
OnStringValueChanged —
OnNotifyMysqlCellValue —
OnNotifyMysqlStringValue —

Enums

Name Description
OptionFieldType —