-
Notifications
You must be signed in to change notification settings - Fork 1
Scene
-
↳
Scene
- _clone
- _patch
- _update
- actionFor
- createActionFor
- delete
- edit
- editActionFor
- isType
- recall
- setActions
- setArcheType
- setName
• new Scene(bridge, data)
| Name | Type |
|---|---|
bridge |
Hue |
data |
SceneGet & { metadata: { archetype: ArcheType ; name: string } } |
src/structures/NamedResource.ts:15
• data: SceneGet & { metadata: { archetype: ArcheType ; name: string } }
src/structures/NamedResource.ts:13
• Readonly hue: Hue
• type: ResourceType = ResourceType.Scene
• get actions(): SceneAction[]
• get archeType(): ArcheType
NamedResource.archeType
src/structures/NamedResource.ts:24
• get groupId(): string
string
• get id(): string
string
NamedResource.id
• get identifier(): ResourceIdentifier<ResourceType>
ResourceIdentifier<ResourceType>
NamedResource.identifier
• get manager(): SceneManager
NamedResource.manager
• get name(): string
string
NamedResource.name
src/structures/NamedResource.ts:20
• get speed(): number
number
▸ _clone(): Scene
▸ _patch(data): void
| Name | Type |
|---|---|
data |
Partial<SceneGet> |
void
▸ _update(data): Scene
| Name | Type |
|---|---|
data |
Partial<SceneGet> |
▸ actionFor(id): undefined | SceneAction
| Name | Type |
|---|---|
id |
string |
undefined | SceneAction
▸ createActionFor(id, options): Promise<void>
| Name | Type |
|---|---|
id |
string |
options |
Omit<SceneAction, "id"> |
Promise<void>
▸ delete(): Promise<void>
Promise<void>
▸ edit(options): Promise<void>
| Name | Type |
|---|---|
options |
SceneEditOptions |
Promise<void>
▸ editActionFor(id, options): Promise<void>
| Name | Type |
|---|---|
id |
string |
options |
Omit<SceneAction, "id"> |
Promise<void>
▸ isType<T>(type): this is NarrowResource<T>
| Name | Type |
|---|---|
T |
extends ResourceType
|
| Name | Type |
|---|---|
type |
T |
this is NarrowResource<T>
▸ recall(options?): Promise<void>
| Name | Type |
|---|---|
options? |
Object |
options.action? |
"active" | "dynamic_palette"
|
options.brightness? |
number |
options.duration? |
number |
Promise<void>
▸ setActions(actions): Promise<void>
| Name | Type |
|---|---|
actions |
SceneAction[] |
Promise<void>
▸ setArcheType(archeType): Promise<void>
| Name | Type |
|---|---|
archeType |
ArcheType |
Promise<void>
src/structures/NamedResource.ts:32
▸ setName(name): Promise<void>
| Name | Type |
|---|---|
name |
string |
Promise<void>