Struct vtubestudio::data::ItemAnimationControlRequest

pub struct ItemAnimationControlRequest {
    pub item_instance_id: String,
    pub framerate: Option<f64>,
    pub frame: Option<i32>,
    pub brightness: Option<f64>,
    pub opacity: Option<f64>,
    pub set_auto_stop_frames: bool,
    pub auto_stop_frames: Vec<i32>,
    pub set_animation_play_state: bool,
    pub animation_play_state: bool,
}

Controling items and item animations.

You can control certain aspects of items in the scene. This request allows you to make items darker (black overlay), change the opacity, and control the animation of animated items. This request does not work with Live2D items and will return an error of type ItemAnimationControlUnsupportedItemType if you try. This can be useful for “reactive PNG”-type plugins and more.

This request returns ItemAnimationControlResponse.

Fields

item_instance_id: String

Item instance ID.

framerate: Option<f64>

Frame rate for animated items, clamped between 0.1 and 120.

frame: Option<i32>

Jump to a specific frame, zero-indexed.

May return an error if the frame index is invalid, or if the item type does not support animation.

brightness: Option<f64>

Brightness.

opacity: Option<f64>

Opacity.

set_auto_stop_frames: bool

Whether to set auto-stop frames.

auto_stop_frames: Vec<i32>

List of frame indices that the animation will automatically stop playing on.

Once the animation reaches one of those frames, it will stop playing and can only be started again via the API using this request to set the animation play state to true.

This only takes effect if set_auto_stop_frames is true. You can have a maximum of 1024 auto-stop frames.

set_animation_play_state: bool

Whether to set the animation play state.

animation_play_state: bool

The animation play state (set to false to stop the animation).

This only takes effect if set_animation_play_state is true.

Trait Implementations

impl Clone for ItemAnimationControlRequest

fn clone(&self) -> ItemAnimationControlRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ItemAnimationControlRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ItemAnimationControlRequest

fn default() -> ItemAnimationControlRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ItemAnimationControlRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<ItemAnimationControlRequest> for ItemAnimationControlRequest

fn eq(&self, other: &ItemAnimationControlRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Request for ItemAnimationControlRequest

const MESSAGE_TYPE: EnumString<RequestType> = _

RequestType::ItemAnimationControlRequest

type Response = ItemAnimationControlResponse

The expected Response type for this request.

impl Serialize for ItemAnimationControlRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ItemAnimationControlRequest