Interface CreateStoryParams

Parameters passed to the story when it's created

interface CreateStoryParams {
    dontAddDefaultScenes?: boolean;
    logLevel?: uint;
    storyAdapter?: SceneAdapter;
    toStartTeleporting?: boolean;
    toTeleport?: boolean;
}

Properties

dontAddDefaultScenes? logLevel? storyAdapter? toStartTeleporting? toTeleport?

Properties

OptionaldontAddDefaultScenes

dontAddDefaultScenes?: boolean

Adds automatically the default scenes.

OptionallogLevel

logLevel?: uint

Defines the log level. Use LL_VERBOSE for debugging. The server can modify this mode. Set this parameter to log during the constructor phase, otherwise is also possible to set later via story.logLevel.

OptionalstoryAdapter

storyAdapter?: SceneAdapter

Set this value, if you need use a Virtual Story Adapter inside of the default DOM Adapter.

OptionaltoStartTeleporting

toStartTeleporting?: boolean

Set this parameter to false, if you need to inject html/css code into the page before the teleporting process starts.

Default

true

OptionaltoTeleport

toTeleport?: boolean

Defines if the story is going to be teleported.

Settings

Member Visibility

On This Page

Properties