All Bundles
Hints
Configuration management
Operations
Clear
Clear all hints
function : Clear() ~ NilGet
Get the value of a hint.
function : Get(name:String) ~ StringParameters
| Name | Type | Description |
|---|
| name | String | the hint to query |
Return
| Type | Description |
|---|
| String | the string value of a hint |
Get the boolean value of a hint variable
function : Get(name:String, value:Bool) ~ BoolParameters
| Name | Type | Description |
|---|
| name | String | the hint to query |
| value | Bool | the value to return if the hint does not exist |
Return
| Type | Description |
|---|
| Bool | the boolean value of a hint or the provided default value if the hint does not exist |
Set
Set a hint with normal priority.
function : Set(name:String, value:String) ~ BoolParameters
| Name | Type | Description |
|---|
| name | String | the hint to set; see the list of hints on CategoryHints for details |
| value | String | the value of the hint variable |
Return
| Type | Description |
|---|
| Bool | true if the hint was set, false otherwise |
SetWithPriority
Set a hint with a specific priority
function : SetWithPriority(name:String, value:String, priority:HintPriority) ~ BoolParameters
| Name | Type | Description |
|---|
| name | String | the hint to set; see the list of hints on CategoryHints for details |
| value | String | the value of the hint variable |
| priority | HintPriority | the SDL_HintPriority level for the hint |
Return
| Type | Description |
|---|
| Bool | true if the hint was set, false otherwise |