🏝️ Level
Work with Unreal level in runtime.
🗿Static Class
This is a Static Class. Access it's methods directly with
.. It's not possible to spawn new instances.💂Authority
This static class can be accessed only on 🟧 Client side.
🧑💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
🗿 Static Functions
| Returns | Name | Description | |
|---|---|---|---|
 | varargs of any | CallLevelBlueprintEvent | Calls a Level Blueprint custom event (which can be added when creating levels through Unreal Engine) |
| table of table | GetStreamLevels | Gets a list of all Stream Levels |
| LoadStreamLevel | Loads a Level in runtime | |
| SetStreamLevelVisibility | Sets a Stream Level visibility | |
| UnloadStreamLevel | Unloads a Level in runtime |
CallLevelBlueprintEvent
Calls a Level Blueprint custom event (which can be added when creating levels through Unreal Engine)
— Returns varargs of any (the function return values).
local ret_01, ret_02, ... = Level.CallLevelBlueprintEvent(event_name, arguments...?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | event_name | Required parameter | Event or Function name |
| any | arguments...? | nil | Sequence of arguments to pass to the event |
GetStreamLevels
Gets a list of all Stream Levels
— Returns table of table (with this format).
local ret = Level.GetStreamLevels()
LoadStreamLevel
Loads a Level in runtime
Level.LoadStreamLevel(level_name, should_block_on_load?, make_visible_after_load?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | level_name | Required parameter | No description provided |
| boolean | should_block_on_load? | false | If this should be a blocking operation - the game will freeze |
| boolean | make_visible_after_load? | true | If this should be visible automatically after loaded |
SetStreamLevelVisibility
Sets a Stream Level visibility
Level.SetStreamLevelVisibility(level_name, visibility)
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | level_name | Required parameter | No description provided |
| boolean | visibility | Required parameter | If this level should be visible |
UnloadStreamLevel
Unloads a Level in runtime
Level.UnloadStreamLevel(level_name, should_block_on_unload?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| string | level_name | Required parameter | No description provided |
| boolean | should_block_on_unload? | false | If this should be a blocking operation - the game will freeze |
🚀 Events
| Name | Description | |
|---|---|---|
| StreamLevelHide | Called when a Stream Level is hidden |
| StreamLevelLoad | Called when a Stream Level is loaded |
| StreamLevelShow | Called when a Stream Level is shown |
| StreamLevelUnload | Called when a Stream Level is unloaded |
StreamLevelHide
Called when a Stream Level is hidden
Level.Subscribe("StreamLevelHide", function(level_name)
-- StreamLevelHide was called
end)
| Type | Argument | Description |
|---|---|---|
| string | level_name | No description provided |
StreamLevelLoad
Called when a Stream Level is loaded
Level.Subscribe("StreamLevelLoad", function(level_name)
-- StreamLevelLoad was called
end)
| Type | Argument | Description |
|---|---|---|
| string | level_name | No description provided |
StreamLevelShow
Called when a Stream Level is shown
Level.Subscribe("StreamLevelShow", function(level_name)
-- StreamLevelShow was called
end)
| Type | Argument | Description |
|---|---|---|
| string | level_name | No description provided |
StreamLevelUnload
Called when a Stream Level is unloaded
Level.Subscribe("StreamLevelUnload", function(level_name)
-- StreamLevelUnload was called
end)
| Type | Argument | Description |
|---|---|---|
| string | level_name | No description provided |