Struct vtubestudio::data::GetCurrentModelPhysicsResponse

pub struct GetCurrentModelPhysicsResponse {
    pub model_loaded: bool,
    pub model_name: String,
    pub model_id: String,
    pub model_has_physics: bool,
    pub physics_switched_on: bool,
    pub using_legacy_physics: bool,
    pub physics_fps_setting: i32,
    pub base_strength: i32,
    pub base_wind: i32,
    pub api_physics_override_active: bool,
    pub api_physics_override_plugin_name: String,
    pub physics_groups: Vec<PhysicsGroup>,
}

Data about the requested physics settings.

This is the return value of GetCurrentModelPhysicsRequest.

Fields

model_loaded: bool

Whether the model is loaded.

If no model is loaded, this will be false. All other values do not have any significance in that case and the physics_groups array will be empty.

model_name: String

The name of the model.

model_id: String

The ID of the model.

model_has_physics: bool

Whether the model has physics.

If a model is loaded, this field will tell you whether or not the model has a valid physics setup. Some models don’t have physics set up or have a broken physics file which will cause the physics system to not start correctly.

physics_switched_on: bool

Whether physics is enabled.

This will be true if the “Use Physics” toggle has been activated for this model by the user in VTube Studio.

using_legacy_physics: bool

Whether legacy physics is enabled.

This corresponds to the “Legacy Physics” toggle in the VTube Studio UI.

physics_fps_setting: i32

The physics FPS setting for this model.

Can be 30, 60, 120, or -1, which indicates that the user has selected “Use same FPS as app” in the UI.

base_strength: i32

Base physics strength for this model (between 0 and 100, default 50).

base_wind: i32

Base wind strength for this model (between 0 and 100, default 0).

api_physics_override_active: bool

Whether a plugin is currently overriding the physics settings of this model.

api_physics_override_plugin_name: String

The name of the plugin that is currently overriding physics settings, if any.

physics_groups: Vec<PhysicsGroup>

Physics groups for this model.

Trait Implementations

impl Clone for GetCurrentModelPhysicsResponse

fn clone(&self) -> GetCurrentModelPhysicsResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCurrentModelPhysicsResponse

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

Formats the value using the given formatter.

impl Default for GetCurrentModelPhysicsResponse

fn default() -> GetCurrentModelPhysicsResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetCurrentModelPhysicsResponse

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<GetCurrentModelPhysicsResponse> for GetCurrentModelPhysicsResponse

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

const MESSAGE_TYPE: EnumString<ResponseType> = _

ResponseType::GetCurrentModelPhysicsResponse

impl Serialize for GetCurrentModelPhysicsResponse

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 GetCurrentModelPhysicsResponse