Class ForgeMinecraft

Hierarchy

ForgeExtension
- ForgeMinecraft

Index

Constructors

Properties

commands description name options requireExtensions? server? targetVersions? version

Methods

getBedrockStatus getCommandManager getJavaStatus init load validateAndInit

Constructors

constructor

new ForgeMinecraft(options?: IForgeMinecraftOptions): ForgeMinecraft
Parameters
- options: IForgeMinecraftOptions = {}
Returns ForgeMinecraft
Overrides ForgeExtension.constructor
- Defined in src/index.ts:109

Properties

commands

commands: MinecraftCommandManager

description

description: string = description

name

name: string = "forge.minecraft"

`Readonly`options

options: IForgeMinecraftOptions = {}

`Optional`requireExtensions

requireExtensions?: string[]

A list of extension names this extension requires

`Optional`server

server?: MinecraftServer

`Optional`targetVersions

targetVersions?: string[]

Only the versions written here will be allowed

version

version: string = version

Methods

getBedrockStatus

getBedrockStatus(
host?: string | null,
port?: number,
): Promise<BedrockStatusResponse | null>
Gets the status response of a Bedrock Minecraft server. Uses the bedrock client options if no parameters are provided.
Parameters
- Optionalhost: string | null
  The host domain of the server.
- Optionalport: number
  The port for the host domain.
Returns Promise<BedrockStatusResponse | null>
- Defined in src/index.ts:129

getCommandManager

getCommandManager(): any
Returns any
Inherited from ForgeExtension.getCommandManager
- Defined in node_modules/@tryforge/forgescript/dist/structures/forge/ForgeExtension.d.ts:19

getJavaStatus

getJavaStatus(
host?: string | null,
port?: number,
): Promise<JavaStatusResponse | null>
Gets the status response of a Java Minecraft server. Uses the java client options if no parameters are provided.
Parameters
- Optionalhost: string | null
  The host domain of the server.
- Optionalport: number
  The port for the host domain.
Returns Promise<JavaStatusResponse | null>
- Defined in src/index.ts:119

init

init(client: ForgeClient): Promise<void>
Parameters
- client: ForgeClient
Returns Promise<void>
Overrides ForgeExtension.init
- Defined in src/index.ts:133

`Protected`load

load(path: string): void
Parameters
- path: string
Returns void
Inherited from ForgeExtension.load
- Defined in node_modules/@tryforge/forgescript/dist/structures/forge/ForgeExtension.d.ts:18

`Protected`validateAndInit

validateAndInit(client: ForgeClient): void
Parameters
- client: ForgeClient
Returns void
Inherited from ForgeExtension.validateAndInit
- Defined in node_modules/@tryforge/forgescript/dist/structures/forge/ForgeExtension.d.ts:17