Skip to main content

Boatdrag

Overview

The Boatdrag component is responsible for storing and managing physics-related properties for boat entities. These properties, including drag, velocity modifiers, and sail force multipliers, are used by the game's physics engine to calculate a boat's movement and handling on the water.

Dependencies & Tags

None identified.

Properties

PropertyTypeDefault ValueDescription
dragnumber0The base drag or resistance value of the boat against the water.
max_velocity_modnumber1A multiplier affecting the boat's maximum achievable velocity.
forcedampeningnumber0A value used to apply a dampening force, slowing the boat down.
sailforcemodifiernumber1A multiplier that affects the force generated by the boat's sail.

Main Functions

GetDebugString()

  • Description: Returns a formatted string containing the current values of the component's main physics properties. This is primarily used for debugging purposes.
  • Parameters: None.