Arma Reforger Script API
|
Base class for 2D optics Unifiying binoculars and optic sight. More...
Public Member Functions | |
override float | GetADSActivationPercentageScript () |
Called to get the ADS percentage when the sights go active. | |
override float | GetADSDeactivationPercentageScript () |
Called to get the ADS percentage when the sights go inactive. | |
float | GetReticleOffsetX () |
void | GetReticleTextures (out ResourceName reticleTexture, out ResourceName reticleTextureGlow, out ResourceName filterTexture) |
void | GetReticleData (out float reticleAngularSize, out float reticlePortion, out float reticleBaseZoom) |
float | GetObjectiveFov () |
float | GetObjectiveScale () |
float | GetVignetteScale () |
float | GetMisalignmentDampingSpeed () |
float | GetRotationScale () |
float | GetRotationDampingSpeed () |
float | GetMovementScale () |
float | GetMovementDampingSpeed () |
float | GetRollScale () |
float | GetRollDampingSpeed () |
float | GetMisalignmentScale () |
float | GetVignetteMoveSpeed () |
float | GetMotionBlurScale () |
float | GetMotionBlurMax () |
SCR_EPIPZeroingType | GetZeroType () |
float | GetMagnification () |
bool | GetIsOpticsHidden () |
ScriptInvokerVoid | OnSetupOpticImage () |
ScriptInvokerBase< On2DOpticsIlluminationChange > | OnIlluminationChange () |
float | GetFovZoomed () |
Get base FOV of the optic, used to determine maximum FOV. | |
void | SetFovZoomed (float value) |
Set base FOV of the optic. Negative value means magnification to compute new m_fFovZoomed with. | |
float | GetNearPlane () |
int | GetAnimationActivationDelay () |
int | GetAnimationDeactivationDelay () |
float | GetAnimationEnterTime () |
float | GetAnimationSpeedBlur () |
bool | GetIsMoving () |
bool | GetIsRotating () |
float | GetScratchesRoll () |
override void | OnInit (IEntity owner) |
Called during EOnInit. | |
override void | OnSightADSActivated () |
Called every time the sight is activated. | |
override void | OnSightADSDeactivated () |
Called every time the sight is deactivated. | |
bool | IsMoveCloseToLimit (vector move, float limitMin) |
Return true if move X a Y is below limit. | |
vector | GetMisalignmentAngles (notnull CameraBase camera) |
Get sight angles in camera space ! | |
vector | GetRotation (out vector previousDir, float timeSlice) |
vector | GetMovement (out vector previousPos, float timeSlice) |
bool | HasIllumination () |
Color | GetReticleColor () |
Color | GetReticleOutlineColor () |
Color | GetReticleIlluminationColor () |
float | GetCurrentReticleOffsetY () |
float | GetCurrentCameraPitchOffset () |
vector | GetCameraOffset () |
vector | GetCameraAngles () |
IEntity | GetCameraLocalTransform (out vector matrix[4]) |
Return actual parent (weapon) with calculated transformation in relation to it. | |
void | SetObjectiveFov (float objectiveFov) |
void | SetObjectiveScale (float objectiveScale) |
void | SetReticleBaseZoom (float reticleBaseZoom) |
void | SetReticleAngularSize (float reticleAngularSize) |
void | SetReticlePortion (float reticlePortion) |
void | SetReticleOffsetX (float reticleOffsetX) |
void | SetReticleOffsetY (float reticleOffsetY) |
void | OnInit (IEntity owner) |
Called during EOnInit. | |
void | OnSightADSActivated () |
Called every time the sight is activated. | |
void | OnSightADSPostFrame (IEntity owner, float timeSlice) |
Called on post-frame as long as sights ADS is active. | |
void | OnSightADSDeactivated () |
Called every time the sight is deactivated. | |
float | GetADSActivationPercentageScript () |
Called to get the ADS percentage when the sights go active. | |
float | GetADSDeactivationPercentageScript () |
Called to get the ADS percentage when the sights go inactive. | |
Public Member Functions inherited from SightsComponent | |
void | ApplyRecoilToCamera (inout vector pOutCameraTransform[4], vector aimModAngles) |
Applies the given recoil angles to the camera transform according to the type of sight By default this method is empty. | |
bool | CanFreelook () |
bool | GetDOFRelatedPrefabData (out int opticDOFDistanceScale=-1, out bool forceSimpleDOF=false) |
Used by SCR_DepthOfFieldEffect to scale the DOF based on each particular ironsight-distance. | |
Public Member Functions inherited from BaseSightsComponent | |
proto external IEntity | GetOwner () |
proto external void | ForceSightsZeroValue (vector offset, vector angles, vector turnOffset) |
Allow to override Zeroing via aim modifier (only works in Workbench) | |
proto external void | ForceSightsZeroValueEnablel (bool bOnOff) |
Disable forced zeroing data. | |
proto external bool | IsSightADSActive () |
proto external float | GetADSActivationPercentage () |
proto external float | GetADSDeactivationPercentage () |
proto external bool | AreSightsValid (bool front=true, bool rear=true) |
proto external vector | GetSightsRearPosition (bool localSpace=false) |
Returns additional sights position used for calculating zeroing A vector is calculated from start position to end position and used as direction for calculating zeroing offsets Start position should be the one closer to eye position than end position. | |
proto external vector | GetSightsFrontPosition (bool localSpace=false) |
Returns additional sights position used for calculating zeroing A vector is calculated from start position to end position and used as direction for calculating zeroing offsets End position should be the one further from eye position than start position. | |
proto external vector | GetSightsDirection (bool localSpace=false, bool normalize=true) |
Returns a direction vector from the rear sight position to the front sight position A vector is calculated from the rear sight to the front sight in such a way that GetSightsRearPosition() + GetSightsDirection() == GetSightsFrontPosition() | |
proto external vector | GetSightsDirectionUntransformed (bool localSpace=false, bool normalize=true) |
Like GetSightsDirection, but ignores and bones associated with the sight points. | |
proto external vector | GetSightsOffset () |
Returns the local sights reference point offset. | |
proto external bool | GetSightsTransform (out vector transform[4], bool localSpace=false) |
Returns the transform matrix of the local sights. | |
proto external float | GetFOV () |
Returns current value of field of view. | |
proto external vector | GetCurrentSightsRange () |
Returns current range info value where x: animation value y: distance z: unused. | |
proto external SightsFOVInfo | GetFOVInfo () |
Returns currently selected sights FOV info or null if none. | |
proto external float | GetCameraRecoilAmount () |
Percentage 0...1 of recoil that should be applied to camera when using this sights component. | |
proto external bool | GetSightsPriority () |
Boolean indicating whether this sight component is prioritized. | |
proto external bool | GetSightsSkipSwitch () |
Return true if the sights can be switched to. | |
proto external void | SetSightsVisibility (float visFactor) |
Hide parts of the sight on ADS. 0 means completely visible, 1 means completely hidden. | |
proto external PointInfo | GetPositionPointInfo () |
proto external PointInfo | GetRearPositionPointInfo () |
proto external PointInfo | GetFrontPositionPointInfo () |
Public Member Functions inherited from GameComponent | |
bool | OnTicksOnRemoteProxy () |
Static Public Member Functions | |
static float | CalculateZoomFOV (float magnification) |
Return camera FOV for given magnification. Focus FOV is used as reference 1x magnification. | |
Static Public Member Functions inherited from SightsComponent | |
static ZeroingGeneratedData | CalculateDataWithParent (BaseSightsComponent sights, IEntity owner, IEntity parent, float desiredAngle) |
Takes front sights position as the anchor around which it rotates both the owner and the parent under desiredAngle (or rather negative desired angle, as we are pivoting around our target) and calculates new transformation that needs to be applied to reach desired angle. | |
Static Public Attributes | |
const string | ACTION_ZOOM_IN = "WeaponOpticsZoomIn" |
const string | ACTION_ZOOM_OUT = "WeaponOpticsZoomOut" |
const string | ACTION_ILLUMINATION = "WeaponToggleSightsIllumination" |
const float | REFERENCE_FOV = 28 |
const float | OPACITY_INITIAL = 0.75 |
const float | NEAR_PLANE_DEFAULT = 0.05 |
const float | NEAR_PLANE_ZOOMED = 0.05 |
static ref ScriptInvokerBase< OnSightsADSChanged > | s_OnSightsADSChanged = new ScriptInvokerBase<OnSightsADSChanged>() |
static ref ScriptInvokerBase< On2DOpticsADSChange > | s_On2DOpticADSChanged = new ScriptInvokerBase<On2DOpticsADSChange>() |
Static Public Attributes inherited from SightsComponent | |
const string | EYE_BONE = "eye" |
Protected Member Functions | |
void | HandleSightActivation () |
void | HandleSightDeactivation () |
override void | OnSightADSPostFrame (IEntity owner, float timeSlice) |
Called on post-frame as long as sights ADS is active. | |
void | HideObjects () |
Hides objects to prevent clipping when entering ADS. | |
vector | GetSightsRelPosition () |
void | EnableReticleIllumination (bool enable) |
Toggle between illumination modes. | |
float | GetReticleOffsetYTarget () |
float | GetCameraPitchTarget () |
Protected Member Functions inherited from SightsComponent | |
override bool | WB_GetZeroingData (IEntity owner, BaseSightsComponent sights, float weaponAngle, out vector offset, out vector angles) |
Positive weapon angle tilts weapon upwards (muzzle goes up, stock goes down) Negative weapon angle tilts weapon downwards (muzzle goes down, stock goes up) Called from GameCode, do not remove! | |
bool | FindParent (IEntity owner, string eyeBoneName, out IEntity parentWeapon, out int boneIndex) |
bool | WB_GetZeroingData (IEntity owner, BaseSightsComponent sights, float weaponAngle, out vector offset, out vector angles) |
Positive weapon angle tilts weapon upwards (muzzle goes up, stock goes down) Negative weapon angle tilts weapon downwards (muzzle goes down, stock goes up) Called from GameCode, do not remove! | |
Base class for 2D optics Unifiying binoculars and optic sight.
|
static |
Return camera FOV for given magnification. Focus FOV is used as reference 1x magnification.
|
protected |
Toggle between illumination modes.
Implemented in SCR_2DPIPSightsComponent.
override float SCR_2DOpticsComponent.GetADSActivationPercentageScript | ( | ) |
Called to get the ADS percentage when the sights go active.
Implements ScriptedSightsComponent.
Implemented in SCR_2DPIPSightsComponent.
override float SCR_2DOpticsComponent.GetADSDeactivationPercentageScript | ( | ) |
Called to get the ADS percentage when the sights go inactive.
Implements ScriptedSightsComponent.
Implemented in SCR_2DPIPSightsComponent.
int SCR_2DOpticsComponent.GetAnimationActivationDelay | ( | ) |
int SCR_2DOpticsComponent.GetAnimationDeactivationDelay | ( | ) |
float SCR_2DOpticsComponent.GetAnimationEnterTime | ( | ) |
float SCR_2DOpticsComponent.GetAnimationSpeedBlur | ( | ) |
vector SCR_2DOpticsComponent.GetCameraAngles | ( | ) |
IEntity SCR_2DOpticsComponent.GetCameraLocalTransform | ( | out vector | matrix[4] | ) |
Return actual parent (weapon) with calculated transformation in relation to it.
matrix | Out rotation in relation to new parent |
These multiplications will run even if we have no weapon, but it shouldn't be that big of a deal for now, weapon should exist regardless
vector SCR_2DOpticsComponent.GetCameraOffset | ( | ) |
|
protected |
float SCR_2DOpticsComponent.GetCurrentCameraPitchOffset | ( | ) |
float SCR_2DOpticsComponent.GetCurrentReticleOffsetY | ( | ) |
float SCR_2DOpticsComponent.GetFovZoomed | ( | ) |
Get base FOV of the optic, used to determine maximum FOV.
bool SCR_2DOpticsComponent.GetIsMoving | ( | ) |
bool SCR_2DOpticsComponent.GetIsOpticsHidden | ( | ) |
bool SCR_2DOpticsComponent.GetIsRotating | ( | ) |
float SCR_2DOpticsComponent.GetMagnification | ( | ) |
vector SCR_2DOpticsComponent.GetMisalignmentAngles | ( | notnull CameraBase | camera | ) |
Get sight angles in camera space !
camera | entity to get misalignment against ! |
float SCR_2DOpticsComponent.GetMisalignmentDampingSpeed | ( | ) |
float SCR_2DOpticsComponent.GetMisalignmentScale | ( | ) |
float SCR_2DOpticsComponent.GetMotionBlurMax | ( | ) |
float SCR_2DOpticsComponent.GetMotionBlurScale | ( | ) |
vector SCR_2DOpticsComponent.GetMovement | ( | out vector | previousPos, |
float | timeSlice | ||
) |
float SCR_2DOpticsComponent.GetMovementDampingSpeed | ( | ) |
float SCR_2DOpticsComponent.GetMovementScale | ( | ) |
float SCR_2DOpticsComponent.GetNearPlane | ( | ) |
float SCR_2DOpticsComponent.GetObjectiveFov | ( | ) |
float SCR_2DOpticsComponent.GetObjectiveScale | ( | ) |
Color SCR_2DOpticsComponent.GetReticleColor | ( | ) |
void SCR_2DOpticsComponent.GetReticleData | ( | out float | reticleAngularSize, |
out float | reticlePortion, | ||
out float | reticleBaseZoom | ||
) |
Color SCR_2DOpticsComponent.GetReticleIlluminationColor | ( | ) |
float SCR_2DOpticsComponent.GetReticleOffsetX | ( | ) |
|
protected |
Implemented in SCR_2DSightsComponent.
Color SCR_2DOpticsComponent.GetReticleOutlineColor | ( | ) |
void SCR_2DOpticsComponent.GetReticleTextures | ( | out ResourceName | reticleTexture, |
out ResourceName | reticleTextureGlow, | ||
out ResourceName | filterTexture | ||
) |
float SCR_2DOpticsComponent.GetRollDampingSpeed | ( | ) |
float SCR_2DOpticsComponent.GetRollScale | ( | ) |
vector SCR_2DOpticsComponent.GetRotation | ( | out vector | previousDir, |
float | timeSlice | ||
) |
float SCR_2DOpticsComponent.GetRotationDampingSpeed | ( | ) |
float SCR_2DOpticsComponent.GetRotationScale | ( | ) |
float SCR_2DOpticsComponent.GetScratchesRoll | ( | ) |
|
protected |
float SCR_2DOpticsComponent.GetVignetteMoveSpeed | ( | ) |
float SCR_2DOpticsComponent.GetVignetteScale | ( | ) |
SCR_EPIPZeroingType SCR_2DOpticsComponent.GetZeroType | ( | ) |
|
protected |
Implemented in SCR_2DPIPSightsComponent, and SCR_2DSightsComponent.
|
protected |
Implemented in SCR_2DPIPSightsComponent, and SCR_2DSightsComponent.
bool SCR_2DOpticsComponent.HasIllumination | ( | ) |
|
protected |
Hides objects to prevent clipping when entering ADS.
bool SCR_2DOpticsComponent.IsMoveCloseToLimit | ( | vector | move, |
float | limitMin | ||
) |
Return true if move X a Y is below limit.
ScriptInvokerBase< On2DOpticsIlluminationChange > SCR_2DOpticsComponent.OnIlluminationChange | ( | ) |
override void SCR_2DOpticsComponent.OnInit | ( | IEntity | owner | ) |
Called during EOnInit.
owner | Entity this component is attached to. |
Implements ScriptedSightsComponent.
Implemented in SCR_2DPIPSightsComponent.
ScriptInvokerVoid SCR_2DOpticsComponent.OnSetupOpticImage | ( | ) |
override void SCR_2DOpticsComponent.OnSightADSActivated | ( | ) |
Called every time the sight is activated.
Implements ScriptedSightsComponent.
Implemented in SCR_2DSightsComponent.
override void SCR_2DOpticsComponent.OnSightADSDeactivated | ( | ) |
Called every time the sight is deactivated.
Implements ScriptedSightsComponent.
Implemented in SCR_2DSightsComponent.
|
protected |
Called on post-frame as long as sights ADS is active.
owner | Entity this component is attached to. |
timeSlice | Delta time since last update. |
Implements ScriptedSightsComponent.
Implemented in SCR_2DPIPSightsComponent.
void SCR_2DOpticsComponent.SetFovZoomed | ( | float | value | ) |
Set base FOV of the optic. Negative value means magnification to compute new m_fFovZoomed with.
void SCR_2DOpticsComponent.SetObjectiveFov | ( | float | objectiveFov | ) |
void SCR_2DOpticsComponent.SetObjectiveScale | ( | float | objectiveScale | ) |
void SCR_2DOpticsComponent.SetReticleAngularSize | ( | float | reticleAngularSize | ) |
void SCR_2DOpticsComponent.SetReticleBaseZoom | ( | float | reticleBaseZoom | ) |
void SCR_2DOpticsComponent.SetReticleOffsetX | ( | float | reticleOffsetX | ) |
void SCR_2DOpticsComponent.SetReticleOffsetY | ( | float | reticleOffsetY | ) |
void SCR_2DOpticsComponent.SetReticlePortion | ( | float | reticlePortion | ) |
|
static |
|
static |
|
static |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
static |
|
static |
|
static |
|
static |
|
static |
|
protected |
|
protected |
|
static |