Skip to content

Gameplay Settings

Description

The Gameplay Settings Asset is a data container for the behaviour settings of some player actions, like holding a button or simply tapping it to do an action, camera Field Of View (FOV) and mouse axes behaviour.

Editor Properties

Property Function
Field Of View Defines the camera FOV in hip-fire mode.
Aim Style Defines the Aim Down Sights behavior according to input mode.
Crouch Style Defines the Crouch behavior according to input mode.
Sprint Style Defines the Sprint behavior according to input mode.
Lean Style Defines the Lean behavior according to input mode.
Mouse Sensitivity Defines the overall mouse sensitivity.
Invert Horizontal Axis Defines whether the camera’s horizontal movement must be opposite to the mouse movement.
Invert Vertical Axis Defines whether the camera’s vertical movement must be opposite to the mouse movement.

Public Properties

Property Function
CrouchStyle Defines the crouch behaviour according to the player's input.
AimStyle Defines the aiming behaviour according to the player's input.
SprintStyle Defines the running behaviour according to the player's input.
LeanStyle Defines the leaning behaviour according to the player's input.
OverallMouseSensitivity Defines the overall mouse sensitivity.
InvertHorizontalAxis Returns true if the mouse input is reversed, false otherwise.
InvertVerticalAxis Returns true if the mouse input is reversed, false otherwise.
FieldOfView Returns the target field of view used by the character main camera.