# Class `Flow.Settings`

Global engine settings which don't fall into particular category or can't be assigned to a specific object.

Can be accessed using Flow.SetSettings and Flow.GetSettings functions.

## Animations

crawlExtended | Extended crawl moveset.
crouchRoll | Crouch roll.
crawlspaceSwandive | Crawlspace dive.
sprintJump | Sprint jump.
ledgeJumps | Ledge jumps.
poseTimeout | Pose timeout.

## Camera

binocularLightColor | Determines highlight color in binocular mode.
lasersightLightColor | Determines highlight color in lasersight mode.
objectCollision | Specify whether camera can collide with objects.

## Flare

color | Flare color.
offset | Muzzle offset.
range | Light range.
timeout | Burn timeout.
pickupCount | Default flare pickup count.
lensflareBrightness | Lens flare brightness.
sparks | Toggle spark effect.
smoke | Toggle smoke effect.
flicker | Toggle flicker effect.

## Hair

mesh | Root mesh to which hair object will attach to.
offset | Relative braid offset to a headmesh.
indices | Braid connection indices.

## Hud

statusBars | Toggle in-game status bars visibility.
loadingBar | Toggle loading bar visibility.
speedometer | Toggle speedometer visibility.
pickupNotifier | Toggle pickup notifier visibility.

## Physics

gravity | Global world gravity.
swimVelocity | Swim velocity.

## Weapons

accuracy | Shooting accuracy.
targetingDistance | Targeting distance.
interval | Shooting interval.
damage | Damage.
alternateDamage | Alternate damage.
waterLevel | Water level.
pickupCount | Default ammo pickup count.
flashColor | Gunflash color.
flashRange | Gunflash range.
flashDuration | Gunflash duration.
smoke | Gun smoke.
shell | Gun shell.
muzzleFlash | Display muzzle flash.
colorizeMuzzleFlash | Colorize muzzle flash.

## System

errorMode | How should the application respond to script errors?
fastReload | Can the game utilize the fast reload feature?

## Animations

These settings determine whether a specific moveset is available in-game.

crawlExtended
  Extended crawl moveset.
  - crawlExtended bool when enabled, player will be able to traverse across one-click steps in crawlspaces.
crouchRoll
  Crouch roll.
  - crouchRoll bool when enabled, player can perform crawlspace roll by pressing sprint key.
crawlspaceSwandive
  Crawlspace dive.
  - crawlspaceSwandive bool when enabled, player will be able to swandive into crawlspaces.
sprintJump
  Sprint jump.
  - sprintJump bool if enabled, player will be able to perform extremely long jump when sprinting.
ledgeJumps
  Ledge jumps.
  - ledgeJumps bool if this setting is enabled, player will be able to jump upwards while hanging on the ledge.
poseTimeout
  Pose timeout.
  - poseTimeout int if this setting is larger than 0, idle standing pose animation will be performed after given timeout (in seconds).

## Camera

Parameters to customize camera and everything related to it.

binocularLightColor
  Determines highlight color in binocular mode.
  - binocularLightColor Color color of highlight, when player presses action. Zero color means there will be no highlight.
lasersightLightColor
  Determines highlight color in lasersight mode.
  - lasersightLightColor Color lasersight highlight color. Zero color means there will be no highlight.
objectCollision
  Specify whether camera can collide with objects.
  - objectCollision bool when enabled, camera will collide with moveables and statics. Disable or TR4-like camera behaviour.

## Flare

These settings change appearance and behaviour of a flare.

color
  Flare color.
  - color Color flare color. Used for sparks and lensflare coloring as well.
offset
  Muzzle offset.
  - offset Vec3 a relative muzzle offset where light and particle effects originate from.
range
  Light range.
  - range int flare light radius or range. Represented in "clicks" equal to 256 world units.
timeout
  Burn timeout.
  - timeout int flare burn timeout. Flare will stop working after given timeout (specified in seconds).
pickupCount
  Default flare pickup count.
  - pickupCount int specifies amount of flares that you get when you pick up a box of flares.
lensflareBrightness
  Lens flare brightness.
  - lensflareBrightness float brightness multiplier. Specifies how bright lens flare is in relation to light (on a range from 0 to 1).
sparks
  Toggle spark effect.
  - sparks bool spark effect. Determines whether flare generates sparks when burning.
smoke
  Toggle smoke effect.
  - smoke bool smoke effect. Determines whether flare generates smoke when burning.
flicker
  Toggle flicker effect.
  - flicker bool light and lensflare flickering. When turned off, flare light will be constant.

## Hair

This is a table of braid object settings.
Table consists of three entries, with first one representing classic Lara braid, and 2 and 3 representing left and right young Lara braids respectively. Therefore, if you want to access classic Lara braid settings, use `settings.Hair[1]`, and so on.

mesh
  Root mesh to which hair object will attach to.
  - mesh int index of a root mesh to which hair will attach. Root mesh may be different for each hair object.
offset
  Relative braid offset to a headmesh.
  - offset Vec3 specifies how braid is positioned in relation to a headmesh.
indices
  Braid connection indices.
  - indices table a list of headmesh's vertex connection indices. Each index corresponds to nearest braid rootmesh vertex. Amount of indices is unlimited.

## Hud

These settings determine visibility of particular in-game HUD elements.

statusBars
  Toggle in-game status bars visibility.
  - statusBars bool if disabled, all status bars (health, air, stamina) will be hidden.
loadingBar
  Toggle loading bar visibility.
  - loadingBar bool if disabled, loading bar will be invisible in game.
speedometer
  Toggle speedometer visibility.
  - speedometer bool if disabled, speedometer will be invisible in game.
pickupNotifier
  Toggle pickup notifier visibility.
  - pickupNotifier bool if disabled, pickup notifier will be invisible in game.

## Physics

Here you will find various settings for game world physics.

gravity
  Global world gravity.
  - gravity float specifies global gravity. Mostly affects Lara and several other objects.
swimVelocity
  Swim velocity.
  - swimVelocity float specifies swim velocity for Lara. Affects both surface and underwater.

## Weapons

This is a table of weapon settings, with several parameters available for every weapon. Access particular weapon's settings by using Objects.WeaponType as an index for this table, e.g. `settings.Weapons[Flow.WeaponType.PISTOLS]`.

accuracy
  Shooting accuracy.
  - accuracy float determines accuracy range in angles (smaller angles mean higher accuracy). Applicable only for firearms.
targetingDistance
  Targeting distance.
  - targetingDistance float specifies maximum targeting distance in world units (1 block = 1024 world units) for a given weapon.
interval
  Shooting interval.
  - interval float specifies an interval (in frames), after which Lara is able to shoot again. Not applicable for backholster weapons.
damage
  Damage.
  - damage int amount of hit points taken for every hit.
alternateDamage
  Alternate damage.
  - alternateDamage int for Revolver and HK, specifies damage in lasersight mode. For crossbow, specifies damage for explosive ammo.
waterLevel
  Water level.
  - waterLevel int specifies water depth, at which Lara will put weapons back into holsters, indicating it's not possible to use it in water.
pickupCount
  Default ammo pickup count.
  - pickupCount int amount of ammo which is given with every ammo pickup for this weapon.
flashColor
  Gunflash color.
  - flashColor Color specifies the color of the gunflash. Applicable only for firearms.
flashRange
  Gunflash range.
  - flashRange Color specifies the range of the gunflash. Applicable only for firearms.
flashDuration
  Gunflash duration.
  - flashDuration int specifies the duration of a gunflash effect. Applicable only for firearms.
smoke
  Gun smoke.
  - smoke bool if set to true, indicates that weapon emits gun smoke. Not applicable for crossbow and harpoon gun.
shell
  Gun shell.
  - shell bool if set to true, indicates that weapon emits gun shell. Applicable only for firearms.
muzzleFlash
  Display muzzle flash.
  - muzzleFlash bool specifies whether muzzle flash should be displayed or not. Applicable only for firearms.
colorizeMuzzleFlash
  Colorize muzzle flash.
  - colorizeMuzzleFlash bool specifies whether muzzle flash should be tinted with the same color as gunflash color. Applicable only for firearms.

## System

Global system settings that is not directly related to gameplay.

errorMode
  How should the application respond to script errors?
  - errorMode ErrorMode error mode to use. */
fastReload
  Can the game utilize the fast reload feature?
  When set to `true`, the game will attempt to perform fast savegame reloading if current level is the same as the level loaded from the savegame. It will not work if the level timestamp or checksum has changed (i.e. level was updated). If set to `false`, this functionality is turned off.
  - fastReload bool toggle fast reload on or off.

generated by TEN-LDoc (a fork of LDoc 1.4.6)