Map:Save

This method saves a scene to a file or stream.

Syntax

• boolean Save(string path, number flags = SAVE_DEFAULT)
• boolean Save(Stream stream, number flags = SAVE_DEFAULT)

Returns

If the scene is successfully saved true is returned, otherwise false is returned.

Remarks

This feature is in continued development and its behavior may change somewhat in future updates.

Example

This example saves the starting scene and reloads it when the space key is pressed.

-- Get the displays
local displays = GetDisplays()

-- Create a window
local window = CreateWindow("Ultra Engine", 0, 0, 1280, 720, displays[1], WINDOW_CENTER + WINDOW_TITLEBAR)

-- Create a world
local world = CreateWorld()

-- Create a framebuffer
local framebuffer = CreateFramebuffer(window)

-- Create a camera
local camera = CreateCamera(world)
camera:SetClearColor(0.125)
camera:SetPosition(0, 1, -4)

-- Create light
local light = CreateBoxLight(world)
light:SetRange(-10, 10)
light:SetArea(15, 15)
light:SetRotation(45, 35, 0)
light:SetColor(2)

-- Create the ground
local ground = CreateBox(world, 10, 1, 10)
ground:SetPosition(0, -0.5, 0)
ground:SetColor(0, 1, 0)

-- Create a scene
local scene = CreateMap()

-- Add some boxes
for n = 1, 10 do
    local box = CreateBox(world)
    box:SetColor(0, 0, 1)
    box:SetPosition(Random(-5, 5), Random(5, 10), Random(-5, 5))
    box:SetMass(1)
    scene.entities[#scene.entities + 1] = box
end

-- Save the starting scene to a file
scene:Save("game.sav")

-- Main loop
while not window:Closed() and not window:KeyDown(KEY_ESCAPE) do

    -- Reload the starting scene when space key is pressed
    if window:KeyHit(KEY_SPACE) then
        scene:Reload("game.sav")
    end

    world:Update()
    world:Render(framebuffer)
end