Also, see an official documentation .
Name
Type
Description
BackgroundLayer
List<IStoryboardObject>
Storyboard layer that overrides default beatmap background.
FailLayer
List<IStoryboardObject>
Storyboard layer that appears only when player is in fail state.
PassLayer
List<IStoryboardObject>
Storyboard layer that appears only when player is in pass state.
ForegroundLayer
List<IStoryboardObject>
The "highest" layer of storyboard.
OverlayLayer
List<IStoryboardObject>
Storyboard layer that sits in front of hitobjects.
SamplesLayer
List<IStoryboardObject>
Storyboard layer that contains audio samples.
Variables
Dictionary<string, string>
Contains pairs of variable names and values.
GetLayer(StoryboardLayer layer)
List<IStoryboardObject>
Returns one of the six lists specified above.
Save(string path)
void
Writes this Storyboard to the specified path.
IStoryboardObject properties
Indicates that object is a storyboard object. (StoryboardSprite, StoryboardAnimation or StoryboardSample)
Name
Type
Description
FilePath
string
Path to sprite or sample.
Indicates that object has CommandGroup.
Name
Type
Description
Commands
CommandGroup
Contains all commands that some object uses.
Indicates that this object is storyboard command.
Name
Type
Description
Type
CommandType
Type of this command. (e.g. VectorScale)
Easing
Easing
Indicates if the command should "accelerate". See http://easings.net .
StartTime
int
Starting time of this command in ms.
EndTime
int
Ending time of this command in ms.
StoryboardSprite properties
Name
Type
Description
Commands
CommandGroup
Contains all commands that this object uses.
Origin
Origins
Image's origin (coordinate).
FilePath
string
Path to sprite.
X
float
X coordinate of where the object should be.
Y
float
Y coordinate of where the object should be.
StoryboardAnimation properties
Name
Type
Description
Commands
CommandGroup
Contains all commands that this object uses.
Origin
Origins
Image's origin (coordinate).
FilePath
string
Path to sprite.
X
float
X coordinate of where the object should be.
Y
float
Y coordinate of where the object should be.
FrameCount
int
Indicates how many frames the animation has.
FrameDelay
int
Indicates how many ms should be in between each frame.
LoopType
LoopType
Indicates if the animation should loop or not.
StoryboardSample properties
Name
Type
Description
Layer
StoryboardLayer
Layer of this sample.
Time
int
Starting time of this sample in ms.
FilePath
string
Path to sample.
Volume
int
Volume of this sample.
Name
Type
Description
Triggers
List<Command>
Contains all commands of this CommandGroup. (except Triggers and Loops)
Triggers
List<TriggerCommand>
Contains all trigger commands of this object.
Loops
List<LoopCommand>
Contains all loop commands of this object.
Name
Type
Description
Easing
Easing
Indicates if the command should "accelerate". See http://easings.net .
StartTime
int
Starting time of this command in ms.
EndTime
int
Ending time of this command in ms.
StartColour
Colour
Start color of this command.
EndColour
Colour
End color of this command.
StartVector
Vector2
Start vector of this command.
EndVector
Vector2
End vector of this command.
StartFloat
float
Start float of this command.
EndFloat
float
End float of this command.
TriggerCommand properties
Name
Type
Description
TriggerName
string
Indicates the trigger condition.
TriggerStartTime
int
Timestamp at which the trigger becomes valid.
TriggerEndTime
int
Timestamp at which the trigger stops being valid.
GroupNumber
int
Allows triggers on the same sprite to be grouped so that all triggers of the group are stopped when one trigger starts.
Commands
CommandGroup
Commands of this trigger.
Name
Type
Description
LoopStartTime
int
Timestamp at which the loop begins.
LoopCount
int
Number of times the loop executes before stopping.
Commands
CommandGroup
Commands of this loop.