IConsoleVariable

Interface for console variables

Windows
MacOS
Linux

Inheritance Hierarchy

IConsoleObject

IConsoleVariable

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h

Include

#include "HAL/IConsoleManager.h"

Syntax

class IConsoleVariable : public IConsoleObject

Remarks

Interface for console variables

Functions

Name Description

Public function Const

bool

 

GetBool()

Get the internal value as a bool, works on bools, ints and floats.

Public function Const

float

 

GetFloat()

Get the internal value as float (works on all types).

Public function Const

int32

 

GetInt()

Get the internal value as int (should not be used on strings).

Public function Const

FString

 

GetString()

Get the internal value as string (works on all types).

Public function

void

 

Set

(
    const TCHAR* InValue,
    EConsoleVariableFlags SetBy
)

Set the internal value from the specified string.

Public function

void

 

Set

(
    bool InValue,
    EConsoleVariableFlags SetBy
)

Set the internal value from the specified bool.

Public function

void

 

Set

(
    int32 InValue,
    EConsoleVariableFlags SetBy
)

Set the internal value from the specified int.

Public function

void

 

Set

(
    float InValue,
    EConsoleVariableFlags SetBy
)

Set the internal value from the specified float.

Public function

void

 

SetOnChangedCallback

(
    const FConsoleVariableDelegate& Callback
)

Allows to specify a callback function that is called when the console variable value changes.

Public function

void

 

SetWithCurrentPriority

(
    bool InValue
)

Public function

void

 

SetWithCurrentPriority

(
    int32 InValue
)

Public function

void

 

SetWithCurrentPriority

(
    float InValue
)

Public function

void

 

SetWithCurrentPriority

(
    const TCHAR* InValue
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback