.. _doc_item_asset_sight: Sight Assets ============ Sights (or "sight attachments") are created from the ItemSightAsset class. They are inventory items that can be attached to ranged weapons. This inherits the :ref:`CaliberAsset ` class. Game Data File -------------- Sight attachments inherit properties from the CaliberAsset class, which in turn inherits properties from the ItemAsset class. Properties that are required to be included are listed in the table below. .. list-table:: :widths: 30 40 30 :header-rows: 1 * - Class - Property Name - Required Value * - :ref:`ItemAsset ` - :ref:`GUID ` - * - :ref:`ItemAsset ` - :ref:`ID ` - * - :ref:`ItemAsset ` - :ref:`Type ` - ``Sight`` Properties `````````` .. list-table:: :widths: 40 40 20 :header-rows: 1 * - Property Name - Type - Default Value * - :ref:`AimAlignment_LocalOffset ` - :ref:`Vector3 ` - ``(0, 0, 0)`` * - :ref:`AimAlignment_Owner ` - :ref:`EAimAlignmentTransformOwner ` - ``Sight`` * - :ref:`AimAlignment_Path ` - :ref:`string ` - ``Model_0/Aim`` * - :ref:`DistanceMarkers ` - :ref:`list of DistanceMarker ` - * - :ref:`Holographic ` - :ref:`flag ` - * - :ref:`Nightvision_Color ` - :ref:`color ` - See description * - :ref:`Nightvision_Fog_Intensity ` - :ref:`float32 ` - See description * - :ref:`Offset_Scope_Overlay_By_One_Texel ` - :ref:`bool ` - ``false`` * - :ref:`Vision ` - :ref:`ELightingVision ` - ``None`` * - :ref:`Zoom ` - :ref:`float32 ` - ``1`` * - :ref:`ThirdPerson_Zoom ` - :ref:`float32 ` - ``1.25`` * - :ref:`Zoom_Using_Eyes ` - :ref:`bool ` - ``false`` .. _doc_item_asset_sight:distancemarker_dictionary: DistanceMarker Dictionary ````````````````````````` .. list-table:: :widths: 40 40 20 :header-rows: 1 * - Property Name - Type - Default Value * - :ref:`Distance ` - :ref:`float32 ` - ``0`` * - :ref:`LineOffset ` - :ref:`float32 ` - ``0`` * - :ref:`LineWidth ` - :ref:`float32 ` - ``0.05`` * - :ref:`Side ` - :ref:`ESide ` - ``Right`` * - :ref:`HasLabel ` - :ref:`bool ` - ``true`` * - :ref:`Color ` - :ref:`color ` - ``black`` .. _doc_item_asset_sight:eaimalignmenttransformowner: EAimAlignmentTransformOwner Enumeration ```````````````````````````````````````` .. list-table:: :widths: 25 75 :header-rows: 1 * - Named Value - Description * - ``Sight`` - Look for aim alignment transform relative to sight model. Defaults to Model_0/Aim. * - ``Gun`` - Look for aim alignment transform relative to equipable prefab. Requires setting AimAlignment_Path. .. _doc_item_asset_sight:eside_enumeration: ESide Enumeration ````````````````` .. list-table:: :widths: 25 75 :header-rows: 1 * - Named Value - Description * - ``Left`` - Marking extends to the left from the center. * - ``Right`` - Marking extends to the right from the center. Property Descriptions ````````````````````` .. _doc_item_asset_sight:aimalignment_localoffset: AimAlignment_LocalOffset :ref:`Vector3 ` ``(0, 0, 0)`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Position offset relative to Aim transform or transform specified by ``AimAlignment_Path``. ---- .. _doc_item_asset_sight:aimalignment_owner: AimAlignment_Owner :ref:`EAimAlignmentTransformOwner ` ``Sight`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Controls where to find ``AimAlignment_Path``. ---- .. _doc_item_asset_sight:aimalignment_path: AimAlignment_Path :ref:`string ` ``Model_0/Aim`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: While aiming down sights, the camera's position is aligned with this transform. Relative to ``AimAlignment_Owner``. ---- .. _doc_item_asset_sight:distancemarkers: DistanceMarkers :ref:`list of DistanceMarker ` ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: This property is a list of :ref:`DistanceMarker dictionaries `. It can be used to add visible (and accurate) distance markers to the scope that account for the weapon's bullet drop. ---- .. _doc_item_asset_sight:holographic: Holographic :ref:`flag ` ::::::::::::::::::::::::::::::::::::::: This sight should be holographic. ---- .. _doc_item_asset_sight:nightvision_color: Nightvision_Color :ref:`color ` ::::::::::::::::::::::::::::::::::::::::::::::: Override the default nightvision color. To configure this property, the ``Vision`` property must be set to ``Military``. This property supports using legacy color parsing. When not overridden, the default nightivision color will depend on the value of the :ref:`Vision ` property. ---- .. _doc_item_asset_sight:nightvision_fog_intensity: Nightvision_Fog_Intensity :ref:`float32 ` ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Configure the intensity of fog while nightvision is active. When this property has not been configured, the default fog intensity will depend on the value of the :ref:`Vision ` property. ---- .. _doc_item_asset_sight:offset_scope_overlay_by_one_texel: Offset_Scope_Overlay_By_One_Texel :ref:`bool ` ``false`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: If ``true``, the 2D scope texture will be scaled up slightly to center the pixel that would otherwise be left of center. For example, when enabled with a 512×512 texture the pixel at 255×255 will be centered on the display. ---- .. _doc_item_asset_sight:vision: Vision :ref:`ELightingVision ` ``None`` ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Set a unique lighting vision effect to use. The value of this property may effect the default values of other properties. The ``Headlamp`` enumerator is not supported by this property. ---- .. _doc_item_asset_sight:zoom: Zoom :ref:`float32 ` ``1`` :::::::::::::::::::::::::::::::::::::::::::::::::: Multiplicative amount of zoom. This value must be equal to or greater than ``1``. ---- .. _doc_item_asset_sight:thirdperson_zoom: ThirdPerson_Zoom :ref:`float32 ` ``1.25`` ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Zoom factor while in the third-person perspective. This value must be equal to or greater than ``1``. ---- .. _doc_item_asset_sight:zoom_using_eyes: Zoom_Using_Eyes :ref:`bool ` ``false`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Whether the main camera field of view should zoom without a scope overlay. .. _doc_item_asset_sight:distancemarker_dictionary_descriptions: DistanceMarker Dictionary Descriptions `````````````````````````````````````` .. _doc_item_asset_sight:distancemarker_distance: Distance :ref:`float32 ` ``0`` :::::::::::::::::::::::::::::::::::::::::::::::::::::: Meters between the player and a hypothethical target. ---- .. _doc_item_asset_sight:distancemarker_lineoffset: LineOffset :ref:`float32 ` ``0`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::: Distance between center line and start of horizontal line marker. Display-related properties like ``LineOffset`` are a percentage (represented as a decimal value from 0 to 1). For example, ``0.25`` would be 25%. ---- .. _doc_item_asset_sight:distancemarker_linewidth: LineWidth :ref:`float32 ` ``0.05`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Length of horizontal line marker. Display-related properties like ``LineWidth`` are a percentage (represented as a decimal value from 0 to 1). For example, ``0.25`` would be 25%. ---- .. _doc_item_asset_sight:distancemarker_side: Side :ref:`ESide ` ``Right`` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Direction the horizontal line and text expand in. ---- .. _doc_item_asset_sight:distancemarker_haslabel: HasLabel :ref:`bool ` ``true`` :::::::::::::::::::::::::::::::::::::::::::::::::::::: If true, a label with ``Distance`` text is shown next to the horizontal line marker. ---- .. _doc_item_asset_sight:distancemarker_color: Color :ref:`color ` ``black`` ::::::::::::::::::::::::::::::::::::::::::::: Override the color of the horizontal line and text.