Struct vtubestudio::data::ArtMeshSelectionRequest

pub struct ArtMeshSelectionRequest {
    pub text_override: Option<String>,
    pub help_override: Option<String>,
    pub requested_art_mesh_count: i32,
    pub active_art_meshes: Vec<String>,
}

Asking user to select ArtMeshes.

You can use this request to show a list in VTube Studio containing all ArtMeshes of the currently loaded main Live2D model and have the user select one or more of them. Once the user is done selecting ArtMeshes, the ArtMesh IDs will be returned. You can use those ArtMesh IDs in various other API requests, for example to apply a color tint to them or make them invisible.

If no model is currently loaded or there are currently other windows open, the request will return an error.

The user can hover over ArtMeshes to show their ID and click them to filter the shown list for all ArtMeshes under on the click position.

This request returns ArtMeshSelectionResponse.

Fields

text_override: Option<String>

This text is shown over the ArtMesh selection list.

Must be between 4 and 1024 characters long, otherwise the default will be used.

help_override: Option<String>

This text is shown when the user presses the ? button.

Must be between 4 and 1024 characters long, otherwise the default will be used.

requested_art_mesh_count: i32

How many art meshes must be selected by the user.

The “OK” button will be unavailable until exactly this many ArtMeshes are activated. If you set this to 0 or lower, the user will be asked to choose any arbitrary number of ArtMeshes (but at least one).

active_art_meshes: Vec<String>

List of ArtMeshes to be pre-selected.

If any of these IDs are not contained in the current model, an error will be returned.

Trait Implementations

impl Clone for ArtMeshSelectionRequest

fn clone(&self) -> ArtMeshSelectionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArtMeshSelectionRequest

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

Formats the value using the given formatter.

impl Default for ArtMeshSelectionRequest

fn default() -> ArtMeshSelectionRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArtMeshSelectionRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ArtMeshSelectionRequest> for ArtMeshSelectionRequest

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

const MESSAGE_TYPE: EnumString<RequestType> = _

RequestType::ArtMeshSelectionRequest

type Response = ArtMeshSelectionResponse

The expected Response type for this request.

impl Serialize for ArtMeshSelectionRequest

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 ArtMeshSelectionRequest