Class: StoryboardSprite

Defined in: src/beatmap/storyboard/elements.ts:8

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addScale(Easing.Out, 0, 1000, 1.1)

return { path: sprite.path, commands: sprite.commands.allCommands().length }

Extended by

• StoryboardAnimation

Constructors

new StoryboardSprite(fileRef, origin?, initialPosition?, source?): StoryboardSprite

Defined in: src/beatmap/storyboard/elements.ts:30

Parameters

Parameter	Type	Default value
fileRef	FileRef	undefined
origin	Anchor	Anchor.Centre
initialPosition?	Vec2	undefined
source?	StoryboardElementSource	undefined

Returns

StoryboardSprite

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addScale(Easing.Out, 0, 1000, 1.1)

return { path: sprite.path, commands: sprite.commands.allCommands().length }

Properties

commands

commands: StoryboardCommandGroup

Defined in: src/beatmap/storyboard/elements.ts:13

---

file

file: FileRef

Defined in: src/beatmap/storyboard/elements.ts:10

---

initialPosition

initialPosition: Vec2

Defined in: src/beatmap/storyboard/elements.ts:12

---

loopingGroups

loopingGroups: StoryboardLoopingGroup[] = []

Defined in: src/beatmap/storyboard/elements.ts:14

---

origin

origin: Anchor

Defined in: src/beatmap/storyboard/elements.ts:11

---

source

source: StoryboardElementSource = 'beatmap'

Defined in: src/beatmap/storyboard/elements.ts:9

---

triggerGroups

triggerGroups: StoryboardTriggerGroup[] = []

Defined in: src/beatmap/storyboard/elements.ts:15

Accessors

endTime

get endTime(): number | undefined

Defined in: src/beatmap/storyboard/elements.ts:40

Returns

number | undefined

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addScale(Easing.Out, 0, 1000, 1.1)
return sprite.endTime

---

path

get path(): string

Defined in: src/beatmap/storyboard/elements.ts:28

Returns

string

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

return sprite.path

---

startTime

get startTime(): number | undefined

Defined in: src/beatmap/storyboard/elements.ts:39

Returns

number | undefined

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addScale(Easing.Out, 0, 1000, 1.1)
return sprite.startTime

Methods

addAlpha()

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

Defined in: src/beatmap/storyboard/elements.ts:60

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

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

---

addBlending()

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

Defined in: src/beatmap/storyboard/elements.ts:81

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addBlending(Easing.None, 0, undefined, 'Additive')
return sprite.commands.blending.length

---

addColour()

addColour(easing, startTime, endTime?, endR?, endG?, endB?, startR?, startG?, startB?): this

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

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endR?	number
endG?	number
endB?	number
startR?	number
startG?	number
startB?	number

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addColour(Easing.Out, 0, 500, 255, 200, 180)
return sprite.commands.colour.length

---

addFlipH()

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

Defined in: src/beatmap/storyboard/elements.ts:79

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addFlipH(Easing.None, 0, undefined, true)
return sprite.commands.flipH.length

---

addFlipV()

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

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

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addFlipV(Easing.None, 0, undefined, true)
return sprite.commands.flipV.length

---

addLoopingGroup()

addLoopingGroup(loopStartTime, totalIterations): StoryboardLoopingGroup

Defined in: src/beatmap/storyboard/elements.ts:83

Parameters

Parameter	Type
loopStartTime	number
totalIterations	number

Returns

StoryboardLoopingGroup

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

const group = sprite.addLoopingGroup(0, 2)
return group.totalIterations

---

addMoveX()

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

Defined in: src/beatmap/storyboard/elements.ts:61

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addMoveX(Easing.Out, 0, 500, 400, 320)
return sprite.commands.x.length

---

addMoveY()

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

Defined in: src/beatmap/storyboard/elements.ts:62

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addMoveY(Easing.Out, 0, 500, 300, 240)
return sprite.commands.y.length

---

addRotation()

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

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

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addRotation(Easing.Out, 0, 500, 1)
return sprite.commands.rotation.length

---

addScale()

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

Defined in: src/beatmap/storyboard/elements.ts:63

Parameters

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

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

---

addTriggerGroup()

addTriggerGroup(triggerName, triggerStartTime, triggerEndTime, groupNumber): StoryboardTriggerGroup

Defined in: src/beatmap/storyboard/elements.ts:91

Parameters

Parameter	Type
triggerName	TriggerName
triggerStartTime	number
triggerEndTime	number
groupNumber	number

Returns

StoryboardTriggerGroup

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

const group = sprite.addTriggerGroup('HitSound', 0, 1000, 0)
return group.triggerName

---

addVectorScale()

addVectorScale(easing, startTime, endTime?, endX?, endY?, startX?, startY?): this

Defined in: src/beatmap/storyboard/elements.ts:64

Parameters

Parameter	Type
easing	Easing
startTime	number
endTime?	number
endX?	number
endY?	number
startX?	number
startY?	number

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addVectorScale(Easing.Out, 0, 500, 1.1, 1.1)
return sprite.commands.vectorScale.length

---

clearLoopingGroups()

clearLoopingGroups(): void

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

Returns

void

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addLoopingGroup(0, 2)
sprite.clearLoopingGroups()
return sprite.loopingGroups.length

---

clearTriggerGroups()

clearTriggerGroups(): void

Defined in: src/beatmap/storyboard/elements.ts:110

Returns

void

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addTriggerGroup('HitSound', 0, 1000, 0)
sprite.clearTriggerGroups()
return sprite.triggerGroups.length

---

clone()

clone(): this

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

Returns

this

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

const copy = sprite.clone()
return { sameFile: copy.path === sprite.path, commands: copy.commands.allCommands().length }

---

removeLoopingGroup()

removeLoopingGroup(indexOrGroup): void

Defined in: src/beatmap/storyboard/elements.ts:99

Parameters

Parameter	Type
indexOrGroup	number | StoryboardLoopingGroup

Returns

void

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addLoopingGroup(0, 2)
sprite.removeLoopingGroup(0)
return sprite.loopingGroups.length

---

removeTriggerGroup()

removeTriggerGroup(indexOrGroup): void

Defined in: src/beatmap/storyboard/elements.ts:105

Parameters

Parameter	Type
indexOrGroup	number | StoryboardTriggerGroup

Returns

void

import { FileRef, Storyboard, StoryboardSprite, Easing } from 'osu-files'

const storyboard = new Storyboard()
const sprite = new StoryboardSprite(
  new FileRef('background.jpg', { hash: 'a'.repeat(64) }),
)
storyboard.getLayer('Foreground').add(sprite)

sprite.addTriggerGroup('HitSound', 0, 1000, 0)
sprite.removeTriggerGroup(0)
return sprite.triggerGroups.length