SceneConnectionGroup
in package
implements
SceneConnectable
Tags
Interfaces, Classes and Traits
Table of Contents
- $name : string
- $scene : Scene|null
- $title : string
- __construct() : mixed
- SceneConnectionGroup constructor.
- __toString() : string
- connect() : SceneConnection
- Creates an outgoing connection for this scene to the given connectable.
- getName() : string
- Returns the name-identifier of this connection group.
- getScene() : Scene
- Returns the scene associated with this connection group.
- getTitle() : string
- Returns the title of this connection group.
- setName() : mixed
- Sets the name-identifier of this connection group.
- setScene() : void
- Sets the scene associated with this connection group.
- setTitle() : mixed
- Sets the title of this connection group.
Properties
$name
private
string
$name
Tags
$scene
private
Scene|null
$scene
= null
Tags
$title
private
string
$title
Tags
Methods
__construct()
SceneConnectionGroup constructor.
public
__construct(string $name, string $title) : mixed
Parameters
- $name : string
-
Soft-identifier of the connection group, e.g. lotgd/core
- $title : string
Return values
mixed —__toString()
public
__toString() : string
Return values
string —connect()
Creates an outgoing connection for this scene to the given connectable.
public
connect(SceneConnectable $connectable[, int|null $directionality = null ]) : SceneConnection
Parameters
- $connectable : SceneConnectable
- $directionality : int|null = null
Tags
Return values
SceneConnection —getName()
Returns the name-identifier of this connection group.
public
getName() : string
Return values
string —getScene()
Returns the scene associated with this connection group.
public
getScene() : Scene
Return values
Scene —getTitle()
Returns the title of this connection group.
public
getTitle() : string
Return values
string —setName()
Sets the name-identifier of this connection group.
public
setName(string $name) : mixed
Parameters
- $name : string
Return values
mixed —setScene()
Sets the scene associated with this connection group.
public
setScene(Scene $scene) : void
Parameters
- $scene : Scene
Return values
void —setTitle()
Sets the title of this connection group.
public
setTitle(string $title) : mixed
Parameters
- $title : string