SKGOpticComponent
The purpose of this component is to act like an interface to the SKGOpticSceneCaptureComponent so you don't interact with it directly, as well as offer several optic relation settings and functionality. For example it handles reticle brightness, cycling reticles, zeroing, magnification, etc.
The Optic Mesh Name is the name of the Static/Skeletal Mesh Component on your blueprint.
The Optic Scene Capture Component Name is the name of SKGOpticSceneCaptureComponent added to your magnified optics. This is not a mandatory field and is only used on optics that have the SKGOpticSceneCaptureComponent on them. This is subject to modification in the future as I want to support both zooming with a SKGOpticSceneCaptureComponent as well as traditional style without.
Each component comes with the gameplay tag interface already setup in the case that you might want to utilize one of the components with GAS (Gameplay Ability System).
The Reticle Material Index is the material index that will be used for the reticle. In the examples below the Holosight has the material index of 1 while the Thermal optic has a material index of 0.
The Reticle Materials is an array of materials you can use to cycle between. For example if I want to be able to cycle between a red and green reticle, I would have two entries with one being red and one being green.
The Un Aimed Reticle Material and Un Aimed Capture Delay applies to magnified optics using a SKGOpticSceneCaptureComponent . When you stop aiming, it will wait the amount of time specified in the Un Aimed Capture Delay before changing the reticle material to the one specified in the Reticle Material. This is useful if you want to change it to something such as a simple glass material.
Reticle Brightness Parameter Name - Reticle Brightness Settings - Reticle Night Vision Brightness Settings
The Reticle Brightness Parameter Name applies to the reticle brightness parameter in the material instance. Provided in the example project are many materials and material functions already preconfigured for you. The default parameter name "ReticleBrightness" applies to the provided material parameter names.
The Reticle Brightness settings are different brightness levels you want the reticles to have that you can cycle through. The Reticle Night Vision Brightness Settings are the same but only apply when the optic is in Night Vision Mode.
The Magnification Settings apply only to magnified optics using the SKGOpticSceneCaptureComponent (Currently).
Magnifications is an array of zoom levels/magnification you want the optic to use. For example, the provided LPVO uses 1.0, 2.5, 5.0, 8.0 as it is a 1-8 power optic.
If Smooth Zoom is enables, as you change magnifications it will change smoothly between the magnifications ate a speed specified in Smooth Zoom Rate.
The Shrink Eyebox With Magnification option is for some added realism. As you zoom in with your optic in real life, your eyebox will shrink and make it more difficult to keep your eye centered in the eyebox. With Shrink Eyebox With Magnification enabled, it will scale as you zoom in/out based on your Shrink Eyebox Multiplier setting.
Some optics are First Focal Plane, some are Second Focal Plane.
First Focal Plane: Your reticle will scale up/down with your magnification.
Second Focal Plane: Your reticle will not scale/change at all as you change magnifications.
The Optic Zero Settings apply only to magnified optics using the SKGOpticSceneCaptureComponent (Currently).
The Adjustment Amount option changes based on the Adjustment Type. If MRAD you will see MRADAdjustment Amount, if MOA you will see MOAAdjustment Amount.
MRAD: Adjustments will be made in Mills
MOA: Adjustments will be made in MOA
If true, your optic will start with the amount of clicks defined in Default Elevation/Windage Clicks.
If true, your optic will start with a random amount of clicks defined in Random Max Elevation/Windage Clicks. Default is 25 so it will range from -25 to 25.
If using a SKGOpticSceneCaptureComponent it will start capture.
If using a SKGOpticSceneCaptureComponent it will stop capture.
If your optic is magnified it will return true, false otherwise.
This function will return the mesh of your optic.
If you have multiple reticles assigned under your Reticle Materials it will cycle through them and assign them to your reticle.
These functions will change your reticles brightness defined in Reticle Brightness Settings. If you are in Night Vision Mode, it will use the values defined in Reticle Night Vision Brightness Settings.
Calling this will switch the reticle between the defined regular and night vision mode brightness settings.
These functions will zoom in and out optics that (currently) implement the SKGOpticSceneCaptureComponent based on your Magnification Settings.
This function will return the magnification your optic is currently on.
These functions will reset your elevation/windage back to your zero. For example if you changed your clicks on elevation or windage, it will reset them back to zero.
These functions will adjust your elevation and windage based on the amount of clicks you pass in. For example, an optic set to use MRAD at 0.1 mils will adjust at 1/10th of a mil per click.
This function is for optics with the SKGOpticSceneCaptureComponent and meant to be called from the SKGFirearmComponents ZeroOpticsForZeroAtLocation fuction. It is meant to be utilized alongside the SKGProjectileWorldSubsystem function GetProjectileZeroAtLocation which will get the rotation value for you. The SKGFirearmComponent has a function ZeroOpticsForZeroAtLocation which automates this process for all the optics on the firearm.