⮞ Go to NeoFPS.com

    Show / Hide Table of Contents

    PatternHitscanShooter MonoBehaviour

    Overview

    The PatternHitscanShooter module instantly fires in a preset pattern. The pattern is defined in 2D with a max distance of 1m from the origin on each axis. The distance setting specifies how far from the firearm's muzzle the full pattern size is achieved.

    Pattern Editor

    PatternShooterEditor

    The pattern editor allows you to specify the gunshot pattern. You can select a point by left clicking and move a point by left-click dragging.

    Control Description
    Template Load a background image to use as a template for placing points.
    Copy To JSON Copy all points to the clipboard in JSON format. You can paste this to any text editor to make changes.
    Paste From JSON If the clipboard contains valid JSON, replace all the points with those on the clipboard.
    Add New Point Add a new point to the pattern (the new points will be placed at the center and selected automatically.
    Remove Point Remove the selected point.
    Position The position of the selected point (clamped to a -1 to 1 range on each axis).

    Inspector

    PatternHitscanShooter

    Properties

    Name Type Description
    Start Active Boolean Should this module register as the active shooter 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.
    Pattern Distance Float The distance from the muzzle tip at which the pattern will match the diagram.
    Pattern Points Vector2 Array The points that make up the pattern.
    Max Distance Float The maximum distance that the weapon will register a hit.
    Muzzle Tip Transform The transform that the bullet actually fires from.
    Layers LayerMask The physics collision layers the shot can hit.
    Min Aim Offset Float The maximum angle from forward the shooter can fire when accuracy is 1.
    Max Aim Offset Float The maximum angle from forward the shooter can fire when accuracy is 0.
    Use Camera Aim Dropdown When set to use camera aim, the gun first casts from the FirstPersonCamera's aim transform, and then from the muzzle tip to that point to get more accurate firing. Options are: HipFireOnly, HipAndAimDownSights, AimDownSightsOnly, Never.
    Tracer Prototype Pooled Object The optional pooled tracer prototype to use (must implement the IPooledHitscanTrail interface).
    Tracer Size Float The size (thickness/radius) of the tracer line.
    Tracer Duration Float How long should the tracer object stay visible.

    See Also

    Modular Firearms

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