Struct vtubestudio::data::ItemUnloadRequest

pub struct ItemUnloadRequest {
    pub unload_all_in_scene: bool,
    pub unload_all_loaded_by_this_plugin: bool,
    pub allow_unloading_items_loaded_by_user_or_other_plugins: bool,
    pub instance_ids: Vec<String>,
    pub file_names: Vec<String>,
}

Removing item from the scene.

This may return an error of type CannotCurrentlyUnloadItem if the user currently has menus open that prevent VTS from loading/unloading items.

This request returns ItemUnloadResponse.

Fields

unload_all_in_scene: bool

Whether to unload all items in the scene.

unload_all_loaded_by_this_plugin: bool

Whether to unload all items loaded by this plugin.

allow_unloading_items_loaded_by_user_or_other_plugins: bool

Whether to allow unloading items that have been loaded by the user or other plugins.

instance_ids: Vec<String>

Request specific instance IDs to be unloaded.

file_names: Vec<String>

Request specific file names to be unloaded.

Trait Implementations

impl Clone for ItemUnloadRequest

fn clone(&self) -> ItemUnloadRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemUnloadRequest

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

Formats the value using the given formatter.

impl Default for ItemUnloadRequest

fn default() -> ItemUnloadRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ItemUnloadRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ItemUnloadRequest> for ItemUnloadRequest

fn eq(&self, other: &ItemUnloadRequest) -> 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 ItemUnloadRequest

const MESSAGE_TYPE: EnumString<RequestType> = _

RequestType::ItemUnloadRequest

type Response = ItemUnloadResponse

The expected Response type for this request.

impl Serialize for ItemUnloadRequest

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 ItemUnloadRequest