Class TransitionPropertiesCommand

Base command type for a full writable command, which uses flags to indicate the changed properties

Hierarchy

WritableCommand<OmitReadonly<TransitionProperties>>
- TransitionPropertiesCommand

Index

Constructors

Properties

_properties flag mixEffect runOrderGroup? MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new TransitionPropertiesCommand(mixEffect): TransitionPropertiesCommand
Parameters
- mixEffect: number
Returns TransitionPropertiesCommand
Overrides WritableCommand.constructor
- Defined in src/commands/MixEffects/Transition/TransitionPropertiesCommand.ts:17

Properties

`Protected` _properties

_properties: Partial<OmitReadonly<TransitionProperties>>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Static` MaskFlags

MaskFlags: {
nextSelection: number;
nextStyle: number;
} = ...

Type declaration

nextSelection: number
nextStyle: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CTTp" = 'CTTp'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from WritableCommand.properties
- Defined in src/commands/CommandBase.ts:47

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
Inherited from WritableCommand._updateProps
- Defined in src/commands/CommandBase.ts:75

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/MixEffects/Transition/TransitionPropertiesCommand.ts:23

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<OmitReadonly<TransitionProperties>>
Returns boolean
Inherited from WritableCommand.updateProps
- Defined in src/commands/CommandBase.ts:71

Generated using TypeDoc