Skip to content

Latest commit

 

History

History
76 lines (65 loc) · 4.57 KB

README.md

File metadata and controls

76 lines (65 loc) · 4.57 KB
Raw

Player Ragdoll Mod

This mod turns player's avatar into ragdoll puppet.

Installation

Usage

  • Press R to turn into ragdoll and back.

Optional mod's settings page with BTKUILib:

  • Switch ragdoll: turns into ragdoll state and back, made for VR usage primarily.
    • Note: You can't ragdoll in chairs.
  • Use hotkey: enables/disables ragdoll state switch with R key; true by default.
  • Use gravity: enables/disables gravity for ragdoll; true by default.
    • Note: Forcibly enabled in worlds that don't allow flight.
  • Pointers reaction: enables ragdoll state when player collides with trigger colliders and particle systems with CVRPointer component of ragdoll type (avatars, props and world included); true by default.
  • Ignore local pointers: enables/disables ignoring of CVRPointer components of ragdoll type on local player's avatar; true by default.
  • Combat reaction: enables ragdoll state upon death in worlds with combat system; true by default.
  • Auto recover: enables automatic recovering after specific time delay; false by default.
  • Slipperiness: enables/disable low friction of ragdoll; false by default.
    • Note: Forcibly disabled in worlds that don't allow flight.
  • Bounciness: enables/disable bounce force of ragdoll; false by default.
    • Note: Forcibly disabled in worlds that don't allow flight.
  • View direction velocity: apply velocity to camera view direction instead of player movement direction; false by default.
    • Note: Forcibly disabled in worlds that don't allow flight.
  • Jump recover: enables recovering from ragdoll state by jumping; false by default.
  • Buoyancy: enables floating in fluid volumes; true by default.
    • Note: Forcibly enabled in worlds that don't allow flight.
  • Fall damage: enables ragdoll when falling from specific height; true by default.
  • Gesture grab: enables grabbing of ragdolled body parts by remote players with trigger/grab gesture; false by default.
    • Note: Can lead to unpredictable physics behaviour in some cases.
  • Friends grab only: Allow only friends to be able to grab your radgolled body parts; true by default.
  • Velocity multiplier: velocity force multiplier based on player's movement direction; 2.0 by default.
    • Note: Limited according to world's fly multiplier.
    • Note: Forcibly set to 1.0 in worlds that don't allow flight.
  • Movement drag: movement resistance; 2.0 by default.
    • Note: Forcibly set to 1.0 in worlds that don't allow flight.
  • Angular movement drag: angular movement resistance; 2.0 by default.
  • Recover delay: time delay for enabled Auto recover in seconds; 3.0 by default.
  • Fall limit: height limit for fall damage; 5.0 by default.
  • Grab distance: minimal distance for successful grab; 0.1 by default.
  • Reset settings: resets mod settings to default.

Optional mod's settings in UIExpansionKit:

  • Hotkey: system key that is used to switch ragdoll state; R by default.

Available additional parameters for AAS animator:

  • Ragdolled: defines current ragdoll state; boolean.
    • Note: Can be set as local-only (not synced) if starts with # character.

World restriction

World creators can restrict ragdolling by creating empty game object with name [RagdollRestriction] anywhere in scene.

Unity Editor Script

You can also trigger the ragdoll via animations on your avatar. To do this you need:

  • Download and import the PlayerRagdollMod.unitypackage into your unity project
  • Add the component Ragdoll Toggle anywhere inside of your avatar's hierarchy.

Now you can animate both parameters available:

  • Should Override: whether the animation should override the toggled state of the ragdoll.
  • Is On: whether the ragdoll state is On or Off (only works if Should Override is also On).

Note: In order to work the game object needs to be active and the component enabled.

Mods integration

You can use this mod's functions within your mod. To do this you need:

  • Add mod's dll as reference in your project
  • Access ragdoll controller with ml_prm.RagdollController.Instance

Available methods:

  • bool IsRagdolled()
  • void SwitchRagdoll()
  • void Ragdoll()
  • void Unragdoll()