unreal.ConsoleVariablesEditorFunctionLibrary
¶
- class unreal.ConsoleVariablesEditorFunctionLibrary(outer=None, name='None')¶
Bases:
unreal.BlueprintFunctionLibrary
An asset used to track collections of console variables that can be recalled and edited using the Console Variables Editor.
C++ Source:
Plugin: ConsoleVariables
Module: ConsoleVariablesEditor
File: ConsoleVariablesEditorFunctionLibrary.h
- classmethod add_validated_command_to_current_preset(new_command) bool ¶
Adds a validated command to the current preset with its current value.
The Asset will not be automatically saved.
- classmethod copy_current_list_to_asset(asset) bool ¶
Saves the current list in the Console Variables Editor to the given asset.
The Asset will not be automatically saved.
- Parameters
asset (ConsoleVariablesAsset) –
- Returns
true if successful.
- Return type
- classmethod get_console_variable_source_by_name(command_name) str or None ¶
Set a console variable value directly. Returns true if the console object exists.
- classmethod get_console_variable_string_value(command_name) str or None ¶
Get a console variable’s string value directly. Returns true if the console object exists.
- classmethod get_currently_loaded_preset() ConsoleVariablesAsset ¶
Return the currently loaded list of variables in the Console Variables Editor.
- Return type
- classmethod get_enable_multi_user_c_var_sync() bool ¶
Return whether the Multi-user sync setting for the current instance of the editor is enabled.
- Return type
- classmethod get_list_of_commands_from_preset(asset) Array(str) or None ¶
Return an array of strings containing the command names for each command found in the given preset.
- Parameters
asset (ConsoleVariablesAsset) –
- Returns
out_command_list (Array(str)):
- Return type
- classmethod load_preset_into_console_variables_editor(asset) None ¶
Loads the given asset in the Console Variables Editor and sets all its variable values.
- Parameters
asset (ConsoleVariablesAsset) –
- classmethod remove_command_from_current_preset(new_command) bool ¶
Removes a command from the current preset if it exists in the saved data.
The Asset will not be automatically saved.
- classmethod set_console_variable_by_name_bool(command_name, value) bool ¶
Set a console variable value directly. Returns true if the console object exists.
- classmethod set_console_variable_by_name_float(command_name, value) bool ¶
Set a console variable value directly. Returns true if the console object exists.
- classmethod set_console_variable_by_name_int(command_name, value) bool ¶
Set a console variable value directly. Returns true if the console object exists.