Class ChangelogUtil`Abstract`

Index

Constructors

Methods

registerChangelogs openCurrentVersionChangelog openFullChangelog openVersionChangelog generateBodyRawtext generateBodySubRawtext forceShow

Constructors

constructor

new ChangelogUtil(): ChangelogUtil
Returns ChangelogUtil

Methods

`Static`registerChangelogs

registerChangelogs(data: Record<string, number>): void
Registers available changelog line counts for each version. This should be called once during initialization.
Parameters
- data: Record<string, number>
  A mapping of version strings to number of changelog lines.
Returns void
- Defined in src/utils/changelog_util.ts:18

`Static`openCurrentVersionChangelog

openCurrentVersionChangelog(player: Player, version: VersionUtil): void
Opens the changelog UI for the current version and optionally lets the user view the full changelog.
Parameters
- player: Player
  The player to show the changelog to.
- version: VersionUtil
  The current version object.
Returns void
- Defined in src/utils/changelog_util.ts:28

`Static`openFullChangelog

openFullChangelog(player: Player): void
Opens the full changelog menu, allowing the player to select from all available versions.
Parameters
- player: Player
  The player to show the full changelog UI to.
Returns void
- Defined in src/utils/changelog_util.ts:81

`Static`openVersionChangelog

openVersionChangelog(player: Player, version: string): void
Opens a detailed changelog UI for a specific version.
Parameters
- player: Player
  The player to show the version changelog to.
- version: string
  The version string to display.
Returns void
- Defined in src/utils/changelog_util.ts:109

`Static`generateBodyRawtext

generateBodyRawtext(version: string, lines: number): RawMessage
Generates a RawMessage containing all changelog lines for a given version.
Parameters
- version: string
  The version string.
- lines: number
  The number of lines to include.
Returns RawMessage
A RawMessage with translated changelog lines.
- Defined in src/utils/changelog_util.ts:140

`Static`generateBodySubRawtext

generateBodySubRawtext(version: string, lines: number): RawMessage
Generates the rawtext block used for changelog lines of a specific version.
Parameters
- version: string
  The version string.
- lines: number
  Number of lines to include.
Returns RawMessage
A RawMessage object containing all translated lines.
- Defined in src/utils/changelog_util.ts:151

`Static`forceShow

forceShow<T extends ActionFormData | ModalFormData>(
player: Player,
ui: T,
): Promise<Awaited<ReturnType<T["show"]>>>
Forces a form to be shown repeatedly until the player is not busy or interaction succeeds. Useful when other screens or UI interrupts normal behavior.
Type Parameters
- T extends ActionFormData | ModalFormData
Parameters
- player: Player
  The player to show the form to.
- ui: T
  The form to show (ActionFormData or ModalFormData).
Returns Promise<Awaited<ReturnType<T["show"]>>>
The response from the form, or a fallback canceled response.
- Defined in src/utils/changelog_util.ts:170