RigsofRods
Soft-body Physics Simulation
Public Types | Public Member Functions | Data Fields
RoR::ActorModifyRequest Struct Reference

#include <SimData.h>

+ Collaboration diagram for RoR::ActorModifyRequest:

Public Types

enum  Type {
  Type::INVALID, Type::RELOAD, Type::RESET_ON_INIT_POS, Type::RESET_ON_SPOT,
  Type::SOFT_RESPAWN, Type::SOFT_RESET, Type::RESTORE_SAVED, Type::WAKE_UP,
  Type::REFRESH_VISUALS
}
 

Public Member Functions

 ActorModifyRequest ()
 
 ~ActorModifyRequest ()
 

Data Fields

ActorInstanceID_t amr_actor = ACTORINSTANCEID_INVALID
 
Type amr_type
 
std::shared_ptr< rapidjson::Document > amr_saved_state
 
CacheEntryPtr amr_addonpart
 Primary method of specifying cache entry. More...
 
std::string amr_addonpart_fname
 Fallback method in case CacheEntry doesn't exist anymore - that means mod was uninstalled in the meantime. Used by REMOVE_ADDONPART_AND_RELOAD. More...
 
Ogre::Vector3 amr_softrespawn_position
 Position to use with SOFT_RESPAWN. More...
 
Ogre::Quaternion amr_softrespawn_rotation
 Rotation to use with SOFT_RESPAWN; use TObjParser::CalcRotation() to calculate quaternion from XYZ like in TOBJ file. More...
 

Detailed Description

Definition at line 853 of file SimData.h.

Member Enumeration Documentation

◆ Type

Enumerator
INVALID 
RELOAD 

Full reload from filesystem, requested by user.

RESET_ON_INIT_POS 
RESET_ON_SPOT 
SOFT_RESPAWN 

Like hard reset, but positions the actor like spawn process does - using the relative positions from rig-def file (respecting Tuning system tweaks).

SOFT_RESET 
RESTORE_SAVED 
WAKE_UP 
REFRESH_VISUALS 

Forces a synchronous update of visuals from any context - i.e. from terrain editor mode or with sleeping/physicspaused actor.

Definition at line 858 of file SimData.h.

Constructor & Destructor Documentation

◆ ActorModifyRequest()

ActorModifyRequest::ActorModifyRequest ( )

Definition at line 97 of file SimData.cpp.

◆ ~ActorModifyRequest()

ActorModifyRequest::~ActorModifyRequest ( )

Definition at line 102 of file SimData.cpp.

Field Documentation

◆ amr_actor

ActorInstanceID_t RoR::ActorModifyRequest::amr_actor = ACTORINSTANCEID_INVALID

Definition at line 871 of file SimData.h.

◆ amr_addonpart

CacheEntryPtr RoR::ActorModifyRequest::amr_addonpart

Primary method of specifying cache entry.

Definition at line 875 of file SimData.h.

◆ amr_addonpart_fname

std::string RoR::ActorModifyRequest::amr_addonpart_fname

Fallback method in case CacheEntry doesn't exist anymore - that means mod was uninstalled in the meantime. Used by REMOVE_ADDONPART_AND_RELOAD.

Definition at line 876 of file SimData.h.

◆ amr_saved_state

std::shared_ptr<rapidjson::Document> RoR::ActorModifyRequest::amr_saved_state

Definition at line 874 of file SimData.h.

◆ amr_softrespawn_position

Ogre::Vector3 RoR::ActorModifyRequest::amr_softrespawn_position

Position to use with SOFT_RESPAWN.

Definition at line 877 of file SimData.h.

◆ amr_softrespawn_rotation

Ogre::Quaternion RoR::ActorModifyRequest::amr_softrespawn_rotation

Rotation to use with SOFT_RESPAWN; use TObjParser::CalcRotation() to calculate quaternion from XYZ like in TOBJ file.

Definition at line 878 of file SimData.h.

◆ amr_type

Type RoR::ActorModifyRequest::amr_type

Definition at line 872 of file SimData.h.


The documentation for this struct was generated from the following files: