⮞ Go to NeoFPS.com

    Show / Hide Table of Contents

    SpringRecoilHandler MonoBehaviour

    Overview

    The SpringRecoilHandler module uses the additive transform system to move and rotate the firearm as it recoils.

    Inspector

    SpringRecoilHandler

    Properties

    Name Type Description
    Start Active Boolean Should this module register as the active recoil handler immediately on start.
    Activation Mode Dropdown How does module activation work. Options are: Component means the component will be enabled / disabled - use this when you have multiple modules on an object such as the firearm root. GameObject activates / deactivates the object - use this for attachments where you want the geo to appear/disappear.
    On Recoil UnityEvent An event that fires every time the weapon recoils.
    Hip Accuracy Kick Float The accuracy decrement per shot in hip fire mode (accuracy has a 0-1 range).
    Hip Accuracy Recover Float The accuracy recovered per second in hip fire mode (accuracy has a 0-1 range).
    Sighted Accuracy Kick Float The accuracy decrement per shot in sighted fire mode (accuracy has a 0-1 range).
    Sighted Accuracy Recover Float The accuracy recovered per second in sighted fire mode (accuracy has a 0-1 range).
    Weapon Kicker AdditiveKicker The additive kicker behaviour on the object.
    Weapon Wander Float How much of the weapon recoil rotation is directed sideways instead of up.
    Weapon Rotation Float The rotation angle of the weapon recoil while firing from the hip. At 0 wander, this is how many degrees the weapon pitches up.
    Weapon Rotation Aimed Float The rotation angle of the weapon recoil while aimed. At 0 wander, this is how many degrees the weapon pitches up.
    Weapon Knock Back Float Knock-back is movement backwards, towards the camera.
    Head Wander Float How much of the head recoil rotation is directed sideways instead of up. At negative values this will be the opposite of the guns sideways rotation.
    Head Rotation Float The head rotation angle of the weapon recoil when firing from the hip. At 0 wander, this is how many degrees the weapon pitches up.
    Head Rotation Aimed Float The head rotation angle of the weapon recoil when aimed. At 0 wander, this is how many degrees the weapon pitches up.
    Bypass Move Multiplier Boolean Should the movement recoil effect be affected by the weapon and head spring multipliers? These affect everything, from bob to impacts to shake. If the multiplier is at zero then the recoil will be disabled either way.
    Bypass Rotate Multiplier Boolean Should the rotation recoil effect be affected by the weapon and head spring multipliers? These affect everything, from bob to impacts to shake. If the multiplier is at zero then the recoil will be disabled either way.
    Rotation Duration Float The amount of time the angle recoil effect takes to return to zero.
    KnockBack Duration Float The amount of time the knockback effect takes to return to zero.

    See Also

    Modular Firearms

    Additive Transforms and Effects

    Back to top Copyright © 2019 Yondernauts Game Studios Ltd
    Generated with DocFX