Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FBPOptions

The fire behaviour prediction options.

author

"Travis Redpath"

Hierarchy

  • FBPOptions

Index

Properties

Methods

Properties

terrainEffect

terrainEffect: boolean | null = null

Use terrain effect (optional). Has a default value.

windEffect

windEffect: boolean | null = null

Use wind effect (optional).

Static Readonly DEFAULT_TERRAINEFF

DEFAULT_TERRAINEFF: "TERRAINEFFECT" = "TERRAINEFFECT"

Static Readonly DEFAULT_WINDEFFECT

DEFAULT_WINDEFFECT: "fgmd_windeffect" = "fgmd_windeffect"

Static Readonly PARAM_TERRAIN

PARAM_TERRAIN: "terraineffect" = "terraineffect"

Static Readonly PARAM_WINDEFF

PARAM_WINDEFF: "windeffect" = "windeffect"

Methods

checkValid

  • Find all errors that may be in the FBP options.

    Returns Array<ValidationError>

    A list of the errors that were found.

isValid

  • isValid(): boolean

  • Checks to see if all of the required values have been set.

    Returns boolean

stream

  • stream(builder: Socket): void

  • Streams the FBP options to a socket.

    Parameters

    • builder: Socket

    Returns void

streamCopy

  • streamCopy(builder: Socket): void

  • Streams the FBP options to a socket.

    Parameters

    • builder: Socket

    Returns void

tryParse

  • tryParse(type: string, data: string): boolean

  • Parameters

    • type: string
    • data: string

    Returns boolean