Class: StoryboardLayer

Defined in: src/beatmap/storyboard/layer.ts:6

import { StoryboardLayer } from 'osu-files'

const layer = new StoryboardLayer('Foreground', 0)

return { name: layer.name, depth: layer.depth, count: layer.count }

Constructors

new StoryboardLayer(name, depth): StoryboardLayer

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

Parameters

Parameter	Type
name	string
depth	number

Returns

StoryboardLayer

import { StoryboardLayer } from 'osu-files'

const layer = new StoryboardLayer('Foreground', 0)

return { name: layer.name, depth: layer.depth, count: layer.count }

Properties

depth

depth: number

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

---

elements

elements: StoryboardElement[] = []

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

---

masking

masking: boolean = false

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

---

name

name: string

Defined in: src/beatmap/storyboard/layer.ts:7

---

visibleWhenFailing

visibleWhenFailing: boolean = true

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

---

visibleWhenPassing

visibleWhenPassing: boolean = true

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

Accessors

count

get count(): number

Defined in: src/beatmap/storyboard/layer.ts:20

Returns

number

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 layer = storyboard.getLayer('Foreground')

return layer.count

Methods

add()

add(el): void

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

Parameters

Parameter	Type
el	StoryboardElement

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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
return layer.count

---

clear()

clear(): void

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

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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
layer.clear()
return layer.count

---

get()

get(index): StoryboardElement | undefined

Defined in: src/beatmap/storyboard/layer.ts:36

Parameters

Parameter	Type
index	number

Returns

StoryboardElement | 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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
return layer.get(0)?.path

---

insertAt()

insertAt(index, el): void

Defined in: src/beatmap/storyboard/layer.ts:55

Parameters

Parameter	Type
index	number
el	StoryboardElement

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)

const layer = storyboard.getLayer('Foreground')

layer.insertAt(0, sprite)
return layer.get(0)?.path

---

moveDown()

moveDown(el): void

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

Parameters

Parameter	Type
el	StoryboardElement

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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
layer.moveDown(sprite)
return layer.get(0)?.path

---

moveUp()

moveUp(el): void

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

Parameters

Parameter	Type
el	StoryboardElement

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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
layer.moveUp(sprite)
return layer.get(0)?.path

---

remove()

remove(el): void

Defined in: src/beatmap/storyboard/layer.ts:38

Parameters

Parameter	Type
el	StoryboardElement

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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
layer.remove(sprite)
return layer.count

---

removeAt()

removeAt(index): void

Defined in: src/beatmap/storyboard/layer.ts:47

Parameters

Parameter	Type
index	number

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)

const layer = storyboard.getLayer('Foreground')

layer.add(sprite)
layer.removeAt(0)
return layer.count