Skip to content

Editor Commands

Jump to bottom
Aaron Liao edited this page Jan 21, 2021 · 6 revisions

Table of Contents

Introduction

S2VX allows for a wide range of appearance configurability. This page lists and describes all the commands which you can find in the Editor's Command Panel. If there are no commands of a certain type, as is the case when starting a brand new story, a default command will be added under-the-hood automatically (these defaults do not show on the Command Panel).

Editor Command Panel

Rules and Background

  • All commands always require a StartTime, EndTime, Easing, StartValue, and EndValue.
    • Easing specifies the type of interpolation performed between StartValue and EndValue.
    • StartTime and EndTime are in milliseconds and correspond to the absolute time of the story. In other words, EndTime is not the duration of which the command will last.
    • If a command is instantaneous, then the EndValue of a Command will be ignored.
    • StartValue and EndValues of multiple commands need not be continuous (i.e. you can have a command going from value A to value B and then a subsequent command starting from value C. It does not need to start from value B)
    • Overlapping commands are allowed but may result in unintended behavior
  • There are different data types for Start/EndValue depending on the command. If a value is input which would exceed the precision of the underlying datatype (i.e. if you enter 9 or more decimal places for a floating point value), it will be rounded automatically. The format of each are as such:
    • Float - Single-precision floating point: x.y
    • Vector2 - Single-precision floating point: (x.y, z.w)
    • Color - In RGB, single-precision floating point, range of values: (0, 0, 0) to (1, 1, 1)

List of commands

ApproachesColor

  • Value Type: Color
  • Default: BrickRed
  • Sets the color of approach lines only for non-hold notes.

ApproachesDistance

  • Value Type: Float
  • Default: 0.5
  • Sets the maximum distance of approach lines from their corresponding note or hold note. Approaches will first appear at this distance and move towards the note at a constant rate for the duration specified in NotesShowTime. If set to a negative value, there will be gaps in the corners of the approach lines.

ApproachesThickness

  • Value Type: Float
  • Default: 0.008
  • Sets the thickness of the approach lines. If set to a negative value, there will be gaps in the corners of the approach lines.

BackgroundColor

  • Value Type: Color
  • Default: DarkBlack
  • Sets the color of the background.

CameraMove

  • Value Type: Vector2
  • Default: (0, 0)
  • Pans / translates the play screen. The coordinate system is positive in the right and down directions, and negative in the left and up directions.

CameraRotate

  • Value Type: Float
  • Default: 0
  • Rotates the play screen (measured in degrees). Rotation is performed relative to the center of the screen. Values are positive in the clockwise direction, and negative in the counter-clockwise direction.

CameraScale

  • Value Type: Float
  • Default: (0.1, 0.1)
  • Scales the play screen so notes appear larger or smaller. Scale is performed relative to the center of the screen. Values are positive for zooming-in (larger note size), and negative for zooming-out (smaller note size).

GridAlpha

  • Value Type: Float
  • Default: 1
  • Sets the transparency of the background grid. Values are expected to be between 0 (not visible) and 1 (completely opaque). However, values outside of these bounds are accepted and will simply be clamped between 0 and 1 (i.e. negative values will effectively be treated the same as 0).

GridColor

  • Value Type: Color
  • Default: LightBlack
  • Sets the color of the background grid.

GridThickness

  • Value Type: Float
  • Default: 0.005
  • Sets the thickness of the background grid. While negative values are not disallowed, it is discouraged as it will result in a visual aberration in which notes are drawn larger than their hitboxes.

HoldApproachesColor

  • Value Type: Color
  • Default: Cyan
  • Sets the color of approach lines only for hold notes.

HoldNotesAlpha

  • Value Type: Float
  • Default: 1
  • Sets the maximum alpha or "fully visible" transparency of hold notes. Hold notes will fade in/out from 0 until this value is reached. Values are expected to be between 0 (not visible) and 1 (completely opaque). However, values outside of these bounds are accepted and will simply be clamped between 0 and 1 (i.e. negative values will effectively be treated the same as 0).

HoldNotesColor

  • Value Type: Color
  • Default: Cyan
  • Sets the color of hold notes.

HoldNotesOutlineColor

  • Value Type: Color
  • Default: OffWhite
  • Sets the color of the outline on hold notes.

HoldNotesOutlineThickness

  • Value Type: Float
  • Default: 0.01
  • Sets the thickness of the outline on hold notes.

NotesAlpha

  • Value Type: Float
  • Default: 0.7
  • Sets the maximum alpha or "fully visible" transparency of non-hold notes. Notes will fade in/out from 0 until this value is reached. Values are expected to be between 0 (not visible) and 1 (completely opaque). However, values outside of these bounds are accepted and will simply be clamped between 0 and 1 (i.e. negative values will effectively be treated the same as 0).

NotesColor

  • Value Type: Color
  • Default: BrickRed
  • Sets the color of non-hold notes.

NotesFadeInTime

  • Value Type: Float
  • Default: 100.0
  • Sets the time, in milliseconds, in which notes fade in from 0 opacity to NotesAlpha in a linear fashion. Negative values are allowed, but notes will still appear instantaneously in the same way as they would with a value of zero. However, a negative value will pause approaches at their ApproachesDistance for the given amount of time, effectively resulting in faster approaches without affecting the NotesShowTime.

NotesFadeOutTime

  • Value Type: Float
  • Default: 100.0
  • Sets the time, in milliseconds, in which notes fade in from NotesAlpha to 0 opacity in a linear fashion. Negative values are allowed, but notes will still disappear instantaneously in the same way as they would with a value of zero.

NotesOutlineColor

  • Value Type: Color
  • Default: OffWhite
  • Sets the color of the outline on non-hold notes.

NotesOutlineThickness

  • Value Type: Float
  • Default: 0.01
  • Sets the thickness of the outline on non-hold notes.

NotesShowTime

  • Value Type: Float
  • Default: 1000.0
  • Sets the fully visible time of the note until its HitTime. This combined with the NotesFadeInTime is the total time the note will be visible on screen before its HitTime.

TimingChange

  • Value Type: Float
  • Default: 100.0
  • Sets the beats per minute of the Story. This affects the spacing of the beat snap ticks in the NotesTimeline.
Clone this wiki locally