Difference between revisions of "Osiris/API/IsGameLevel"
From Divinity Engine Wiki
(IsGameLevel documentation) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
* query '''IsGameLevel'''('''''[in]'''(STRING)'''''_LevelName''', '''''[out]'''''(INTEGER)'''_Bool''') | * query '''IsGameLevel'''('''''[in]'''(STRING)'''''_LevelName''', '''''[out]'''''(INTEGER)'''_Bool''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Returns whether whether the | + | Returns whether whether the '''''current''''' level is a non-character-creation, non-lobby level. |
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Default result. | * '''Success/Failure''': Default result. | ||
| − | * '''_Bool''': '''1''' if the level | + | * '''_Bool''': '''1''' if the current level is a non-character-creation, non-lobby level, '''0''' if not'''.''' |
===== Notes ===== | ===== Notes ===== | ||
| + | * The '''_LevelName''' parameter is ignored | ||
* The character creation and lobby level for your mod can be specified in the [[Project_settings_window|project settings]] of your mod. | * The character creation and lobby level for your mod can be specified in the [[Project_settings_window|project settings]] of your mod. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/GameStarted|GameStarted]] | * [[Osiris/API/GameStarted|GameStarted]] | ||
* [[Osiris/API/RegionStarted|RegionStarted]] | * [[Osiris/API/RegionStarted|RegionStarted]] | ||
| − | + | * Helper [[Osiris/Shared/DB_CurrentLevel|DB_CurrentLevel]] | |
| − | [[Category:Osiris Queries]] | + | |
| + | [[Category:Osiris Queries|IsGameLevel]] | ||
Latest revision as of 17:09, 11 June 2019
Full Definition(s)
- query IsGameLevel([in](STRING)_LevelName, [out](INTEGER)_Bool)
Description
Returns whether whether the current level is a non-character-creation, non-lobby level.
Return Values
- Success/Failure: Default result.
- _Bool: 1 if the current level is a non-character-creation, non-lobby level, 0 if not.
Notes
- The _LevelName parameter is ignored
- The character creation and lobby level for your mod can be specified in the project settings of your mod.
