UserConfigParams Namespace Reference

Contains all parameters that are stored in the user's config file. More...

Enumerations
enum	{   LOG_MEMORY = 0x0001 , LOG_GUI = 0x0002 , LOG_ADDONS = 0x0004 , LOG_MISC = 0x0008 ,   LOG_FLYABLE = 0x0010 , LOG_ALL = 0xffff }
	Some constants to bitmask to enable various messages to be printed.

Functions
PARAM_PREFIX GroupUserConfigParam m_audio_group	PARAM_DEFAULT (GroupUserConfigParam("Audio", "Audio Settings"))
PARAM_PREFIX BoolUserConfigParam m_sfx	PARAM_DEFAULT (BoolUserConfigParam(true, "sfx_on", &m_audio_group, "Whether sound effects are enabled or not (true or false)"))
PARAM_PREFIX BoolUserConfigParam m_music	PARAM_DEFAULT (BoolUserConfigParam(true, "music_on", &m_audio_group, "Whether musics are enabled or not (true or false)"))
PARAM_PREFIX FloatUserConfigParam m_sfx_volume	PARAM_DEFAULT (FloatUserConfigParam(0.6f, "sfx_volume", &m_audio_group, "Volume for sound effects, see openal AL_GAIN " "for interpretation"))
PARAM_PREFIX FloatUserConfigParam m_music_volume	PARAM_DEFAULT (FloatUserConfigParam(0.5f, "music_volume", &m_audio_group, "Music volume from 0.0 to 1.0"))
PARAM_PREFIX IntUserConfigParam m_volume_denominator	PARAM_DEFAULT (IntUserConfigParam(10, "volume_denominator", &m_audio_group, "Number of steps for volume adjustment"))
PARAM_PREFIX GroupUserConfigParam m_race_setup_group	PARAM_DEFAULT (GroupUserConfigParam("RaceSetup", "Race Setup Settings"))
PARAM_PREFIX IntUserConfigParam m_default_num_karts	PARAM_DEFAULT (IntUserConfigParam(4, "numkarts", &m_race_setup_group, "Default number of karts. -1 means use all"))
PARAM_PREFIX IntUserConfigParam m_num_laps	PARAM_DEFAULT (IntUserConfigParam(4, "numlaps", &m_race_setup_group, "Default number of laps."))
PARAM_PREFIX IntUserConfigParam m_gp_reverse	PARAM_DEFAULT (IntUserConfigParam(0, "gp-reverse", &m_race_setup_group, "Default direction of GP tracks. 0=default, 1=no reverse, 2=all reverse, 3=Random"))
PARAM_PREFIX IntUserConfigParam m_rand_gp_num_tracks	PARAM_DEFAULT (IntUserConfigParam(1, "random-gp-num-tracks", &m_race_setup_group, "Default number of tracks for random GP."))
PARAM_PREFIX IntUserConfigParam m_ffa_time_limit	PARAM_DEFAULT (IntUserConfigParam(3, "ffa-time-limit", &m_race_setup_group, "Time limit in ffa mode."))
PARAM_PREFIX BoolUserConfigParam m_use_ffa_mode	PARAM_DEFAULT (BoolUserConfigParam(false, "use-ffa-mode", &m_race_setup_group, "Use ffa mode instead of 3 strikes battle."))
PARAM_PREFIX IntUserConfigParam m_lap_trial_time_limit	PARAM_DEFAULT (IntUserConfigParam(3, "lap-trial-time-limit", &m_race_setup_group, "Time limit in lap trial mode."))
PARAM_PREFIX IntUserConfigParam m_num_goals	PARAM_DEFAULT (IntUserConfigParam(3, "numgoals", &m_race_setup_group, "Default number of goals in soccer mode."))
PARAM_PREFIX IntUserConfigParam m_soccer_default_team	PARAM_DEFAULT (IntUserConfigParam(0, "soccer-default-team", &m_race_setup_group, "Default team in soccer mode for single player."))
PARAM_PREFIX IntUserConfigParam m_soccer_time_limit	PARAM_DEFAULT (IntUserConfigParam(3, "soccer-time-limit", &m_race_setup_group, "Time limit in soccer mode."))
PARAM_PREFIX BoolUserConfigParam m_soccer_use_time_limit	PARAM_DEFAULT (BoolUserConfigParam(false, "soccer-use-time-limit", &m_race_setup_group, "Enable time limit in soccer mode."))
PARAM_PREFIX BoolUserConfigParam m_random_arena_item	PARAM_DEFAULT (BoolUserConfigParam(false, "random-arena-item", &m_race_setup_group, "Enable random location of items in an arena."))
PARAM_PREFIX IntUserConfigParam m_difficulty	PARAM_DEFAULT (IntUserConfigParam(0, "difficulty", &m_race_setup_group, "Default race difficulty. 0=easy, 1=medium, 2=hard, 3=supertux"))
PARAM_PREFIX IntUserConfigParam m_game_mode	PARAM_DEFAULT (IntUserConfigParam(0, "game_mode", &m_race_setup_group, "Game mode. 0=standard, 1=time trial, 2=follow " "the leader, 3=3 strikes, 4=easter egg hunt, " "5=soccer, 6=ghost replay"))
PARAM_PREFIX StringUserConfigParam m_default_kart	PARAM_DEFAULT (StringUserConfigParam("tux", "kart", "Kart to select by default (the last used kart)"))
PARAM_PREFIX StringUserConfigParam m_last_used_kart_group	PARAM_DEFAULT (StringUserConfigParam("all", "last_kart_group", "Last selected kart group"))
PARAM_PREFIX IntUserConfigParam m_soccer_red_ai_num	PARAM_DEFAULT (IntUserConfigParam(0, "soccer-red-ai-num", &m_race_setup_group, "Number of red AI karts in soccer mode."))
PARAM_PREFIX IntUserConfigParam m_soccer_blue_ai_num	PARAM_DEFAULT (IntUserConfigParam(0, "soccer-blue-ai-num", &m_race_setup_group, "Number of blue AI karts in soccer mode."))
PARAM_PREFIX BoolUserConfigParam m_karts_powerup_gui	PARAM_DEFAULT (BoolUserConfigParam(false, "karts-powerup-gui", &m_race_setup_group, "Show other karts' held powerups in race gui."))
PARAM_PREFIX BoolUserConfigParam m_soccer_player_list	PARAM_DEFAULT (BoolUserConfigParam(false, "soccer-player-list", &m_race_setup_group, "Show player list icon in soccer mode."))
PARAM_PREFIX BoolUserConfigParam m_addon_tux_online	PARAM_DEFAULT (BoolUserConfigParam(false, "addon-tux-online", &m_race_setup_group, "Always show online addon karts as tux when live join is on."))
PARAM_PREFIX BoolUserConfigParam m_random_player_pos	PARAM_DEFAULT (BoolUserConfigParam(false, "random-player-pos", &m_race_setup_group, "Randomize the position of the players at the start of a race. Doesn't apply to story mode."))
PARAM_PREFIX GroupUserConfigParam m_wiimote_group	PARAM_DEFAULT (GroupUserConfigParam("WiiMote", "Settings for the wiimote"))
PARAM_PREFIX FloatUserConfigParam m_wiimote_raw_max	PARAM_DEFAULT (FloatUserConfigParam(20.0f, "wiimote-raw-max", &m_wiimote_group, "At what raw input value maximum steering is reached (between 1 and 25)."))
PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_linear	PARAM_DEFAULT (FloatUserConfigParam(1.0f, "wiimote-weight-linear", &m_wiimote_group, "A weight applied to the linear component of mapping wiimote angle to steering angle"))
PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_square	PARAM_DEFAULT (FloatUserConfigParam(0.0f, "wiimote-weight-square", &m_wiimote_group, "A weight applied to the square component of mapping wiimote angle to steering angle"))
PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_asin	PARAM_DEFAULT (FloatUserConfigParam(0.0f, "wiimote-weight-asin", &m_wiimote_group, "A weight applied to the asin component of mapping wiimote angle to steering angle"))
PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_sin	PARAM_DEFAULT (FloatUserConfigParam(0.0f, "wiimote-weight-sin", &m_wiimote_group, "A weight applied to the sin component of mapping wiimote angle to steering angle"))
PARAM_PREFIX GroupUserConfigParam m_multitouch_group	PARAM_DEFAULT (GroupUserConfigParam("Multitouch", "Settings for the multitouch device"))
PARAM_PREFIX IntUserConfigParam m_multitouch_active	PARAM_DEFAULT (IntUserConfigParam(1, "multitouch_active", &m_multitouch_group, "Enable multitouch support: 0 = disabled, 1 = if available, 2 = enabled"))
PARAM_PREFIX BoolUserConfigParam m_multitouch_draw_gui	PARAM_DEFAULT (BoolUserConfigParam(false, "multitouch_draw_gui", &m_multitouch_group, "Enable multitouch race GUI"))
PARAM_PREFIX BoolUserConfigParam m_multitouch_inverted	PARAM_DEFAULT (BoolUserConfigParam(false, "multitouch_inverted", &m_multitouch_group, "Draw steering wheel on right side."))
PARAM_PREFIX BoolUserConfigParam m_multitouch_auto_acceleration	PARAM_DEFAULT (BoolUserConfigParam(false, "multitouch_auto_acceleration", &m_multitouch_group, "Auto acceleration for multitouch controls."))
PARAM_PREFIX IntUserConfigParam m_multitouch_controls	PARAM_DEFAULT (IntUserConfigParam(0, "multitouch_controls", &m_multitouch_group, "Multitouch mode: 0 = undefined, 1 = steering wheel, 2 = accelerometer, 3 = gyroscope"))
PARAM_PREFIX FloatUserConfigParam m_multitouch_deadzone	PARAM_DEFAULT (FloatUserConfigParam(0.1f, "multitouch_deadzone", &m_multitouch_group, "A parameter in range [0, 0.5] that determines the zone that is " "considered as centered in steering button."))
PARAM_PREFIX FloatUserConfigParam m_multitouch_sensitivity_x	PARAM_DEFAULT (FloatUserConfigParam(0.2f, "multitouch_sensitivity_x", &m_multitouch_group, "A parameter in range [0, 1.0] that determines the sensitivity for x axis."))
PARAM_PREFIX FloatUserConfigParam m_multitouch_sensitivity_y	PARAM_DEFAULT (FloatUserConfigParam(0.65f, "multitouch_sensitivity_y", &m_multitouch_group, "A parameter in range [0, 1.0] that determines the sensitivity for y axis."))
PARAM_PREFIX FloatUserConfigParam m_multitouch_tilt_factor	PARAM_DEFAULT (FloatUserConfigParam(4.0f, "multitouch_tilt_factor", &m_multitouch_group, "A parameter that determines general accelerometer sensitivity."))
PARAM_PREFIX FloatUserConfigParam m_multitouch_scale	PARAM_DEFAULT (FloatUserConfigParam(1.2f, "multitouch_scale", &m_multitouch_group, "A parameter in range [0.5, 1.5] that determines the scale of the " "multitouch interface."))
PARAM_PREFIX IntUserConfigParam m_screen_keyboard	PARAM_DEFAULT (IntUserConfigParam(0, "screen_keyboard_status", &m_multitouch_group, "STK screen keyboard status: 0 = disabled, 1 = enabled"))
PARAM_PREFIX GroupUserConfigParam m_gp_start_order	PARAM_DEFAULT (GroupUserConfigParam("GpStartOrder", "Order karts start in GP"))
PARAM_PREFIX BoolUserConfigParam m_gp_most_points_first	PARAM_DEFAULT (BoolUserConfigParam(true, "most_points_first", &m_gp_start_order, "Starting order from most to least points (true) or other " "way around (false)"))
PARAM_PREFIX BoolUserConfigParam m_gp_player_last	PARAM_DEFAULT (BoolUserConfigParam(false, "player_last", &m_gp_start_order, "Always put the player at the back or not (Bully mode)."))
PARAM_PREFIX StringUserConfigParam m_additional_gp_directory	PARAM_DEFAULT (StringUserConfigParam("", "additional_gp_directory", "Directory with additional GP's."))
PARAM_PREFIX GroupUserConfigParam m_video_group	PARAM_DEFAULT (GroupUserConfigParam("Video", "Video Settings"))
PARAM_PREFIX IntUserConfigParam m_real_width	PARAM_DEFAULT (IntUserConfigParam(1024, "real_width", &m_video_group, "Screen/window real width in pixels before high dpi is applied"))
PARAM_PREFIX IntUserConfigParam m_real_height	PARAM_DEFAULT (IntUserConfigParam(768, "real_height", &m_video_group, "Screen/window real height in pixels before high dpi is applied"))
PARAM_PREFIX IntUserConfigParam m_width	PARAM_DEFAULT (IntUserConfigParam(1024, "width", &m_video_group, "Screen/window width in pixels, this value should not be edited"))
PARAM_PREFIX IntUserConfigParam m_height	PARAM_DEFAULT (IntUserConfigParam(768, "height", &m_video_group, "Screen/window height in pixels, this value should not be edited"))
PARAM_PREFIX BoolUserConfigParam m_fullscreen	PARAM_DEFAULT (BoolUserConfigParam(false, "fullscreen", &m_video_group))
PARAM_PREFIX IntUserConfigParam m_prev_real_width	PARAM_DEFAULT (IntUserConfigParam(1024, "prev_real_width", &m_video_group, "Previous real screen/window width"))
PARAM_PREFIX IntUserConfigParam m_prev_real_height	PARAM_DEFAULT (IntUserConfigParam(768, "prev_real_height", &m_video_group,"Previous real screen/window height"))
PARAM_PREFIX BoolUserConfigParam m_prev_fullscreen	PARAM_DEFAULT (BoolUserConfigParam(false, "prev_fullscreen", &m_video_group))
PARAM_PREFIX BoolUserConfigParam m_remember_window_location	PARAM_DEFAULT (BoolUserConfigParam(false, "remember_window_location", &m_video_group))
PARAM_PREFIX IntUserConfigParam m_window_x	PARAM_DEFAULT (IntUserConfigParam(-1, "window_x", &m_video_group,"If remember_window_location is true"))
PARAM_PREFIX IntUserConfigParam m_window_y	PARAM_DEFAULT (IntUserConfigParam(-1, "window_y", &m_video_group,"If remember_window_location is true"))
PARAM_PREFIX BoolUserConfigParam m_display_fps	PARAM_DEFAULT (BoolUserConfigParam(false, "show_fps", &m_video_group, "Display frame per seconds"))
PARAM_PREFIX BoolUserConfigParam m_display_story_mode_timer	PARAM_DEFAULT (BoolUserConfigParam(true, "show_story_mode_timer", &m_video_group, "Display the story mode timer"))
PARAM_PREFIX BoolUserConfigParam m_speedrun_mode	PARAM_DEFAULT (BoolUserConfigParam(false, "show_speedrun_timer", &m_video_group, "Display the speedrun timer"))
PARAM_PREFIX IntUserConfigParam m_max_fps	PARAM_DEFAULT (IntUserConfigParam(120, "max_fps", &m_video_group, "Maximum fps, should be at least 60"))
PARAM_PREFIX BoolUserConfigParam m_force_legacy_device	PARAM_DEFAULT (BoolUserConfigParam(false, "force_legacy_device", &m_video_group, "Force OpenGL 2 context, even if OpenGL 3 is available."))
PARAM_PREFIX BoolUserConfigParam split_screen_horizontally	PARAM_DEFAULT (BoolUserConfigParam(true, "split_screen_horizontally", &m_video_group, "When playing a non-square amount of players (e.g. 2)," " should it split horizontally (top/bottom)"))
PARAM_PREFIX BoolUserConfigParam m_texture_compression	PARAM_DEFAULT (BoolUserConfigParam(true, "enable_texture_compression", &m_video_group, "Enable Texture Compression"))
PARAM_PREFIX IntUserConfigParam m_high_definition_textures	PARAM_DEFAULT (IntUserConfigParam(1, "enable_high_definition_textures", &m_video_group, "Enable high definition textures. Bit flag: " "bit 0 = enabled/disabled; bit 1 = set by user/set as default"))
	This is a bit flag: bit 0: enabled (1) or disabled(0).
