Fields

@:optional@:default(0)optionalzIndex:Null<Int>

* A number determining the stack order of the prop, relative to other props and the characters in the stage. * Props with lower numbers render below those with higher numbers. * This is just like CSS, it isn't hard. * @default 0

@:optionaloptionalstartingAnimation:Null<String>

* If animations are used, this is the name of the animation to play first. * @default Don't play an animation.

@:optional@:default([1, 1])optionalscroll:Null<Array<Float>>

* How much the prop scrolls relative to the camera. Used to create a parallax effect. * Represented as an [x, y] array of two floats. * [1, 1] means the prop moves 1:1 with the camera. * [0.5, 0.5] means the prop moves half as much as the camera. * [0, 0] means the prop is not moved. * @default [1, 1]

@:jcustomparse(funkin.data.DataParse.eitherFloatOrFloats)@:jcustomwrite(funkin.data.DataWrite.eitherFloatOrFloats)@:optional@:default(Left(1.0))optionalscale:Null<Either<Float, Array<Float>>>

* Either the scale of the prop as a float, or the [w, h] scale as an array of two floats. * Pro tip: On pixel-art levels, save the sprite small and set this value to 6 or so to save memory.

position:Array<Float>

* The position of the prop as an [x, y] array of two floats.

@:optionaloptionalname:Null<String>

* The name of the prop for later lookup by scripts. * Optional; if unspecified, the prop can't be referenced by scripts.

@:optional@:default(false)optionalisPixel:Null<Bool>

* If set to true, anti-aliasing will be forcibly disabled on the sprite. * This prevents blurry images on pixel-art levels. * @default false

@:optional@:default(false)optionalflipY:Null<Bool>

* If set to true, the prop will be flipped vertically. * @default false

@:optional@:default(false)optionalflipX:Null<Bool>

* If set to true, the prop will be flipped horizontally. * @default false

@:default(0.0)@:optionaloptionaldanceEvery:Null<Float>

* If not zero, this prop will play an animation every X beats of the song. * This requires animations to be defined. If `danceLeft` and `danceRight` are defined, * they will alternated between, otherwise the `idle` animation will be used. * Supports up to 0.25 precision. * @default 0.0

@:default("#FFFFFF")@:optionaloptionalcolor:Null<String>

* The color of the prop overlay, as a hex string. * White overlays, or the ones with the value #FFFFFF, do not appear. * @default `#FFFFFF`

@:default("")@:optionaloptionalblend:Null<String>

* The blend mode of the prop, as a string. * Just like in photoshop. * @default Nothing.

@:optionaloptionalatlasSettings:Null<TextureAtlasData>

* Various settings for the prop. * Only available for texture atlases.

assetPath:String

* The asset used to display the prop. * NOTE: As of Stage data v1.0.1, you can also use a color here to create a rectangle, like "#ff0000". * In this case, the `scale` property will be used to determine the size of the prop.

@:optional@:default([])optionalanimations:Null<Array<AnimationData>>

* An optional array of animations which the prop can play. * @default Prop has no animations.

@:default("sparrow")@:optionaloptionalanimType:Null<String>

* The animation type to use. * Options: "sparrow", "packer", "animateatlas" * @default "sparrow"

@:optional@:default(0.0)optionalangle:Null<Float>

* The angle of the prop, as a float. * @default 0.0

@:optional@:default(1.0)optionalalpha:Null<Float>

* The alpha of the prop, as a float. * @default 1.0