Home

Hints

Configuration management

Operations

Clear

Clear all hints

function : public : Clear() ~ Nil

Get

Get the value of a hint.

function : public : Get(name:String) ~ String
Parameters
NameTypeDescription
nameStringthe hint to query

Return
TypeDescription
Stringthe string value of a hint

Set

Set a hint with normal priority.

function : public : Set(name:String, value:String) ~ Bool
Parameters
NameTypeDescription
nameStringthe hint to set; see the list of hints on CategoryHints for details
valueStringthe value of the hint variable

Return
TypeDescription
Booltrue if the hint was set, false otherwise

SetWithPriority

Set a hint with a specific priority

function : public : SetWithPriority(name:String, value:String, priority:HintPriority) ~ Bool
Parameters
NameTypeDescription
nameStringthe hint to set; see the list of hints on CategoryHints for details
valueStringthe value of the hint variable
priorityHintPrioritythe SDL_HintPriority level for the hint

Return
TypeDescription
Booltrue if the hint was set, false otherwise