PARAM_PREFIX BoolUserConfigParam m_glow	PARAM_DEFAULT (BoolUserConfigParam(false, "enable_glow", &m_video_group, "Enable Glow"))
PARAM_PREFIX BoolUserConfigParam m_bloom	PARAM_DEFAULT (BoolUserConfigParam(false, "enable_bloom", &m_video_group, "Enable Bloom"))
PARAM_PREFIX BoolUserConfigParam m_light_shaft	PARAM_DEFAULT (BoolUserConfigParam(false, "enable_light_shaft", &m_video_group, "Enable Light Shafts"))
PARAM_PREFIX BoolUserConfigParam m_dynamic_lights	PARAM_DEFAULT (BoolUserConfigParam(true, "enable_dynamic_lights", &m_video_group, "Enable Dynamic Lights"))
PARAM_PREFIX BoolUserConfigParam m_dof	PARAM_DEFAULT (BoolUserConfigParam(false, "enable_dof", &m_video_group, "Enable Depth of Field"))
PARAM_PREFIX BoolUserConfigParam m_old_driver_popup	PARAM_DEFAULT (BoolUserConfigParam(true, "old_driver_popup", &m_video_group, "Determines if popup message about too old drivers should be displayed."))
PARAM_PREFIX FloatUserConfigParam m_scale_rtts_factor	PARAM_DEFAULT (FloatUserConfigParam(1.0f, "scale_rtts_factor", &m_video_group, "Custom value for RTTs resolution. " "Value should be smaller or equal to 1.0"))
PARAM_PREFIX IntUserConfigParam m_max_texture_size	PARAM_DEFAULT (IntUserConfigParam(512, "max_texture_size", &m_video_group, "Max texture size when high definition textures are " "disabled"))
PARAM_PREFIX BoolUserConfigParam m_hq_mipmap	PARAM_DEFAULT (BoolUserConfigParam(false, "hq_mipmap", &m_video_group, "Generate mipmap for textures using " "high quality method with SSE"))
PARAM_PREFIX FloatUserConfigParam m_font_size	PARAM_DEFAULT (FloatUserConfigParam(3, "font_size", &m_video_group, "The size of fonts. 0 is the smallest and 6 is the biggest"))
PARAM_PREFIX StringUserConfigParam m_render_driver	PARAM_DEFAULT (StringUserConfigParam("gl", "render_driver", &m_video_group, "Render video driver to use, at the moment gl, vulkan or directx9 is supported."))
PARAM_PREFIX BoolUserConfigParam m_vulkan_fullscreen_desktop	PARAM_DEFAULT (BoolUserConfigParam(true, "vulkan_fullscreen_desktop", &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for vulkan device"))
PARAM_PREFIX BoolUserConfigParam m_non_ge_fullscreen_desktop	PARAM_DEFAULT (BoolUserConfigParam(false, "non_ge_fullscreen_desktop", &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for non-ge device"))
PARAM_PREFIX GroupUserConfigParam m_recording_group	PARAM_DEFAULT (GroupUserConfigParam("Recording", "Recording Settings"))
PARAM_PREFIX BoolUserConfigParam m_limit_game_fps	PARAM_DEFAULT (BoolUserConfigParam(true, "limit_game_fps", &m_recording_group, "Limit game framerate not beyond the fps of" " recording video."))
PARAM_PREFIX IntUserConfigParam m_video_format	PARAM_DEFAULT (IntUserConfigParam(0, "video_format", &m_recording_group, "Specify the video for record, which is the enum" " of VideoFormat in libopenglrecorder. It will" " auto fallback to MJPEG if libopenglrecorder was" " not compiled with such video encoder."))
PARAM_PREFIX IntUserConfigParam m_audio_bitrate	PARAM_DEFAULT (IntUserConfigParam(112000, "audio_bitrate", &m_recording_group, "Specify the bitrate for audio"))
PARAM_PREFIX IntUserConfigParam m_video_bitrate	PARAM_DEFAULT (IntUserConfigParam(20000, "video_bitrate", &m_recording_group, "Specify the bitrate for video"))
PARAM_PREFIX IntUserConfigParam m_recorder_jpg_quality	PARAM_DEFAULT (IntUserConfigParam(90, "recorder_jpg_quality", &m_recording_group, "Specify the jpg compression level of recorder"))
PARAM_PREFIX IntUserConfigParam m_record_fps	PARAM_DEFAULT (IntUserConfigParam(30, "record_fps", &m_recording_group, "Specify the fps of recording video"))
PARAM_PREFIX bool m_no_high_scores	PARAM_DEFAULT (false)
	If high scores will not be saved.
PARAM_PREFIX int m_verbosity	PARAM_DEFAULT (0)
	Verbosity level for debug messages.
PARAM_PREFIX bool m_enable_sound	PARAM_DEFAULT (true)
PARAM_PREFIX StringToUIntUserConfigParam m_server_bookmarks	PARAM_DEFAULT (StringToUIntUserConfigParam("server-bookmarks", "Wan server bookmarks", {{ "server-bookmarks", "server-name", "last-online" }}, {}))
PARAM_PREFIX StringToUIntUserConfigParam m_address_history	PARAM_DEFAULT (StringToUIntUserConfigParam("address-history", "Last 5 IP addresses that user entered", {{ "server-address", "address", "last-connection" }}, {}))
PARAM_PREFIX StringToUIntUserConfigParam m_stun_servers_v4	PARAM_DEFAULT (StringToUIntUserConfigParam("ipv4-stun-servers", "The stun servers that will be used to know the public address " "(ipv4 only) with port", {{ "stun-server", "address", "ping" }}, { { "stunv4.linuxreviews.org:3478", 0u }, { "stunv4.7.supertuxkart.net:3478", 0u }, { "stunv4.8.supertuxkart.net:3478", 0u } }))
PARAM_PREFIX StringToUIntUserConfigParam m_stun_servers	PARAM_DEFAULT (StringToUIntUserConfigParam("ipv6-stun-servers", "The stun servers that will be used to know the public address " "(including ipv6) with port", {{ "stun-server", "address", "ping" }}, { { "stun.linuxreviews.org:3478", 0u }, { "stun.supertuxkart.net:3478", 0u }, { "stun.stunprotocol.org:3478", 0u } }))
PARAM_PREFIX GroupUserConfigParam m_network_group	PARAM_DEFAULT (GroupUserConfigParam("Network", "Network Settings"))
PARAM_PREFIX BoolUserConfigParam m_enable_network_splitscreen	PARAM_DEFAULT (BoolUserConfigParam(false, "enable-network-splitscreen", &m_network_group, "The default value of enable splitscreen checkbox " "in online screen."))
PARAM_PREFIX BoolUserConfigParam m_log_packets	PARAM_DEFAULT (BoolUserConfigParam(false, "log-network-packets", &m_network_group, "If all network packets should be logged"))
PARAM_PREFIX BoolUserConfigParam m_random_client_port	PARAM_DEFAULT (BoolUserConfigParam(true, "random-client-port", &m_network_group, "Use random port for client connection " "(check stk_config.xml for default value)"))
PARAM_PREFIX BoolUserConfigParam m_random_server_port	PARAM_DEFAULT (BoolUserConfigParam(false, "random-server-port", &m_network_group, "Use random port for server connection " "(check stk_config.xml for default value)"))
PARAM_PREFIX BoolUserConfigParam m_lobby_chat	PARAM_DEFAULT (BoolUserConfigParam(true, "lobby-chat", &m_network_group, "Enable chatting in networking lobby, if off than " "no chat message will be displayed from any players."))
PARAM_PREFIX BoolUserConfigParam m_race_chat	PARAM_DEFAULT (BoolUserConfigParam(true, "race-chat", &m_network_group, "Enable chatting during races."))
PARAM_PREFIX BoolUserConfigParam m_ipv6_lan	PARAM_DEFAULT (BoolUserConfigParam(true, "ipv6-lan", &m_network_group, "Enable IPv6 LAN server discovery."))
PARAM_PREFIX IntUserConfigParam m_max_players	PARAM_DEFAULT (IntUserConfigParam(8, "max-players", &m_network_group, "Maximum number of players on the server " "(for gui server creation."))
PARAM_PREFIX IntUserConfigParam m_timer_sync_difference_tolerance	PARAM_DEFAULT (IntUserConfigParam(5, "timer-sync-difference-tolerance", &m_network_group, "Max time difference tolerance (in ms) to " "synchronize timer with server."))
PARAM_PREFIX IntUserConfigParam m_default_ip_type	PARAM_DEFAULT (IntUserConfigParam(0, "default-ip-type", &m_network_group, "Default IP type of this machine, " "0 detect every time, 1 IPv4, 2 IPv6, 3 IPv6 NAT64, 4 Dual stack."))
PARAM_PREFIX BoolUserConfigParam m_lan_server_gp	PARAM_DEFAULT (BoolUserConfigParam(false, "lan-server-gp", &m_network_group, "Show grand prix option in create LAN server " "screen, false will show AI option."))
PARAM_PREFIX BoolUserConfigParam m_wan_server_gp	PARAM_DEFAULT (BoolUserConfigParam(true, "wan-server-gp", &m_network_group, "Show grand prix option in create WAN server " "screen, false will show AI option."))
PARAM_PREFIX UIntToUIntUserConfigParam m_num_karts_per_gamemode	PARAM_DEFAULT (UIntToUIntUserConfigParam("num-karts-per-gamemode", "The Number of karts per gamemode.", {{ "gamemode-list", "gamemode", "num-karts" }}, { { 0u, 4u }, { 1002u, 5u }, { 1100u, 4u }, { 1101u, 4u }, { 2000u, 4u }, { 2001u, 4u } }))
PARAM_PREFIX GroupUserConfigParam m_graphics_quality	PARAM_DEFAULT (GroupUserConfigParam("GFX", "Graphics Quality Settings"))
PARAM_PREFIX IntUserConfigParam m_particles_effects	PARAM_DEFAULT (IntUserConfigParam(2, "particles-effecs", &m_graphics_quality, "Particles effects: 0 disabled, 1 only important, 2 enabled"))
PARAM_PREFIX IntUserConfigParam m_xmas_mode	PARAM_DEFAULT (IntUserConfigParam(0, "christmas-mode", &m_graphics_quality, "Christmas hats: 0 use current date, 1 always on, 2 always off"))
PARAM_PREFIX IntUserConfigParam m_easter_ear_mode	PARAM_DEFAULT (IntUserConfigParam(0, "easter-ear-mode", &m_graphics_quality, "Easter Bunny Ears: 0 use current date, 1 always on, 2 always off"))
PARAM_PREFIX BoolUserConfigParam m_animated_characters	PARAM_DEFAULT (BoolUserConfigParam(true, "animated-characters", &m_graphics_quality, "Whether to display animated characters"))
PARAM_PREFIX IntUserConfigParam m_geometry_level	PARAM_DEFAULT (IntUserConfigParam(GEOLEVEL_0, "geometry_level", &m_graphics_quality, "Geometry quality 0=everything is displayed; " "1=a few details are displayed; 2=lowest level, no details"))
PARAM_PREFIX IntUserConfigParam m_anisotropic	PARAM_DEFAULT (IntUserConfigParam(4, "anisotropic", &m_graphics_quality, "Quality of anisotropic filtering (usual values include 2-4-8-16; 0 to disable)"))
PARAM_PREFIX IntUserConfigParam m_swap_interval	PARAM_DEFAULT (IntUserConfigParam(0, "swap-interval", &m_graphics_quality, "Swap interval for vsync: 0 = disabled, 1 = full"))
PARAM_PREFIX BoolUserConfigParam m_motionblur	PARAM_DEFAULT (BoolUserConfigParam(false, "motionblur_enabled", &m_graphics_quality, "Whether motion blur should be enabled"))
PARAM_PREFIX BoolUserConfigParam m_mlaa	PARAM_DEFAULT (BoolUserConfigParam(false, "mlaa", &m_graphics_quality, "Whether MLAA anti-aliasing should be enabled"))
PARAM_PREFIX BoolUserConfigParam m_ssao	PARAM_DEFAULT (BoolUserConfigParam(false, "ssao", &m_graphics_quality, "Enable Screen Space Ambient Occlusion"))
PARAM_PREFIX BoolUserConfigParam m_light_scatter	PARAM_DEFAULT (BoolUserConfigParam(true, "light_scatter", &m_graphics_quality, "Enable light scattering shaders"))
PARAM_PREFIX BoolUserConfigParam m_degraded_IBL	PARAM_DEFAULT (BoolUserConfigParam(true, "Degraded_IBL", &m_graphics_quality, "Disable specular IBL"))
PARAM_PREFIX BoolUserConfigParam m_cache_overworld	PARAM_DEFAULT (BoolUserConfigParam(true, "cache-overworld"))
PARAM_PREFIX BoolUserConfigParam m_crashed	PARAM_DEFAULT (BoolUserConfigParam(false, "crashed"))
PARAM_PREFIX GroupUserConfigParam m_camera_normal	PARAM_DEFAULT (GroupUserConfigParam("camera-normal", "Camera settings for player."))
PARAM_PREFIX FloatUserConfigParam m_camera_distance	PARAM_DEFAULT (FloatUserConfigParam(1.0, "distance", &m_camera_normal, "Distance between kart and camera"))
PARAM_PREFIX FloatUserConfigParam m_camera_forward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(0, "forward-up-angle", &m_camera_normal, "Angle between camera and plane of kart (pitch) when the camera is pointing forward"))
PARAM_PREFIX BoolUserConfigParam m_camera_forward_smoothing	PARAM_DEFAULT (BoolUserConfigParam(true, "forward-smoothing", &m_camera_normal, "if true, use smoothing (forward-up-angle become relative to speed) when pointing forward"))
PARAM_PREFIX FloatUserConfigParam m_camera_backward_distance	PARAM_DEFAULT (FloatUserConfigParam(2.0, "backward-distance", &m_camera_normal, "Distance between kart and camera (reverse)"))
PARAM_PREFIX FloatUserConfigParam m_camera_backward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(5, "backward-up-angle", &m_camera_normal, "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view"))
PARAM_PREFIX IntUserConfigParam m_camera_fov	PARAM_DEFAULT (IntUserConfigParam(80, "fov", &m_camera_normal, "Focal distance (single player)"))
PARAM_PREFIX BoolUserConfigParam m_reverse_look_use_soccer_cam	PARAM_DEFAULT (BoolUserConfigParam(false, "reverse-look-use-soccer-cam", "Use ball camera in soccer mode, instead of reverse"))
PARAM_PREFIX IntUserConfigParam m_camera_present	PARAM_DEFAULT (IntUserConfigParam(1, "camera-present", "The current used camera. 0=Custom; 1=Standard; 2=Drone chase"))
PARAM_PREFIX GroupUserConfigParam m_standard_camera_settings	PARAM_DEFAULT (GroupUserConfigParam("standard-camera-settings", "Standard camera settings for player."))
PARAM_PREFIX FloatUserConfigParam m_standard_camera_distance	PARAM_DEFAULT (FloatUserConfigParam(1.0, "distance", &m_standard_camera_settings, "Distance between kart and camera"))
PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(0, "forward-up-angle", &m_standard_camera_settings, "Angle between camera and plane of kart (pitch) when the camera is pointing forward"))
PARAM_PREFIX BoolUserConfigParam m_standard_camera_forward_smoothing	PARAM_DEFAULT (BoolUserConfigParam(true, "forward-smoothing", &m_standard_camera_settings, "if true, use smoothing (forward-up-angle become relative to speed) when pointing forward"))
PARAM_PREFIX FloatUserConfigParam m_standard_camera_backward_distance	PARAM_DEFAULT (FloatUserConfigParam(2.0, "backward-distance", &m_standard_camera_settings, "Distance between kart and camera (reverse)"))
PARAM_PREFIX FloatUserConfigParam m_standard_camera_backward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(5, "backward-up-angle", &m_standard_camera_settings, "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view"))
PARAM_PREFIX IntUserConfigParam m_standard_camera_fov	PARAM_DEFAULT (IntUserConfigParam(80, "fov", &m_standard_camera_settings, "Focal distance (single player)"))
PARAM_PREFIX BoolUserConfigParam m_standard_reverse_look_use_soccer_cam	PARAM_DEFAULT (BoolUserConfigParam(false, "reverse-look-use-soccer-cam", &m_standard_camera_settings, "Use ball camera in soccer mode, instead of reverse"))
PARAM_PREFIX GroupUserConfigParam m_drone_camera_settings	PARAM_DEFAULT (GroupUserConfigParam("drone-camera-settings", "Drone chase camera settings for player."))
PARAM_PREFIX FloatUserConfigParam m_drone_camera_distance	PARAM_DEFAULT (FloatUserConfigParam(2.6, "distance", &m_drone_camera_settings, "Distance between kart and camera"))
PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(33, "forward-up-angle", &m_drone_camera_settings, "Angle between camera and plane of kart (pitch) when the camera is pointing forward"))
PARAM_PREFIX BoolUserConfigParam m_drone_camera_forward_smoothing	PARAM_DEFAULT (BoolUserConfigParam(false, "forward-smoothing", &m_drone_camera_settings, "if true, use smoothing (forward-up-angle become relative to speed) when pointing forward"))
PARAM_PREFIX FloatUserConfigParam m_drone_camera_backward_distance	PARAM_DEFAULT (FloatUserConfigParam(2.0, "backward-distance", &m_drone_camera_settings, "Distance between kart and camera (reverse)"))
PARAM_PREFIX FloatUserConfigParam m_drone_camera_backward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(10, "backward-up-angle", &m_drone_camera_settings, "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view"))
PARAM_PREFIX IntUserConfigParam m_drone_camera_fov	PARAM_DEFAULT (IntUserConfigParam(100, "fov", &m_drone_camera_settings, "Focal distance (single player)"))
PARAM_PREFIX BoolUserConfigParam m_drone_reverse_look_use_soccer_cam	PARAM_DEFAULT (BoolUserConfigParam(false, "reverse-look-use-soccer-cam", &m_drone_camera_settings, "Use ball camera in soccer mode, instead of reverse"))
PARAM_PREFIX GroupUserConfigParam m_saved_camera_settings	PARAM_DEFAULT (GroupUserConfigParam("saved-camera-settings", "Saved custom camera settings for player."))
PARAM_PREFIX FloatUserConfigParam m_saved_camera_distance	PARAM_DEFAULT (FloatUserConfigParam(1.0, "distance", &m_saved_camera_settings, "Distance between kart and camera"))
PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(0, "forward-up-angle", &m_saved_camera_settings, "Angle between camera and plane of kart (pitch) when the camera is pointing forward"))
PARAM_PREFIX BoolUserConfigParam m_saved_camera_forward_smoothing	PARAM_DEFAULT (BoolUserConfigParam(true, "forward-smoothing", &m_saved_camera_settings, "if true, use smoothing (forward-up-angle become relative to speed) when pointing forward"))
PARAM_PREFIX FloatUserConfigParam m_saved_camera_backward_distance	PARAM_DEFAULT (FloatUserConfigParam(2.0, "backward-distance", &m_saved_camera_settings, "Distance between kart and camera (reverse)"))
PARAM_PREFIX FloatUserConfigParam m_saved_camera_backward_up_angle	PARAM_DEFAULT (FloatUserConfigParam(5, "backward-up-angle", &m_saved_camera_settings, "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view"))
PARAM_PREFIX IntUserConfigParam m_saved_camera_fov	PARAM_DEFAULT (IntUserConfigParam(80, "fov", &m_saved_camera_settings, "Focal distance (single player)"))
PARAM_PREFIX BoolUserConfigParam m_saved_reverse_look_use_soccer_cam	PARAM_DEFAULT (BoolUserConfigParam(false, "reverse-look-use-soccer-cam", &m_saved_camera_settings, "Use ball camera in soccer mode, instead of reverse"))
PARAM_PREFIX GroupUserConfigParam m_camera	PARAM_DEFAULT (GroupUserConfigParam("camera", "(Debug) camera settings."))
PARAM_PREFIX IntUserConfigParam m_reverse_look_threshold	PARAM_DEFAULT (IntUserConfigParam(0, "reverse_look_threshold", &m_camera, "If the kart is driving backwards faster than this value,\n" "switch automatically to reverse camera (set to 0 to disable)."))
PARAM_PREFIX FloatUserConfigParam m_fpscam_direction_speed	PARAM_DEFAULT (FloatUserConfigParam(0.003f, "fpscam_rotation_speed", &m_camera, "How fast the first person camera's direction speed changes when\n" "moving the mouse (means acceleration)."))
PARAM_PREFIX FloatUserConfigParam m_fpscam_smooth_direction_max_speed	PARAM_DEFAULT (FloatUserConfigParam(0.04f, "fpscam_smooth_rotation_max_speed", &m_camera, "How fast the first person camera's direction can change."))
PARAM_PREFIX FloatUserConfigParam m_fpscam_angular_velocity	PARAM_DEFAULT (FloatUserConfigParam(0.02f, "fpscam_angular_velocity", &m_camera, "How fast the first person camera's rotation speed changes."))
PARAM_PREFIX FloatUserConfigParam m_fpscam_max_angular_velocity	PARAM_DEFAULT (FloatUserConfigParam(1.0f, "fpscam_max_angular_velocity", &m_camera, "How fast the first person camera can rotate."))
PARAM_PREFIX StringUserConfigParam m_item_style	PARAM_DEFAULT (StringUserConfigParam("items", "item_style", "Name of the .items file to use."))
PARAM_PREFIX StringUserConfigParam m_last_track	PARAM_DEFAULT (StringUserConfigParam("olivermath", "last_track", "Name of the last track used."))
PARAM_PREFIX StringUserConfigParam m_last_used_track_group	PARAM_DEFAULT (StringUserConfigParam("all", "last_track_group", "Last selected track group"))
PARAM_PREFIX StringUserConfigParam m_discord_client_id	PARAM_DEFAULT (StringUserConfigParam("817760324983324753", "discord_client_id", "Discord Client ID (Set to -1 to disable)"))
PARAM_PREFIX BoolUserConfigParam m_rich_presence_debug	PARAM_DEFAULT (BoolUserConfigParam(false, "rich_presence_debug", "If debug logging should be enabled for rich presence"))
PARAM_PREFIX StringUserConfigParam m_skin_file	PARAM_DEFAULT (StringUserConfigParam("peach", "skin_name", "Name of the skin to use"))
PARAM_PREFIX GroupUserConfigParam m_minimap_setup_group	PARAM_DEFAULT (GroupUserConfigParam("Minimap", "Minimap Setup Settings"))
PARAM_PREFIX IntUserConfigParam m_minimap_display	PARAM_DEFAULT (IntUserConfigParam(0, "display", &m_minimap_setup_group, "display: 0 bottom-left, 1 middle-right, 2 hidden, 3 center"))
PARAM_PREFIX FloatUserConfigParam m_minimap_size	PARAM_DEFAULT (FloatUserConfigParam(180.0f, "size", &m_minimap_setup_group, "Size of the the minimap (480 = full screen height; scaled afterwards)"))
PARAM_PREFIX FloatUserConfigParam m_minimap_ai_icon_size	PARAM_DEFAULT (FloatUserConfigParam(16.0f, "ai-icon", &m_minimap_setup_group, "The size of the icons for the AI karts on the minimap."))
PARAM_PREFIX FloatUserConfigParam m_minimap_player_icon_size	PARAM_DEFAULT (FloatUserConfigParam(20.0f, "player-icon", &m_minimap_setup_group, "The size of the icons for the player kart."))
PARAM_PREFIX GroupUserConfigParam m_powerup_setup_group	PARAM_DEFAULT (GroupUserConfigParam("PowerUp", "PowerUp Setup Settings"))
PARAM_PREFIX IntUserConfigParam m_powerup_display	PARAM_DEFAULT (IntUserConfigParam(0, "display", &m_powerup_setup_group, "display: 0 center, 1 right side, 2 hidden (see karts' held powerups)"))
PARAM_PREFIX FloatUserConfigParam m_powerup_size	PARAM_DEFAULT (FloatUserConfigParam(64.0f, "powerup-icon-size", &m_powerup_setup_group, "Size of the powerup icon (scaled afterwards)"))
PARAM_PREFIX GroupUserConfigParam m_spectator	PARAM_DEFAULT (GroupUserConfigParam("Spectator", "Everything related to spectator mode."))
PARAM_PREFIX FloatUserConfigParam m_spectator_camera_distance	PARAM_DEFAULT (FloatUserConfigParam(6.75, "camera-distance", &m_spectator, "Distance between kart and camera."))
PARAM_PREFIX FloatUserConfigParam m_spectator_camera_angle	PARAM_DEFAULT (FloatUserConfigParam(40.0, "camera-angle", &m_spectator, "Angle between ground, kart and camera."))
PARAM_PREFIX GroupUserConfigParam m_handicap	PARAM_DEFAULT (GroupUserConfigParam("Handicap", "Everything related to handicaps."))
PARAM_PREFIX BoolUserConfigParam m_per_player_difficulty	PARAM_DEFAULT (BoolUserConfigParam(false, "per_player_difficulty", &m_handicap, "If handicapped users can be selected"))
PARAM_PREFIX IntUserConfigParam m_internet_status	PARAM_DEFAULT (IntUserConfigParam(0, "enable_internet", "Status of internet: 0 user " "wasn't asked, 1: allowed, 2: " "not allowed"))
PARAM_PREFIX GroupUserConfigParam m_hw_report_group	PARAM_DEFAULT (GroupUserConfigParam("HWReport", "Everything related to hardware configuration."))
PARAM_PREFIX IntUserConfigParam m_last_hw_report_version	PARAM_DEFAULT (IntUserConfigParam(0, "report-version", &m_hw_report_group, "Version of hardware report " "that was reported last"))
PARAM_PREFIX IntUserConfigParam m_random_identifier	PARAM_DEFAULT (IntUserConfigParam(0, "random-identifier", &m_hw_report_group, "A random number to avoid duplicated reports."))
PARAM_PREFIX BoolUserConfigParam m_hw_report_enable	PARAM_DEFAULT (BoolUserConfigParam(false, "hw-report-enabled", &m_hw_report_group, "If HW reports are enabled."))
PARAM_PREFIX BoolUserConfigParam m_always_show_login_screen	PARAM_DEFAULT (BoolUserConfigParam(false, "always_show_login_screen", "Always show the login screen even if last player's session was saved."))
PARAM_PREFIX GroupUserConfigParam m_addon_group	PARAM_DEFAULT (GroupUserConfigParam("AddonServer", "Addon and news related settings"))
PARAM_PREFIX TimeUserConfigParam m_news_last_updated	PARAM_DEFAULT (TimeUserConfigParam(0, "news_last_updated", &m_addon_group, "Time news was updated last."))
PARAM_PREFIX IntUserConfigParam m_news_frequency	PARAM_DEFAULT (IntUserConfigParam(0, "news_frequency", &m_addon_group, "How often news should be updated."))
PARAM_PREFIX StringUserConfigParam m_display_count	PARAM_DEFAULT (StringUserConfigParam("", "news_display_count", &m_addon_group, "How often all news messages " "have been displayed"))
PARAM_PREFIX IntUserConfigParam m_last_important_message_id	PARAM_DEFAULT (IntUserConfigParam(-1, "last_important_message_id", &m_addon_group, "Don't show important message " "with this or a lower id again"))
PARAM_PREFIX TimeUserConfigParam m_addons_last_updated	PARAM_DEFAULT (TimeUserConfigParam(0, "addon_last_updated", &m_addon_group, "Time addon-list was updated last."))
PARAM_PREFIX TimeUserConfigParam m_latest_addon_time	PARAM_DEFAULT (TimeUserConfigParam(0, "latest_addon_time", &m_addon_group, "Latest approved addon time."))
PARAM_PREFIX StringUserConfigParam m_language	PARAM_DEFAULT (StringUserConfigParam("system", "language", "Which language to use (language code or 'system')"))
PARAM_PREFIX BoolUserConfigParam m_artist_debug_mode	PARAM_DEFAULT (BoolUserConfigParam(false, "artist_debug_mode", "Whether to enable track debugging features"))
PARAM_PREFIX BoolUserConfigParam m_hide_gui	PARAM_DEFAULT (BoolUserConfigParam(false, "debug_hide_gui", "Whether to hide the GUI (artist debug mode)"))
PARAM_PREFIX IntUserConfigParam m_unlock_everything	PARAM_DEFAULT (IntUserConfigParam(0, "unlock_everything", "Enable all karts and tracks: 0 = disabled, " "1 = everything except final race, 2 = everything"))
PARAM_PREFIX StringUserConfigParam m_commandline	PARAM_DEFAULT (StringUserConfigParam("", "commandline", "Allows one to set commandline args in config file"))
bool	logMemory ()
	Returns true if the user want additional messages for memory usage.
bool	logGUI ()
	Returns true if the user want additional messages related to GUI.
bool	logAddons ()
	Returns true if the user want additional messages related to addons.
bool	logFlyable ()
	Returns true if the user want additional debug info for flyables.
bool	logMisc ()
	Returns true if the user want additional messages for general items.

Variables
PARAM_PREFIX std::vector< std::string >	m_blacklist_res
PARAM_PREFIX PtrVector< SavedGrandPrix >	m_saved_grand_prix_list
	List of all saved GPs.

Detailed Description

Contains all parameters that are stored in the user's config file.

Function Documentation

PARAM_DEFAULT() [1/3]

PARAM_PREFIX int m_verbosity UserConfigParams::PARAM_DEFAULT

(

0

)

Verbosity level for debug messages.

Note that error and important warnings must always be printed.

PARAM_DEFAULT() [2/3]

PARAM_PREFIX bool m_disable_addon_tracks UserConfigParams::PARAM_DEFAULT

(

false

)

If high scores will not be saved.

True if graphical profiler should be displayed.

True to test funky ambient/diffuse/specularity in RGB & all anisotropic.

True if currently developed tutorial debugging is enabled.

True if follow-the-leader debug information should be printed.

True if slipstream debugging is activated.

True if arena (battle/soccer) ai profiling.

True if FPS should be printed each frame.

True if physics debugging should be enabled.

True if check structures should be debugged.

If track debugging is enabled.

If material debugging (printing terrain specific slowdown) is enabled.

Debug gamepads by visualising their values.

Wiimote debugging.

If keyboard debugging is enabled.

If gamepad debugging is enabled.

If unit testing is enabled.

For repeated testing on tracks.

PARAM_DEFAULT() [3/3]

PARAM_PREFIX IntUserConfigParam m_high_definition_textures UserConfigParams::PARAM_DEFAULT

(

IntUserConfigParam(1, "enable_high_definition_textures", &m_video_group, "Enable high definition textures. Bit flag: " "bit 0 = enabled/disabled; bit 1 = set by user/set as default")

)

This is a bit flag: bit 0: enabled (1) or disabled(0).

Bit 1: setting done by default(0), or by user choice (2). This allows to e.g. disable h.d. textures on hd3000 as default, but still allow the user to enable it.