Skip to main content
Version: bleeding-edge 🩸

🏝️ 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​

ReturnsNameDescription
varargs of anyCallLevelBlueprintEventCalls a Level Blueprint custom event (which can be added when creating levels through Unreal Engine)
table of tableGetStreamLevelsGets a list of all Stream Levels
LoadStreamLevelLoads a Level in runtime
SetStreamLevelVisibilitySets a Stream Level visibility
UnloadStreamLevelUnloads 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...?)
TypeParameterDefaultDescription
stringevent_name Required parameter Event or Function name
anyarguments...?nilSequence 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?)
TypeParameterDefaultDescription
stringlevel_name Required parameter No description provided
booleanshould_block_on_load?falseIf this should be a blocking operation - the game will freeze
booleanmake_visible_after_load?trueIf this should be visible automatically after loaded

SetStreamLevelVisibility

Sets a Stream Level visibility

Level.SetStreamLevelVisibility(level_name, visibility)
TypeParameterDefaultDescription
stringlevel_name Required parameter No description provided
booleanvisibility Required parameter If this level should be visible

UnloadStreamLevel

Unloads a Level in runtime

Level.UnloadStreamLevel(level_name, should_block_on_unload?)
TypeParameterDefaultDescription
stringlevel_name Required parameter No description provided
booleanshould_block_on_unload?falseIf this should be a blocking operation - the game will freeze

🚀 Events​

NameDescription
StreamLevelHideCalled when a Stream Level is hidden
StreamLevelLoadCalled when a Stream Level is loaded
StreamLevelShowCalled when a Stream Level is shown
StreamLevelUnloadCalled when a Stream Level is unloaded

StreamLevelHide

Called when a Stream Level is hidden
Level.Subscribe("StreamLevelHide", function(level_name)
-- StreamLevelHide was called
end)
TypeArgumentDescription
stringlevel_nameNo description provided

StreamLevelLoad

Called when a Stream Level is loaded
Level.Subscribe("StreamLevelLoad", function(level_name)
-- StreamLevelLoad was called
end)
TypeArgumentDescription
stringlevel_nameNo description provided

StreamLevelShow

Called when a Stream Level is shown
Level.Subscribe("StreamLevelShow", function(level_name)
-- StreamLevelShow was called
end)
TypeArgumentDescription
stringlevel_nameNo description provided

StreamLevelUnload

Called when a Stream Level is unloaded
Level.Subscribe("StreamLevelUnload", function(level_name)
-- StreamLevelUnload was called
end)
TypeArgumentDescription
stringlevel_nameNo description provided