Skip to content

Game.Vehicles.WatercraftFlags

Assembly: Assembly-CSharp
Namespace: Game.Vehicles

Type: enum (with [Flags])

Base: System.Enum (underlying type: System.UInt32)

Summary:
Bitwise flag enum describing runtime states and behaviour hints for watercraft vehicles in the game. The [Flags] attribute indicates values are intended to be combined with bitwise operations. Each member represents a single flag (power-of-two) that can be checked, set, or cleared to control or query a watercraft's status (e.g., navigation restrictions, lighting, queueing, and working state).

Fields

  • StayOnWaterway = 1u
    Indicates the watercraft should remain on a waterway (avoid leaving the water route). (bit 0)

  • AnyLaneTarget = 2u
    Allows the vehicle to target any lane type (treats lane selection more permissively). (bit 1)

  • Queueing = 4u
    Marks the watercraft as currently queueing (waiting in a queue). (bit 2)

  • DeckLights = 8u
    Deck lights are enabled for the watercraft (visual/lighting flag). (bit 3)

  • LightsOff = 0x10u
    Lights are turned off for the vehicle (distinct from DeckLights). (bit 4)

  • Working = 0x20u
    The vehicle is actively performing work/service (e.g., servicing route tasks). (bit 5)

Properties

  • This enum has no properties.

Constructors

  • Enums do not have explicit constructors in source; no public constructors are defined for this type.

Methods

  • This enum defines no methods.

Usage Example

// Combine flags
WatercraftFlags flags = WatercraftFlags.StayOnWaterway | WatercraftFlags.Working;

// Check a flag
bool isQueueing = (flags & WatercraftFlags.Queueing) != 0;

// Set a flag
flags |= WatercraftFlags.DeckLights;

// Clear a flag
flags &= ~WatercraftFlags.DeckLights;

// Toggle a flag
flags ^= WatercraftFlags.LightsOff;

// Get raw underlying value
uint rawValue = (uint)flags;