METROLORE Docs
  1. Docs
  2. Gameplay Camera
  3. Configuration

M2Line M2 · Gameplay CameraView in store →

Configuration

All options are in config/cl_config.lua. The texts of the interface are in locales/en.lua and locales/tr.lua.

#General

Option Default Meaning
Config.Locale 'en' Language: 'en' or 'tr'.
Config.CameraMode 'freecam' 'freecam' (fly freely) or 'orbit' (the camera circles the character). Studio tools like paths, live cameras and following need 'freecam'.
Config.EnableHelpKeyPrompt true Shows the key panel on the right.
Config.FreezePlayer true The character stands still while the camera is open.
Config.AllowEmotesWhileActive true Emotes and poses keep working while the camera is open.
Config.BlockExternalControls true Closes other menus (inventory and similar) while the camera is open.
Config.BlockedStates cuffed, dead Player state flags that stop the camera from opening.

#Opening

Option Default Meaning
Config.ActivateMode 'toggle' 'toggle': hold V to open, ESC to close. 'hold': the camera is open only while V is held.
Config.ActivateHoldDuration 4500 How long V is held to open the camera (milliseconds).
Config.ShowHoldProgress true Shows a hint while V is held.
Config.CloseOnEsc true ESC closes the camera.
Config.AllowInVehicle true The camera can be used from a vehicle seat.
Config.VehicleRequiresEngineOff true In a vehicle the camera works only while the engine is off.
Config.VehicleMaxSpeed 1.0 Highest vehicle speed (m/s) at which the camera still works.

#Movement and view

Option Default Meaning
Config.FreecamMoveRate 4.5 Flying speed in metres per second. Roles multiply it.
Config.MoveSpeed { 0.25, 2.0 } The slow and the fast multiplier.
Config.MouseSensitivity 3.0 Mouse look.
Config.MouseInvertY false Inverts the vertical mouse look.
Config.DefaultFov, MinFov, MaxFov 50, 25, 70 Field of view.
Config.FreecamObstructionBlur true Blurs the picture when a wall gets between the camera and the character.
Config.CameraPresets 4 angles The preset angles on the keys 1 to 4.

#Distance limit

Option Default Meaning
Config.MaxDistance 15.0 Distance from the character in metres. Roles override it.
Config.DistanceControlMode 'hybrid' 'classic' (warnings), 'blur' (blur, then close) or 'hybrid' (both).
Config.AutoCloseOnMaxDistance true Closes the camera at the limit.
Config.AutoCloseDelay 2500 How long the full blur stays before the camera closes (milliseconds).

#Cinematic mode

Config.Cinematic:

Option Default Meaning
Letterbox, LetterboxHeight true, 0.08 The black bars (used when the film ratio is Default).
SubtleShake, ShakeIntensity true, 0.08 The handheld shake.
HideCustomHud true Hides your HUD resources (see Integrations).
HudIntegrations, HudEvents mlr_hud Which HUD resources to hide.
HidePanelInCinematic true Hides the key panel in cinematic mode.

#Roles

Config.Roles has one table per role (player, press, director) with maxPoints, maxDuration, maxSaved, maxDistance, moveScale and features. Press and director also have ace, jobs and followMaxDistance (metres, 0 = no limit). Config.Roles.Order lists the roles from the highest. See Roles and permissions.

#Studio

Config.Studio:

Option Default Meaning
Enabled true Turns the studio panel off for everyone when false.
DefaultDuration 8.0 Starting duration of a path (seconds).
MinFov, MaxFov 15, 90 Field of view range of the studio.
CinematicOnPlay true Hides the HUD while a path plays.
RecordCountdown, RecordTail 5, 2.0 Seconds of countdown and of tail in Record take.
MaxShots, MaxSequences 50, 20 Shots in a sequence and saved sequences.
Filters 7 Colour filters. Each has an id and a game colour modifier.

#Scene and live cameras

Option Meaning
Config.Scene.Ratios The film ratios (value is width divided by height).
Config.Scene.Weathers The weather types a director can choose.
Config.Scene.SyncDisableEvents, SyncEnableEvents Client events that pause and resume your weather script.
Config.Multicam.Keys Controls for the live cameras 1 to 9.
Config.Multicam.TransitionTime Seconds of the glide between live cameras (0 for a cut).
Config.Multicam.MaxRigs Saved camera rigs.

#Keys

Config.Controls holds the camera controls (Fast, Slow, Studio and the movement keys) as game control indexes with a label that the key panel shows. Config.Keys holds the key mappings players can change in the FiveM settings (close, reset, cinematic).