Struct vtubestudio::data::InjectParameterDataRequest

pub struct InjectParameterDataRequest {
    pub parameter_values: Vec<ParameterValue>,
    pub face_found: bool,
    pub mode: Option<EnumString<InjectParameterDataMode>>,
}

Feeding in data for default or custom parameters.

This request returns InjectParameterDataResponse.

Fields

parameter_values: Vec<ParameterValue>

The parameter values to inject.

face_found: bool

Whether to consider the user’s face as found.

Allows controlling the model when the “tracking lost” animation is played.

mode: Option<EnumString<InjectParameterDataMode>>

Whether to set or add the parameter data (default is set).

Generally, if another plugin is already controlling one (default or custom) parameter, an error will be returned. This happens because only one plugin can set (override) a given parameter at a time, which is the default mode for this request. This is the mode that is used when you don’t provide a value in the mode field or set the value to set.

Alternatively, you can set the "mode" field to "add". This will instead add the values you send to whatever the current parameter values are. The weight values aren’t used in that case. Any number of plugins can use the add mode for a given parameter at the same time. This can be useful for bonk/throwing type plugins and other use-cases.

Trait Implementations

impl Clone for InjectParameterDataRequest

fn clone(&self) -> InjectParameterDataRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InjectParameterDataRequest

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

Formats the value using the given formatter.

impl Default for InjectParameterDataRequest

fn default() -> InjectParameterDataRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InjectParameterDataRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<InjectParameterDataRequest> for InjectParameterDataRequest

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

const MESSAGE_TYPE: EnumString<RequestType> = _

RequestType::InjectParameterDataRequest

type Response = InjectParameterDataResponse

The expected Response type for this request.

impl Serialize for InjectParameterDataRequest

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 InjectParameterDataRequest