Class VersionUtil

constructor

• new VersionUtil(major: number, minor: number, patch?: number): VersionUtil

  Parameters

  • major: number

    Major version number (e.g., 1 in 1.0.0)

  • minor: number

    Minor version number (e.g., 0 in 1.0.0)

  • patch: number = 0

    Patch version number (e.g., 0 in 1.0.0). Optional.

  Returns VersionUtil

Readonlymajor

Readonlyminor

Readonlypatch

Staticinit

• init(): void

  Subscribes to player spawn events to check if a version update should be shown.

  Returns void

StaticregisterVersion

• registerVersion(major: number, minor: number, patch?: number): void

  Registers the current game version and stores it in world dynamic properties. Should be called once during Add-On startup.

  Parameters

  • major: number
  • minor: number
  • Optionalpatch: number

  Returns void

Staticparse

• parse(input: string): VersionUtil | null

  Parses a semantic version string, such as "1.2.3", into a VersionUtil instance. Returns null if the format is invalid.

  Parameters

  • input: string

  Returns VersionUtil | null

compareTo

• compareTo(other: VersionUtil): number

  Compares this version to another version.

  Parameters

  • other: VersionUtil

  Returns number

  A negative number if this is lower than the other, 0 if equal, positive if this is higher than other.

toString

• toString(): string

  Converts the version to a string in semantic version format.

  Returns string