Skip to content

spool / PaperOps

Class: PaperOps

Defined in: plugins/native/index.ts:22

Typed catalogue of the companion Paper plugin's Brigadier commands. Each op is a thin, named wrapper over the core ctx.native(...) escape hatch: it pins the namespace:command id and forwards typed values, so authors call ctx.paper().pathfind(target, to) instead of stringly ctx.native("paper:..."). Every op returns the NativeCall builder, so a .fallback(...) can be attached for the vanilla/singleplayer build.

This catalogue lives in spool, not core: the Paper command names/signatures are an opinion about a specific server plugin, which the un-opinionated compiler core must not carry. Extend it by adding methods here as the plugin grows.

Constructors

Constructor

new PaperOps(ctx): PaperOps

Defined in: plugins/native/index.ts:23

Parameters

ctx

FunctionContext

Returns

PaperOps

Methods

call()

call(...args): NativeCall

Defined in: plugins/native/index.ts:29

Escape hatch for any command the plugin exposes that doesn't have a named wrapper yet - same contract as ctx.native, just reached through .paper().

Parameters

args

...[string | IdValue, ...args: ArgInput[]]

Returns

NativeCall


pathfind()

pathfind(target, to): NativeCall

Defined in: plugins/native/index.ts:38

Move target to to using the server's native pathfinder (a per-tick A* sweep that is impractical as command expansion). Server-only unless you add a .fallback(...).

Parameters

target

Selector

to

PosValue

Returns

NativeCall

Released under the MIT License · Credits