![]() |
|
Public Member Functions | |
| bool | IsScreenPositionInSights (vector screenPosition) |
| Returns whether screen position is in located within the sights radius. | |
| float | GetSightsRadiusScreen () |
| Calculate the radius of PIP sight in screen coordinates. | |
| SCR_PIPCamera | GetPIPCamera () |
| Returns the camera used for picture in picture mode or null if none. | |
| int | GetPIPCameraIndex () |
| Returns the camera index used by this component when enabled. | |
| 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. | |
| bool | IsPIPEnabled () |
| float | GetMainCameraFOV () |
| vector | GetMainCameraOffset () |
| void | SetPIPEnabled (bool enabled) |
| void | UpdateCamera (float timeSlice) |
| void | UpdateHDR () |
| void | UpdateScopeMaterial () |
| override bool | CanFreelook () |
| override int | _WB_GetAfterWorldUpdateSpecs (IEntity owner, IEntitySource src) |
| void | SCR_2DPIPSightsComponent (IEntityComponentSource src, IEntity ent, IEntity parent) |
| Constructor. | |
| void | ~SCR_2DPIPSightsComponent () |
| Destructor. | |
Public Member Functions inherited from SCR_2DSightsComponent | |
| override void | OnSightADSActivated () |
| Called every time the sight is activated. | |
| override void | OnSightADSDeactivated () |
| Called every time the sight is deactivated. | |
| SCR_SightsZoomFOVInfo | GetSightsFovInfo () |
Public Member Functions inherited from SCR_2DOpticsComponent | |
| float | GetReticleOffsetX () |
| void | GetReticleData (out float reticleAngularSize, out float reticlePortion, out float reticleBaseZoom) |
| float | GetObjectiveFov () |
| float | GetObjectiveScale () |
| bool | GetIsOpticsHidden () |
| float | GetMagnification () |
| float | GetAnimationSpeedBlur () |
| 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 () |
| bool | GetIsMoving () |
| bool | GetIsRotating () |
| float | GetScratchesRoll () |
| 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) |
| float | GetCurrentReticleOffsetY () |
| float | GetCurrentCameraPitchOffset () |
| 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) |
Public Member Functions inherited from SightsComponent | |
| 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 bool | IsPIPActive () |
| Returns true if any sights PIP is active. | |
Static Public Member Functions inherited from SCR_2DSightsComponent | |
| static bool | IsUsingSights () |
Static Public Member Functions inherited from SCR_2DOpticsComponent | |
| 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. | |
Public Attributes | |
| ref Material | m_pMaterial |
| int | m_iVignetteCenterXIndex = -1 |
| int | m_iVignetteCenterYIndex = -1 |
| int | m_iVignettePowerIndex = -1 |
| int | m_iLensDistortIndex = -1 |
| int | m_iReticleOffsetXIndex = -1 |
| int | m_iReticleOffsetYIndex = -1 |
| int | m_iReticleColorIndex = -1 |
| int | m_iReticleScaleIndex = -1 |
| int | m_iEdgeMinIndex = -1 |
| int | m_iEdgeMaxIndex = -1 |
| int | m_iEdgeCenterXIndex = -1 |
| int | m_iEdgeCenterYIndex = -1 |
Protected Member Functions | |
| float | GetFocusFOV () |
| bool | IsLocalControlledEntity (IEntity pEntity, bool checkHierarchy=true) |
| CameraBase | CreateCamera (IEntity parent, vector position, vector angles, int cameraIndex, float fov, float nearPlane, float farPlane) |
| Widget | CreateUI (string layout, string rtTextureName, string rtName, out RTTextureWidget RTTexture, out RenderTargetWidget RTWidget) |
| void | DestroyCamera (CameraBase camera) |
| float | GetMaxViewDistance (float desiredDistance) |
| Method used to limit desired distance to the values set by the game or the server. | |
| void | OnSettingsMenuClosed (ChimeraMenuBase menu) |
| Callback method used to update PIP properties when settings menu is closed. | |
| void | Destroy () |
| override void | EnableReticleIllumination (bool enable) |
| Toggle between illumination modes. | |
| override void | HandleSightActivation () |
| override void | HandleSightDeactivation () |
| override void | OnSightADSPostFrame (IEntity owner, float timeSlice) |
| Called on post-frame as long as sights ADS is active. | |
| override void | OnInit (IEntity owner) |
| Called during EOnInit. | |
| override 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. | |
| override void | _WB_AfterWorldUpdate (IEntity owner, float timeSlice) |
Protected Member Functions inherited from SCR_2DSightsComponent | |
| void | RegisterInputs () |
| void | UnregisterInputs () |
| void | SetupFovInfo () |
| void | SelectZoomLevel (int id) |
| Switch betweem zoom levels from sights. | |
| void | ActionZoomIn (float value=0.0, EActionTrigger reason=0) |
| Move zoom level up and down based on mouse wheel value. | |
| void | ActionZoomOut (float value=0.0, EActionTrigger reason=0) |
| Move zoom level up and down based on mouse wheel value. | |
| void | AdjustZoom (float value) |
| Move zoom level up and down based on mouse wheel value. | |
| void | ToggleIllumination (float value, EActionTrigger trigger) |
| Action for toggling illumination. | |
| SCR_ChimeraCharacter | GetCharacterOwner () |
| override float | GetReticleOffsetYTarget () |
Protected Member Functions inherited from SCR_2DOpticsComponent | |
| void | HideObjects () |
| Hides objects to prevent clipping when entering ADS. | |
| vector | GetSightsRelPosition () |
| 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) |
Protected Member Functions inherited from GameComponent | |
| void | OnDelete (IEntity owner) |
| Called when Entity is being to be destroyed (deleted) or component to be deleted. | |
Protected Attributes | |
| float | m_fScopeRadius |
| float | m_fMainCameraFOV |
| bool | m_b2DIsEnabled |
| Is this 2D currently enabled? | |
| int | m_iLastProjectionFrame = -1 |
| vector | m_vScreenScopeCenter |
| float | m_fScreenScopeRadiusSq |
| float | m_fScreenScopeRadius |
| float | m_fReticleScale |
| float | m_fEdgeScale = 1 |
| float | m_fParallaxX |
| float | m_fParallaxY |
| IEntity | m_ControlledEntity |
| ref Color | m_cReticleColor |
| Current PIP reticle color. | |
| ref Widget | m_wPIPRoot |
| The root layout hierarchy widget for PIP. | |
| bool | m_bPIPIsEnabled |
| Is PIP currently enabled? | |
| RTTextureWidget | m_wRenderTargetTextureWidget |
| The render target texture found within our layout. | |
| RenderTargetWidget | m_wRenderTargetWidget |
| The render target found within our layout. | |
| SCR_PIPCamera | m_PIPCamera |
| The camera to be used by this pip component. | |
Protected Attributes inherited from SCR_2DSightsComponent | |
| SCR_SightsZoomFOVInfo | m_SightsFovInfo |
Protected Attributes inherited from SCR_2DOpticsComponent | |
| float | m_fReticleOffsetX |
| float | m_fReticleOffsetY |
| float | m_fObjectiveFov |
| float | m_fObjectiveScale |
| float | m_fReticleAngularSize |
| float | m_fReticlePortion |
| float | m_fReticleBaseZoom |
| float | m_fMagnification |
| float | m_fCurrentReticleOffsetY |
| float | m_fCurrentCameraPitch |
| int | m_iSelectedZoomLevel |
| float | m_fScratchesRoll |
| float | m_fFovZoomed |
| float | m_fDefaultSize |
| float | m_fNearPlaneCurrent |
| bool | m_bIsMoving |
| bool | m_bIsRotating |
| bool | m_bWasEntityHidden |
| int | m_iHeadBoneId = -1 |
| bool | m_bIsOpticsHidden |
| bool | m_bIsIlluminationOn |
| ChimeraCharacter | m_ParentCharacter |
| ref ScriptInvokerVoid | s_OnSetupOpticImage = new ScriptInvokerVoid() |
| ref ScriptInvokerBase< On2DOpticsIlluminationChange > | s_OnIlluminationChange = new ScriptInvokerBase<On2DOpticsIlluminationChange>() |
Static Protected Attributes | |
| static int | s_bIsPIPActive |
Static Protected Attributes inherited from SCR_2DSightsComponent | |
| static bool | s_bIsUsingSights |
Additional Inherited Members | |
Static Public Attributes inherited from SCR_2DOpticsComponent | |
| 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" |
| void SCR_2DPIPSightsComponent.SCR_2DPIPSightsComponent | ( | IEntityComponentSource | src, |
| IEntity | ent, | ||
| IEntity | parent ) |
Constructor.
| void SCR_2DPIPSightsComponent.~SCR_2DPIPSightsComponent | ( | ) |
Destructor.
|
protected |
| override int SCR_2DPIPSightsComponent._WB_GetAfterWorldUpdateSpecs | ( | IEntity | owner, |
| IEntitySource | src ) |
|
protected |
Applies the given recoil angles to the camera transform according to the type of sight By default this method is empty.
It should be overridden by each sight to make the appropriate adjustments
Implements SCR_2DSightsComponent.
| override bool SCR_2DPIPSightsComponent.CanFreelook | ( | ) |
Implements SCR_2DSightsComponent.
|
protected |
| parent | Parent entity this camera should be attached to |
| position | Local offset from parent entity |
| cameraIndex | The index created camera should use, 0-31 |
| fov | The field of view of camera 0-89 |
| nearPlane | Near clipping plane of the camera in metres |
| farPlane | Far clipping plane of the camera in metres |
|
protected |
|
protected |
|
protected |
|
protected |
Toggle between illumination modes.
Implements SCR_2DOpticsComponent.
| override float SCR_2DPIPSightsComponent.GetADSActivationPercentageScript | ( | ) |
Called to get the ADS percentage when the sights go active.
Implements SCR_2DOpticsComponent.
| override float SCR_2DPIPSightsComponent.GetADSDeactivationPercentageScript | ( | ) |
Called to get the ADS percentage when the sights go inactive.
Implements SCR_2DOpticsComponent.
|
protected |
| float SCR_2DPIPSightsComponent.GetMainCameraFOV | ( | ) |
| vector SCR_2DPIPSightsComponent.GetMainCameraOffset | ( | ) |
|
protected |
Method used to limit desired distance to the values set by the game or the server.
| [in] | desiredDistance | distance that should be evaluated against the game settings |
| SCR_PIPCamera SCR_2DPIPSightsComponent.GetPIPCamera | ( | ) |
Returns the camera used for picture in picture mode or null if none.
| int SCR_2DPIPSightsComponent.GetPIPCameraIndex | ( | ) |
Returns the camera index used by this component when enabled.
| float SCR_2DPIPSightsComponent.GetSightsRadiusScreen | ( | ) |
Calculate the radius of PIP sight in screen coordinates.
|
protected |
Implements SCR_2DSightsComponent.
|
protected |
Implements SCR_2DSightsComponent.
|
protected |
|
static |
Returns true if any sights PIP is active.
| bool SCR_2DPIPSightsComponent.IsPIPEnabled | ( | ) |
| bool SCR_2DPIPSightsComponent.IsScreenPositionInSights | ( | vector | screenPosition | ) |
Returns whether screen position is in located within the sights radius.
| screenPosition | Point on screen |
|
protected |
Called during EOnInit.
| owner | Entity this component is attached to. |
Implements SCR_2DOpticsComponent.
|
protected |
Callback method used to update PIP properties when settings menu is closed.
| [in] | menu | which was just closed |
|
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 SCR_2DOpticsComponent.
| void SCR_2DPIPSightsComponent.SetPIPEnabled | ( | bool | enabled | ) |
| void SCR_2DPIPSightsComponent.UpdateCamera | ( | float | timeSlice | ) |
| void SCR_2DPIPSightsComponent.UpdateHDR | ( | ) |
| void SCR_2DPIPSightsComponent.UpdateScopeMaterial | ( | ) |
|
protected |
Is this 2D currently enabled?
|
protected |
Is PIP currently enabled?
|
protected |
|
protected |
Current PIP reticle color.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
| int SCR_2DPIPSightsComponent.m_iEdgeCenterXIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iEdgeCenterYIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iEdgeMaxIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iEdgeMinIndex = -1 |
|
protected |
| int SCR_2DPIPSightsComponent.m_iLensDistortIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iReticleColorIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iReticleOffsetXIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iReticleOffsetYIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iReticleScaleIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iVignetteCenterXIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iVignetteCenterYIndex = -1 |
| int SCR_2DPIPSightsComponent.m_iVignettePowerIndex = -1 |
|
protected |
The camera to be used by this pip component.
| ref Material SCR_2DPIPSightsComponent.m_pMaterial |
|
protected |
|
protected |
The root layout hierarchy widget for PIP.
|
protected |
The render target texture found within our layout.
|
protected |
The render target found within our layout.
|
staticprotected |