⮞ Go to NeoFPS.com

    Show / Hide Table of Contents

    ScopedAimer MonoBehaviour

    Overview

    The ScopedAimer module will raise the weapon and then switch to a HUD Scope when the weapon is fully raised.

    In The Scene View

    Aimer Handle

    With a gameobject selected that uses a HeadMoveAimer component, the aimer guide handle will be visible in the scene view. This is used to represent the aim point of the aimer, with the blue arrow pointing forwards, and the green arrow pointing up.

    Inspector

    ScopedAimer

    Properties

    Name Type Description
    Start Active Boolean Should this module register as the active aimer 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.
    Aim Up Audio AudioClip An audio clip to play when the weapon is raised.
    Aim Down Audio AudioClip An audio clip to play when the weapon is lowered.
    Hip Accuracy Cap Float The highest accuracy the firearm can achieve while not aiming down sights.
    Aimed Accuracy Cap Float The highest accuracy the firearm can achieve while aiming down sights.
    Can Aim While Reloading Boolean Should the weapon be lowered when reloading or can it stay aimed.
    On Aim Up UnityEvent An event called when the weapon is fully raised.
    On Aim Down UnityEvent An event called when the weapon is fully lowered.
    Aim Offset Vector3 The offset for the root transform to move to align the weapon sights with the camera.
    From Transform Transform Dragging a transform in here will calculate the offset from the root transform to this transform, and set the Aim Offset property with the result
    Hud Scope Key String The key for the specific scope to show.
    Fov Multiplier Float A multiplier for the camera FoV for aim zoom.
    Aim Time Float The time it takes to reach full aim, or return to zero aim.
    Position Spring Multiplier Float A multiplier for procedural spring position animation on the weapon. Used to reduce movement when the firearm is close to the camera.
    Rotation Spring Multiplier Float A multiplier for procedural spring rotation animation on the weapon. Used to reduce movement when the firearm is close to the camera.
    Aim Anim Bool String The animator parameter key for a bool used to control aiming state in animations.
    Block Trigger Boolean If true then the gun cannot fire while transitioning in and out of aim mode. This is used to prevent gunshots interrupting the animation. This property will only be shown if the Aim Anim Bool property is true.
    Crosshair Up FpsCrosshair The crosshair to show when aiming down sights.
    Crosshair Down FpsCrosshair The crosshair to show when not aiming down sights.

    See Also

    Modular Firearms

    First Person Camera

    HudScope

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