Class CommandTrigger

A command timeline group.

Hierarchy (view full)

CommandTimelineGroup
- CommandTrigger

Index

Constructors

Properties

_timelines alpha blendingParameters color flipH flipV groupNumber rotation scale triggerEndTime triggerName triggerStartTime type vectorScale x y

Accessors

commands commandsDuration commandsEndTime commandsStartTime duration endTime hasCommands startTime timelines totalCommands

Methods

Constructors

constructor

new CommandTrigger(triggerName?, startTime?, endTime?, groupNumber?): CommandTrigger
Creates a new instance of command trigger.
Parameters
- Optional triggerName: string
  The name of the trigger.
- Optional startTime: number
  The start time of the command trigger.
- Optional endTime: number
  The end time of the command trigger.
- Optional groupNumber: number
  The group of the command trigger.
Returns CommandTrigger
Overrides CommandTimelineGroup.constructor
- Defined in src/Storyboards/Commands/CommandTrigger.ts:38

Properties

`Readonly` _timelines

_timelines: CommandTimeline<any>[]

alpha

alpha: CommandTimeline<number> = ...

blendingParameters

blendingParameters: CommandTimeline<BlendingParameters> = ...

color

color: CommandTimeline<Color4> = ...

flipH

flipH: CommandTimeline<boolean> = ...

flipV

flipV: CommandTimeline<boolean> = ...

groupNumber

groupNumber: number

The group of the command trigger.

rotation

rotation: CommandTimeline<number> = ...

scale

scale: CommandTimeline<number> = ...

triggerEndTime

triggerEndTime: number

The end time of the command trigger.

triggerName

triggerName: string

The name of the trigger.

triggerStartTime

triggerStartTime: number

The start time of the command trigger.

type

type: CompoundType = CompoundType.Trigger

Compound type.

vectorScale

vectorScale: CommandTimeline<Vector2> = ...

x

x: CommandTimeline<number> = ...

y

y: CommandTimeline<number> = ...

Accessors

commands

get commands(): Command<any>[]
Returns Command<any>[]
Inherited from CommandTimelineGroup.commands
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:46

commandsDuration

get commandsDuration(): number
Returns number
Inherited from CommandTimelineGroup.commandsDuration
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:72

commandsEndTime

get commandsEndTime(): number
Returns number
Inherited from CommandTimelineGroup.commandsEndTime
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:62

commandsStartTime

get commandsStartTime(): number
Returns number
Inherited from CommandTimelineGroup.commandsStartTime
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:52

duration

get duration(): number
Returns number
Inherited from CommandTimelineGroup.duration
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:84

endTime

get endTime(): number
Returns number
Inherited from CommandTimelineGroup.endTime
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:80

hasCommands

get hasCommands(): boolean
Returns boolean
Inherited from CommandTimelineGroup.hasCommands
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:88

startTime

get startTime(): number
Returns number
Inherited from CommandTimelineGroup.startTime
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:76

timelines

get timelines(): CommandTimeline<any>[]
Returns CommandTimeline<any>[]
Inherited from CommandTimelineGroup.timelines
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:38

totalCommands

get totalCommands(): number
Returns number
Inherited from CommandTimelineGroup.totalCommands
- Defined in src/Storyboards/Commands/CommandTimelineGroup.ts:42

Methods

unrollCommands

unrollCommands(): Command<any>[]
Returns Command<any>[]
- Defined in src/Storyboards/Commands/CommandTrigger.ts:47