diff --git a/src/bricklib/command.ts b/src/bricklib/command.ts index 5ab451d..10db4e9 100644 --- a/src/bricklib/command.ts +++ b/src/bricklib/command.ts @@ -1,3 +1,7 @@ +/** + * A custom command registry manager. + */ + import { Player, world } from '@minecraft/server'; diff --git a/src/bricklib/config.ts b/src/bricklib/config.ts index 1b3ad62..f084bfc 100644 --- a/src/bricklib/config.ts +++ b/src/bricklib/config.ts @@ -1,3 +1,7 @@ +/** + * Bricklib configuration. + */ + export default { /** @@ -14,4 +18,5 @@ export default { * Number of Minecraft commands to execute from the command queue, each tick. */ commandBuffer: 128, -}; + +} as const; diff --git a/src/bricklib/database.ts b/src/bricklib/database.ts index 003e658..a0286ba 100644 --- a/src/bricklib/database.ts +++ b/src/bricklib/database.ts @@ -1,3 +1,7 @@ +/** + * Persistent storage for Minecraft. + */ + import { Entity, ItemStack, Player, world } from '@minecraft/server'; import * as utils from './utils.js'; @@ -15,7 +19,7 @@ export const DEFAULT_ID = 'default'; /** * The max size of a database. */ -export const MAX_SIZE = 32768; +export const MAX_SIZE = 32767; /** * Defines a dynamic property source. diff --git a/src/bricklib/events.ts b/src/bricklib/events.ts index 3a141ef..da7492c 100644 --- a/src/bricklib/events.ts +++ b/src/bricklib/events.ts @@ -1,3 +1,6 @@ +/** + * An event manager. + */ /** * An event listener callback function. diff --git a/src/bricklib/forms.ts b/src/bricklib/forms.ts index a8734d2..a73566a 100644 --- a/src/bricklib/forms.ts +++ b/src/bricklib/forms.ts @@ -1,5 +1,5 @@ /** - * server forms + * Server forms UI wrapper. */ import { Player } from '@minecraft/server'; diff --git a/src/bricklib/index.ts b/src/bricklib/index.ts index 72505bb..721385f 100644 --- a/src/bricklib/index.ts +++ b/src/bricklib/index.ts @@ -1,3 +1,8 @@ +/** + * Bricklib -- A wrapper library built on top of Minecraft: + * Bedrock Edition's scripting API. + */ + import { system } from '@minecraft/server'; /** diff --git a/src/bricklib/locale.ts b/src/bricklib/locale.ts index 1585038..53ee298 100644 --- a/src/bricklib/locale.ts +++ b/src/bricklib/locale.ts @@ -1,3 +1,7 @@ +/** + * Localisation helpers. + */ + import * as utils from './utils.js'; diff --git a/src/bricklib/rawtext.ts b/src/bricklib/rawtext.ts index 8500fff..2771ee3 100644 --- a/src/bricklib/rawtext.ts +++ b/src/bricklib/rawtext.ts @@ -1,3 +1,7 @@ +/** + * A RawText builder for Minecraft Bedrock. + */ + /** * @class * A Minecraft rawtext builder. diff --git a/src/bricklib/server.ts b/src/bricklib/server.ts index 1b7254b..5a49bac 100644 --- a/src/bricklib/server.ts +++ b/src/bricklib/server.ts @@ -1,3 +1,7 @@ +/** + * Server utilities. + */ + import { world, system, diff --git a/src/bricklib/thread.ts b/src/bricklib/thread.ts index 2de8ee4..e84ef8a 100644 --- a/src/bricklib/thread.ts +++ b/src/bricklib/thread.ts @@ -1,3 +1,7 @@ +/** + * Manage concurrent tasks. + */ + import { system } from '@minecraft/server'; import config from './config.js'; import * as utils from './utils.js'; diff --git a/src/bricklib/ticks.ts b/src/bricklib/ticks.ts index b7185a4..982b11a 100644 --- a/src/bricklib/ticks.ts +++ b/src/bricklib/ticks.ts @@ -1,3 +1,7 @@ +/** + * Tick timing utilities. + */ + import { system } from '@minecraft/server'; import * as utils from './utils.js'; diff --git a/src/bricklib/utils.ts b/src/bricklib/utils.ts index cfd6857..b196bd7 100644 --- a/src/bricklib/utils.ts +++ b/src/bricklib/utils.ts @@ -1,5 +1,5 @@ /** - * Utility functions + * General utility functions. */ /**