Scripting API

Scripting API

WindowsDetails

Record in Abyss.Core, from Abyss.Core.

What a built game's Windows executable says of itself — in Explorer's Details tab and its Properties — as its version information holds it.

public record WindowsDetails

Constructors

WindowsDetails

public WindowsDetails(string Company, string Product, string Description, string Copyright, string Version, IReadOnlyList<int> FileVersion, string FileName)

What a built game's Windows executable says of itself — in Explorer's Details tab and its Properties — as its version information holds it.

Parameters

  • Company: Who makes it: CompanyName.
  • Product: What it is called: ProductName.
  • Description: What it is: FileDescription, which Explorer shows first.
  • Copyright: LegalCopyright.
  • Version: Its version as written, 0.1.0: ProductVersion.
  • FileVersion: Its version as Windows' four numbers: FileVersion, and the numbers Windows compares.
  • FileName: What the executable is called, Orbit.exe: OriginalFilename.

Properties

Company

public string Company { get; init; }

Who makes it: CompanyName.

Product

public string Product { get; init; }

What it is called: ProductName.

Description

public string Description { get; init; }

What it is: FileDescription, which Explorer shows first.

public string Copyright { get; init; }

LegalCopyright.

Version

public string Version { get; init; }

Its version as written, 0.1.0: ProductVersion.

FileVersion

public IReadOnlyList<int> FileVersion { get; init; }

Its version as Windows' four numbers: FileVersion, and the numbers Windows compares.

FileName

public string FileName { get; init; }

What the executable is called, Orbit.exe: OriginalFilename.

Methods

Of

public static WindowsDetails Of(PlayerSettings player, string name, int year)

The details a game's Player gives its executable.

Parameters

  • player: The game's Player.
  • name: What the executable is called, without its extension.
  • year: The year its copyright says, where Player leaves that to the build.