Skip to content

Game.Tools.SnapLineFlags

Assembly: Assembly-CSharp
Namespace: Game.Tools

Type: public enum SnapLineFlags

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

Summary:
Represents bitwise flags used to describe characteristics of snap lines in the game's tool system (e.g., whether a snap line is a guide, hidden, part of an extended curve, or a secondary line). The enum members use power-of-two values and therefore can be combined with bitwise operations. Note: the enum in source is not decorated with [System.Flags], but its values are suitable for flag combinations.

Fields

  • ExtendedCurve = 1
    Flag indicating the snap line is part of an extended curve.

  • Hidden = 2
    Flag indicating the snap line should be hidden (not rendered or considered in some operations).

  • GuideLine = 4
    Flag indicating the snap line is a guide line (used for alignment/visual guidance).

  • Secondary = 8
    Flag indicating the snap line is a secondary line (e.g., less important or auxiliary).

Properties

  • None.
    This enum does not expose properties.

Constructors

  • None.
    Enums do not define constructors in user code.

Methods

  • None.
    This enum does not define methods.

Usage Example

// Combine flags
SnapLineFlags flags = SnapLineFlags.ExtendedCurve | SnapLineFlags.GuideLine;

// Check for a flag
bool isHidden = (flags & SnapLineFlags.Hidden) != 0;

// Add a flag
flags |= SnapLineFlags.Secondary;

// Remove a flag
flags &= ~SnapLineFlags.ExtendedCurve;

Additional notes: - Although the enum isn't declared with [System.Flags], treating it as a flags enum (using bitwise operations) is appropriate given the assigned values. - When exposing these values in a UI (e.g., inspector or debug display), consider presenting combined flags in a human-readable form.