Struct vtubestudio::data::ItemLoadRequest

source · [−]

pub struct ItemLoadRequest {Show 13 fields
    pub file_name: String,
    pub position_x: f64,
    pub position_y: f64,
    pub size: f64,
    pub rotation: i32,
    pub fade_time: f64,
    pub order: Option<i32>,
    pub fail_if_order_taken: bool,
    pub smoothing: f64,
    pub censored: bool,
    pub flipped: bool,
    pub locked: bool,
    pub unload_when_plugin_disconnects: bool,
}

Expand description

Loading item into the scene.

This request returns ItemLoadResponse.

Fields

file_name: String

File name. E.g., some_item_name.jpg.

position_x: f64

X position.

position_y: f64

Y position.

size: f64

Item size. Should be between 0 and 1.

0.32 is roughly the “default” size that items will have when the user loads them manually.

rotation: i32

Rotation, in degrees.

fade_time: f64

Fade time, in seconds. Should be between 0 and 2.

order: Option<i32>

Item order. If the order is taken, VTube Studio will automatically try to find the next available order, unless fail_if_order_taken is true.

fail_if_order_taken: bool

Set to true to fail with an ItemOrderAlreadyTaken error if the desired order is already taken.

smoothing: f64

Smoothing, between 0 and 1.

censored: bool

Whether the item is censored.

flipped: bool

Whether the item is flipped.

locked: bool

Whether the item is locked.

unload_when_plugin_disconnects: bool

Unload item when plugin disconnects.

Trait Implementations

impl Clone for ItemLoadRequest

fn clone(&self) -> ItemLoadRequest

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for ItemLoadRequest

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

Formats the value using the given formatter. Read more

impl Default for ItemLoadRequest

fn default() -> ItemLoadRequest

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for ItemLoadRequest

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<ItemLoadRequest> for ItemLoadRequest

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

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

1.0.0 · source

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. Read more

impl Request for ItemLoadRequest

const MESSAGE_TYPE: EnumString<RequestType> = _

RequestType::ItemLoadRequest

type Response = ItemLoadResponse

The expected Response type for this request.

impl Serialize for ItemLoadRequest

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for ItemLoadRequest

Auto Trait Implementations

impl RefUnwindSafe for ItemLoadRequest

impl Send for ItemLoadRequest

impl Sync for ItemLoadRequest

impl Unpin for ItemLoadRequest

impl UnwindSafe for ItemLoadRequest

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,