Hooks
Hooks provided by the First Person Effects module for managing camera view effects.
Overview
The First Person Effects module adds head bob and view sway, camera motion synced to actions, a realistic first-person feel, and adjustable intensity via config.. It provides comprehensive hook integration for customizing managing camera view effects and extending functionality.
FirstPersonEffectsUpdated
đ Purpose
Called when first person effects are updated during view calculation.
â° When Called
Every frame during CalcView when effects are active.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The local player |
position |
Vector | The current calculated position offset |
angles |
Angle | The current calculated angle offset |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The First Person Effects module adds head bob and view sway, camera motion synced to actions, a realistic first-person feel, and adjustable intensity via config.. It provides comprehensive hook integration for customizing managing camera view effects and extending functionality.
PostFirstPersonEffects
đ Purpose
Called after first person effects have been calculated.
â° When Called
After position and angle calculations are complete, before returning the view.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The local player |
position |
Vector | The calculated position offset |
angles |
Angle | The calculated angle offset |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The First Person Effects module adds head bob and view sway, camera motion synced to actions, a realistic first-person feel, and adjustable intensity via config.. It provides comprehensive hook integration for customizing managing camera view effects and extending functionality.
PreFirstPersonEffects
đ Purpose
Called before first person effects are calculated.
â° When Called
At the start of CalcView when effects are enabled.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The local player |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The First Person Effects module adds head bob and view sway, camera motion synced to actions, a realistic first-person feel, and adjustable intensity via config.. It provides comprehensive hook integration for customizing managing camera view effects and extending functionality.
ShouldUseFirstPersonEffects
đ Purpose
Called to determine if first person effects should be used.
â° When Called
During CalcView before effects are processed.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The local player |
âŠī¸ Returns
boolean - Return false to disable effects
đ Realm
Client