Class: StoryboardCommandGroup

Defined in: src/beatmap/storyboard/commands.ts:59

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().map(command => command.commandType)

Extended by

• StoryboardLoopingGroup
• StoryboardTriggerGroup

Constructors

new StoryboardCommandGroup(): StoryboardCommandGroup

Returns

StoryboardCommandGroup

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().map(command => command.commandType)

Properties

alpha

alpha: StoryboardAlphaCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:67

---

blending

blending: StoryboardBlendingCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:76

---

colour

colour: StoryboardColourCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:73

---

flipH

flipH: StoryboardFlipHCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:74

---

flipV

flipV: StoryboardFlipVCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:75

---

rotation

rotation: StoryboardRotationCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:72

---

scale

scale: StoryboardScaleCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:70

---

vectorScale

vectorScale: StoryboardVectorScaleCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:71

---

x

x: StoryboardXCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:68

---

y

y: StoryboardYCommand[] = []

Defined in: src/beatmap/storyboard/commands.ts:69

Accessors

endTime

get endTime(): number | undefined

Defined in: src/beatmap/storyboard/commands.ts:88

Returns

number | undefined

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.endTime

---

startTime

get startTime(): number | undefined

Defined in: src/beatmap/storyboard/commands.ts:80

Returns

number | undefined

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.startTime

Methods

addAlpha()

addAlpha(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:104

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	number
startValue?	number

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.addAlpha(Easing.Out, 0, 500, 1, 0)
return commands.alpha.length

---

addBlending()

addBlending(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:140

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	BlendingMode
startValue?	BlendingMode

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

addColour()

addColour(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:128

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	Colour4
startValue?	Colour4

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

addFlipH()

addFlipH(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:132

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	boolean
startValue?	boolean

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

addFlipV()

addFlipV(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:136

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	boolean
startValue?	boolean

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

addRotation()

addRotation(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:124

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	number
startValue?	number

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

addScale()

addScale(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:116

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	number
startValue?	number

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.addScale(Easing.Out, 0, 500, 1.1, 1)
return commands.scale.length

---

addVectorScale()

addVectorScale(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:120

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	Vec2
startValue?	Vec2

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

addX()

addX(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:108

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	number
startValue?	number

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.addX(Easing.Out, 0, 500, 320, 0)
return commands.x.length

---

addY()

addY(easing, startTime, endTime?, endValue?, startValue?): this

Defined in: src/beatmap/storyboard/commands.ts:112

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endValue?	number
startValue?	number

Returns

this

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.addY(Easing.Out, 0, 500, 240, 0)
return commands.y.length

---

allCommands()

allCommands(): StoryboardCommand<unknown>[]

Defined in: src/beatmap/storyboard/commands.ts:97

Returns

StoryboardCommand<unknown>[]

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().map(command => command.commandType)

---

arrayFor()

arrayFor(type): StoryboardCommand<unknown>[]

Defined in: src/beatmap/storyboard/commands.ts:216

Find the correct array for a command type.

Parameters

Parameter	Type
type	CommandType

Returns

StoryboardCommand<unknown>[]

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.arrayFor(CommandType.Fade).length

---

clearAll()

clearAll(): void

Defined in: src/beatmap/storyboard/commands.ts:198

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.clearAll()
return commands.allCommands().length

---

clearAlpha()

clearAlpha(): void

Defined in: src/beatmap/storyboard/commands.ts:156

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.clearAlpha()
return commands.alpha.length

---

clearBlending()

clearBlending(): void

Defined in: src/beatmap/storyboard/commands.ts:165

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearColour()

clearColour(): void

Defined in: src/beatmap/storyboard/commands.ts:162

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearFlipH()

clearFlipH(): void

Defined in: src/beatmap/storyboard/commands.ts:163

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearFlipV()

clearFlipV(): void

Defined in: src/beatmap/storyboard/commands.ts:164

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearRotation()

clearRotation(): void

Defined in: src/beatmap/storyboard/commands.ts:161

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearScale()

clearScale(): void

Defined in: src/beatmap/storyboard/commands.ts:159

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearVectorScale()

clearVectorScale(): void

Defined in: src/beatmap/storyboard/commands.ts:160

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearX()

clearX(): void

Defined in: src/beatmap/storyboard/commands.ts:157

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

clearY()

clearY(): void

Defined in: src/beatmap/storyboard/commands.ts:158

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeAlpha()

removeAlpha(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:145

Parameters

Parameter	Type
indexOrCmd	number | StoryboardAlphaCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.removeAlpha(0)
return commands.alpha.length

---

removeBlending()

removeBlending(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:154

Parameters

Parameter	Type
indexOrCmd	number | StoryboardBlendingCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeColour()

removeColour(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:151

Parameters

Parameter	Type
indexOrCmd	number | StoryboardColourCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeCommand()

removeCommand(cmd): void

Defined in: src/beatmap/storyboard/commands.ts:191

Parameters

Parameter	Type
cmd	StoryboardCommand<unknown>

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeFlipH()

removeFlipH(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:152

Parameters

Parameter	Type
indexOrCmd	number | StoryboardFlipHCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeFlipV()

removeFlipV(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:153

Parameters

Parameter	Type
indexOrCmd	number | StoryboardFlipVCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeRotation()

removeRotation(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:150

Parameters

Parameter	Type
indexOrCmd	number | StoryboardRotationCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeScale()

removeScale(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:148

Parameters

Parameter	Type
indexOrCmd	number | StoryboardScaleCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeVectorScale()

removeVectorScale(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:149

Parameters

Parameter	Type
indexOrCmd	number | StoryboardVectorScaleCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeX()

removeX(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:146

Parameters

Parameter	Type
indexOrCmd	number | StoryboardXCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

removeY()

removeY(indexOrCmd): void

Defined in: src/beatmap/storyboard/commands.ts:147

Parameters

Parameter	Type
indexOrCmd	number | StoryboardYCommand

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setAlpha()

setAlpha(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:167

Parameters

Parameter	Type
index	number
v	FloatValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.setAlpha(0, { endValue: 0.5 })
return commands.alpha[0]?.endValue

---

setBlending()

setBlending(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:176

Parameters

Parameter	Type
index	number
v	BlendingValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setColour()

setColour(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:173

Parameters

Parameter	Type
index	number
v	ColourValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setFlipH()

setFlipH(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:174

Parameters

Parameter	Type
index	number
v	BoolValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setFlipV()

setFlipV(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:175

Parameters

Parameter	Type
index	number
v	BoolValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setRotation()

setRotation(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:172

Parameters

Parameter	Type
index	number
v	FloatValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setScale()

setScale(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:170

Parameters

Parameter	Type
index	number
v	FloatValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setVectorScale()

setVectorScale(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:171

Parameters

Parameter	Type
index	number
v	Vec2Values

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setX()

setX(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:168

Parameters

Parameter	Type
index	number
v	FloatValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

setY()

setY(index, v): void

Defined in: src/beatmap/storyboard/commands.ts:169

Parameters

Parameter	Type
index	number
v	FloatValues

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

return commands.allCommands().length

---

shiftTimes()

shiftTimes(offsetMs): void

Defined in: src/beatmap/storyboard/commands.ts:203

Parameters

Parameter	Type
offsetMs	number

Returns

void

import { CommandType, Easing, StoryboardCommandGroup } from 'osu-files'

const commands = new StoryboardCommandGroup()
commands.addAlpha(Easing.Out, 0, 1000, 1, 0)

commands.shiftTimes(250)
return commands.startTime