[Command] setBackground3D

[Raddeck]

setBackground3D(relative/path/to/3d-scene.lpworld, permanent, waitForComplete)


USE:
Set a 3D background for the current scene. This function works asynchronously.
(So the function returns while the background is still loading.)
The Background set by this function is cleared at the end of each scene. (By SceneEnd())
This function will trigger random animations for any Actor in the location after loading the 3D world.

The boolean parameter "permanent" will make the LPWORLD stay after SceneEnd() calls.
The boolean parameter "waitForComplete" will break the scene until the background is loaded.


HINT:
Call "setBackground" before setBackground3D() to:

1. Handle non existing rooms
2. Give the dress() function a clue, how to dress the actors!

TYPE: Command, non-Ref
RETURNS: /
THEME: Scenes, Location
COMPARE: sceneStart, dress, setBackground, setBackgroundCustom, clearBackground3d


EXAMPLE:

Code: Select all

    setBackground(work)
    setBackground3D(Modules/nn_PornEmpire/Rooms/nn_pe_office_1.lpworld)
    Player.dress()      // Player will be in a 3D room if PornEmpire mod is installed and wear office clothing
    Player.show()