SceneBasics
Provides scene basics.
Table of Contents
- $description : string
- $template : SceneTemplate|null
- $title : string
- getDescription() : string
- Returns scene description.
- getTemplate() : SceneTemplate|null
- Returns scene template.
- getTitle() : string
- Returns scene title.
- setDescription() : mixed
- Sets scene description.
- setTemplate() : mixed
- Sets scene template.
- setTitle() : mixed
- Sets scene title.
Properties
$description
private
string
$description
= "{No scene set}"
Tags
$template
private
SceneTemplate|null
$template
Tags
$title
private
string
$title
= "{No scene set}"
Tags
Methods
getDescription()
Returns scene description.
public
getDescription() : string
Return values
string —getTemplate()
Returns scene template.
public
getTemplate() : SceneTemplate|null
Return values
SceneTemplate|null —getTitle()
Returns scene title.
public
getTitle() : string
Return values
string —setDescription()
Sets scene description.
public
setDescription(string $description) : mixed
Parameters
- $description : string
Return values
mixed —setTemplate()
Sets scene template.
public
setTemplate(SceneTemplate|null $template) : mixed
Parameters
- $template : SceneTemplate|null
Return values
mixed —setTitle()
Sets scene title.
public
setTitle(string $title) : mixed
Parameters
- $title : string