diff --git a/.gitignore b/.gitignore index 3c37caf..58b39bf 100644 --- a/.gitignore +++ b/.gitignore @@ -116,3 +116,5 @@ run/ # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) !gradle-wrapper.jar + +docs/ diff --git a/docs/clientcommands.ts b/docs/clientcommands.ts deleted file mode 100644 index 1f31a08..0000000 --- a/docs/clientcommands.ts +++ /dev/null @@ -1,985 +0,0 @@ - -/** - * The player which the user has control over - */ -declare const player: ControllablePlayer; -/** - * The client-side world which the player is in - */ -declare const world: World; - -/** - * Runs a client-side command and returns the result. Can also be an entity selector. - * @param command The command or entity selector to run. - * @return The integer result of the command, or list of matching entities in the case of an entity selector. - */ -declare function $(command: string): number | Array; - -/** - * Prints a string to client-side chat - * @param x The string to print - */ -declare function print(x: string): void; - -/** - * Sends a message to the game chat, prefix with "/" to run a server-side command. - * @param msg The message to send - */ -declare function chat(msg: string): void; - -/** - * Allows the game to run a tick. Pauses script execution until the next tick - */ -declare function tick(): void; - -/** - * Returns true if you are logged in to a game, false otherwise. Many operations are invalid if you are not logged in. - */ -declare function isLoggedIn(): boolean; - -/** - * If a string, matches items by their name, with the "minecraft:" prefix removed if it exists. - * If an object, matches the item NBT. - * If a function, it should return true or false based on the input item NBT. - */ -type ItemPredicate = string | object | ((itemNbt: object) => boolean); - -/** - * Represents a generic entity - */ -declare class Entity { - /** - * Whether this is a valid reference to an entity. A reference may be invalid if you are not ingame, you are in a - * different dimension to the entity, or the entity has died or unloaded. All other operations on this entity will - * fail if it is invalid. - */ - readonly valid: boolean; - /** - * The type of the entity, as used in commands. If the prefix, would be "minecraft:", then that prefix is stripped - */ - readonly type: string; - /** - * The x-position of the entity - */ - readonly x: number; - /** - * The y-position of the entity - */ - readonly y: number; - /** - * The z-position of the entity - */ - readonly z: number; - /** - * The yaw of the entity in degrees. 0 degrees is to the south, increasing clockwise - */ - readonly yaw: number; - /** - * The pitch of the entity in degrees. 0 degrees is forwards, increasing downwards - */ - readonly pitch: number; - /** - * The x-velocity of the entity - */ - readonly motionX: number; - /** - * The y-velocity of the entity - */ - readonly motionY: number; - /** - * The z-velocity of the entity - */ - readonly motionZ: number; - /** - * The NBT of the entity - */ - readonly nbt: object; - - /** - * Returns whether this entity is the same entity as the other entity - * @param other The other entity - */ - equals(other: Entity): boolean; -} - -/** - * A living entity, e.g. mobs, players - */ -declare class LivingEntity extends Entity { - /** - * The eye height of the entity in its current pose - */ - readonly eyeHeight: number; - /** - * The eye height of the entity in its standing pose - */ - readonly standingEyeHeight: number; -} - -/** - * A player - */ -declare class Player extends LivingEntity { - -} - -/** - * A player which the user has control over - */ -declare class ControllablePlayer extends Player { - - /** - * Teleports the player a limited distance. This function cannot teleport the player more than 0.5 blocks, - * and is meant for alignment rather than movement. Use properties like {@link pressingForward} and - * {@link sprinting} for movement. Returns whether successful (the player was close enough to the - * given position). - * @param x The x-position to snap the player to - * @param y The y-position to snap the player to - * @param z The z-position to snap the player to - * @param sync Whether to sync the position with the server immediately after the teleport, rather than - * at the start of the next tick. If absent, defaults to false - */ - snapTo(x: number, y: number, z: number, sync?: boolean): boolean; - - /** - * Moves the player in a straight line to the specified target position. Blocks until it reaches there. - * Returns whether successful - * @param x The x-position of the target - * @param z The z-position of the target - * @param smart Default true, whether to jump up single block gaps - */ - moveTo(x: number, z: number, smart?: boolean): boolean; - - /** - * Pathfinds the player to the specified target position. Blocks until it reaches there. - * Returns whether successful - * @param x The x-position of the target - * @param y The y-position of the target - * @param z The z-position of the target - * @param hints The pathfinding hints - */ - pathTo(x: number, y: number, z: number, hints?: PathfindingHints): boolean; - /** - * Pathfinds the player to the specified moving target entity. Blocks until it reaches there. - * Returns whether successful - * @param target The entity to follow - * @param hints The pathfinding hints - */ - pathTo(target: Entity, hints?: PathfindingHints): boolean; - /** - * Pathfinds the player to the specified moving target. The input function will be called periodically - * to update the target position. Returns whether successful - * @param movingTarget The moving target to follow - * @param hints The pathfinding hints - */ - pathTo(movingTarget: () => Position, hints?: PathfindingHints): boolean; - - /** - * The yaw of the player in degrees. 0 degrees is to the south, increasing clockwise - */ - yaw: number; - /** - * The pitch of the player in degrees. 0 degrees is forwards, increasing downwards - */ - pitch: number; - - /** - * Causes the player to look towards a point in space. - * @param x The x-position of the point to look at - * @param y The y-position of the point to look at - * @param z The z-position of the point to look at - */ - lookAt(x: number, y: number, z: number): void; - /** - * Causes the player to look towards an entity. If target is a {@link LivingEntity}, then - * the player will look at the eye height of that entity. Otherwise, it will look at the bottom - * of the entity. - * @param target The entity to look at - */ - lookAt(target: Entity): void; - - /** - * Forces a synchronization of the player's look angles with the server. By default, the player's - * new rotation is only sent to the server at the start of the next tick, meaning that if you - * perform certain actions that depend on the player's rotation, such as dropping an item, it will - * happen as if the player was still facing in the previous direction. Calling this function will - * immediately send the player's rotation to the server, so that further actions (like dropping an - * item) will be performed with the correct rotation. - */ - syncRotation(): void; - - /** - * The currently selected hotbar slot - */ - selectedSlot: number; - /** - * The player's inventory. Slot numbers are as follows: - * - * - * - * - * - * - * - * - *
NumberSlot
0-8Hotbar
9-35The rest of the main inventory
36-39Armor (head, torso, legs, feet)
40Offhand
41Crafting result slot
42-45Crafting grid
- * Slots beyond the hotbar and main inventory will be inaccessible while the player is looking into - * a container. - */ - readonly inventory: Inventory; - /** - * The inventory of the container the player is looking in, or null if the player isn't looking - * in any container - */ - readonly currentContainer: Inventory | null; - - /** - * Opens a container by right clicking the block at the given block position, and wait for a container - * of type expectedContainerType to be opened. - * @param x The x-position of the container block - * @param y The y-position of the container block - * @param z The z-position of the container block - * @param expectedContainerType The container type to expect, or a function that returns true/false - * depending on whether a container type should be accepted - * @return Whether successful - */ - openContainer(x: number, y: number, z: number, expectedContainerType: string | ((containerType: string) => boolean)): boolean; - - /** - * Opens a container by right clicking the given entity, and wait for a container of type - * expectedContainerType to be opened. - * @param entity The entity to click on - * @param expectedContainerType The container type to expect, or a function that returns true/false - * depending on whether a container type should be accepted - * @return Whether successful - */ - openContainer(entity: Entity, expectedContainerType: string | ((containerType: string) => boolean)): boolean; - - /** - * Closes the currently opened container, if any is open. Due to a threading issue in 1.16, this method delays - * the script by 1 tick, if a container was open. - */ - closeContainer(): void; - - /** - * If the player currently has a crafting container open, crafts as many times as possible up to the given - * number of times. Places items matching the given parameters into the given pattern, waits for a result matching - * result to appear, and pulls it out of the crafting grid. - * @param result The expected result of the recipe - * @param craftCount The number of crafts - * @param pattern An array of rows of the pattern. Each character corresponds to an item, use spaces for blank slots - * @param ingredients Associates characters with items - * @return The number of crafts managed - */ - craft(result: ItemPredicate, - craftCount: number, - pattern: Array, - ingredients: {[keys: string]: ItemPredicate}): number; - - /** - * "picks" an item from the player's inventory, and selects it in the hotbar, in a similar fashion to the - * vanilla pick block feature. - * @param item The item to pick - * @return Whether a matching item could be found in the inventory - */ - pick(item: ItemPredicate): boolean; - - /** - * Right clicks the currently held item in air - * - * Warning: right-clicking some items is a continuous action. This function on its own - * will not work for this! For an easy way to eat food, see {@link longUseItem} - * @return Whether the item use was considered successful - */ - rightClick(): boolean; - /** - * Right clicks a block. Will click on the closest part of the block at the given position. - * This function also modifies the player rotation to look at where they clicked, if they are - * not already hovering over the block. - * @param x The x-position of the block to right click - * @param y The y-position of the block to right click - * @param z The z-position of the block to right click - * @param side The side of the block to click on. If not specified, will click on the closest side. - * @return Whether the right click was successful - */ - rightClick(x: number, y: number, z: number, side?: string): boolean; - /** - * Right clicks an entity. This function also modifies the player rotation to look at the entity they - * clicked on. - * @param entity The entity to right click - * @return Whether the right click was successful - */ - rightClick(entity: Entity): boolean; - - /** - * Left clicks on a block. Will click on the closest part of the block at the given position. - * This function also modifies the player rotation to look at where they clicked, if they are - * not already hovering over the block. - * - * Warning: left-clicking many blocks is a continuous mining action. This function on its own - * will not work for this! For an easy way to mine blocks, see {@link longMineBlock} - * @param x The x-position of the block to right click - * @param y The y-position of the block to right click - * @param z The z-position of the block to right click - * @param side The side of the block to click on. If not specified, will click on the closest side. - * @return Whether the left click was successful - */ - leftClick(x: number, y: number, z: number, side?: string): boolean; - /** - * Left clicks on an entity (i.e. usually attacking it). This function also modifies the player rotation to - * look at the entity they clicked on. - * @param entity The entity to left click - * @return Whether the left click was successful - */ - leftClick(entity: Entity): boolean; - - /** - * Blocks user input until either this script terminates or {@link unblockInput} is called (and so long as - * no other scripts are also blocking input). - */ - blockInput(): void; - - /** - * Stops this script blocking user input - */ - unblockInput(): void; - - /** - * Holds down right click until the item can be used no more! For food, this has the effect of eating a single - * food item. Pauses execution of the script until the action is finished. Also blocks input for the duration - * of item use. - */ - longUseItem(): boolean; - - /** - * Mines a block with the currently held item until it is broken. Pauses execution of the script until the - * action is finished. Also blocks input for the duration of the block breaking. - * @param x The x-position of the block to mine - * @param y The y-position of the block to mine - * @param z The z-position of the block to mine - */ - longMineBlock(x: number, y: number, z: number): boolean; - - /** - * Whether the script is pressing forward for the player. This shouldn't be used to get whether forward is - * being pressed, it will produce inconsistent results. It should be used to set whether forward - * is pressed by the current script. - */ - pressingForward: boolean; - /** - * Whether the script is pressing back for the player. This shouldn't be used to get whether back is - * being pressed, it will produce inconsistent results. It should be used to set whether back - * is pressed by the current script. - */ - pressingBack: boolean; - /** - * Whether the script is pressing left for the player. This shouldn't be used to get whether left is - * being pressed, it will produce inconsistent results. It should be used to set whether left - * is pressed by the current script. - */ - pressingLeft: boolean; - /** - * Whether the script is pressing right for the player. This shouldn't be used to get whether right is - * being pressed, it will produce inconsistent results. It should be used to set whether right - * is pressed by the current script. - */ - pressingRight: boolean; - /** - * Whether the script is pressing the jump key for the player. This shouldn't be used to get whether jump is - * being pressed, it will produce inconsistent results. It should be used to set whether jump - * is pressed by the current script. - */ - jumping: boolean; - /** - * Whether the script is pressing the sneak key for the player. This shouldn't be used to get whether sneak is - * being pressed, it will produce inconsistent results. It should be used to set whether sneak - * is pressed by the current script. - */ - sneaking: boolean; - /** - * Whether the script is pressing the sprint key for the player. This shouldn't be used to get whether sprint is - * being pressed, it will produce inconsistent results. It should be used to set whether sprint - * is pressed by the current script. - */ - sprinting: boolean; - - /** - * Attempts to disconnect from the server. Terminates the script if successful. - */ - disconnect(): void; - - /** - * Disconnects and reconnects the player to the server. Returns whether successful. This function may return before - * the player has fully logged in again; check {@link isLoggedIn()} in a loop to wait for the player to be logged - * in. If the relog failed, depending on how it failed, the script may terminate after the next tick. The script - * will continue running if successful. - */ - relog(): boolean; -} - -/** - * The options for an inventory click - */ -interface InventoryClickOptions { - /** - * The click type, one of: - * - * - * - * - * - * - * - * - * - *
ValueDescription
"pickup"Swaps the item held by the cursor with the item in the given slot. This is the default click type.
"quick_move""Shift-clicks" on the given slot, which is commonly a quick way of moving items into and out of a container
"swap"Swaps the given slot with a hotbar slot, specified by also setting the {@link hotbarSlot} property on this object
"clone"(Creative-mode-only) clones the item in the given slot, equivalent to a middle-click on it
"throw"Throws the item in the given slot out of the inventory
"quick_craft"Performs a quick-craft. Must be performed in multiple stages, specified by also setting the {@link quickCraftStage} property in this object
"pickup_all"Picks up all items of the type in the slot
- */ - type?: string; - /** - * Whether to simulate a right click rather than a left click (which is the default). - * When {@link type} is "throw", then setting this to true throws all items rather than just one. - */ - rightClick?: boolean; - /** - * When {@link type} is "swap", specifies the hotbar slot to swap with - */ - hotbarSlot?: number; - /** - * When {@link type} is "quick_craft", specifies the quick craft stage (0-3) - */ - quickCraftStage?: number; -} - -/** - * Represents an inventory/container of items - */ -declare class Inventory { - /** - * The type of inventory. Returns either "player", "creative", "horse" or the container ID. - * Note that the container ID may be more generic than you might expect, e.g. "generic_9x3" - * for different types of chests. - */ - readonly type: string; - /** - * The items in the inventory. This is an array of item stack NBT objects. - */ - readonly items: Array; - - /** - * Simulates a click in an inventory slot. This function covers most inventory actions. - * @param slot The slot ID to click on. If null, this represents clicking outside - * the window (usually with the effect of dropping the stack under the cursor). - * @param options The options of the inventory action. See {@link InventoryClickOptions}. - */ - click(slot: number | null, options?: InventoryClickOptions): void; - - /** - * Finds the first slot in the container with an item that matches the given item predicate - * @param item The item to search for - * @param reverse If true, returns the last matching slot rather than the first one - * @return The index of the first matching slot, or null if no such slot is found. - */ - findSlot(item: ItemPredicate, reverse?: boolean): number | null; - - /** - * Lists the slots in the container with an item that matches the given item predicate, up - * until the maximum number of items has been reached. - * @param item The item to search for - * @param count The maximum amount of this item to search for, or -1 for no maximum - * @param reverse If true, returns the last matching slots first rather than the first matching slot first - * @return An array of matching slot indices - */ - findSlots(item: ItemPredicate, count: number, reverse?: boolean): Array; - - /** - * Shift clicks all the matching items in this container, up until the maximum number of items has been reached. - * @param item The item to search for - * @param count The maximum amount of this item to shift lick, or -1 for no maximum - * @param reverse If true, shift clicks the items in reverse order of slot indices - * @return The actual number of items shift clicked, may be greater than or equal to count if there - * are sufficient items in this container, or equal to the number of matching items if there are - * insufficient items. - */ - moveItems(item: ItemPredicate, count: number, reverse?: boolean): number; - - /** - * Return whether this inventory is the same as another inventory - * @param other The other inventory - */ - equals(other: Inventory): boolean; -} - -/** - * The type of the global world variable, the client-side world. - */ -declare class World { - /** - * The dimension ID of the current dimension. In vanilla, this can either be "overworld", - * "the_nether" or "the_end"; with datapacks or in modded this may take other values. - */ - readonly dimension: string; - - /** - * Gets the name of the block at the given position in the client-side world. - * @param x The x-position of the block to query - * @param y The y-position of the block to query - * @param z The z-position of the block to query - * @return The block name, as used in commands. If there would be a "minecraft:" prefix, the prefix is removed. - */ - getBlock(x: number, y: number, z: number): string; - - /** - * Gets the block state property with the given name at the given position. - * Equivalent to getBlockState(x, y, z).getProperty(property) - * @param x The x-position of the block state to query - * @param y The y-position of the block state to query - * @param z The z-position of the block state to query - * @param property The property name to query. E.g. could be "power" for redstone dust, or "bed_part" for beds. - */ - getBlockProperty(x: number, y: number, z: number, property: string): boolean | number | string; - - /** - * Gets the block state at the given position. - * @param x The x-position of the block state to get - * @param y The y-position of the block state to get - * @param z The z-position of the block state to get - */ - getBlockState(x: number, y: number, z: number): BlockState; - - /** - * Gets the client-side block entity NBT at the given coordinates - * @param x The x-position of the block entity whose NBT to get - * @param y The y-position of the block entity whose NBT to get - * @param z The z-position of the block entity whose NBT to get - * @return The NBT object of the block entity, or null if there was no block entity - */ - getBlockEntityNbt(x: number, y: number, z: number): object | null; - - /** - * Gets the block light at the given position, 0-15 - * @param x The x-coordinate of the position to get the block light of - * @param y The y-coordinate of the position to get the block light of - * @param z The z-coordinate of the position to get the block light of - */ - getBlockLight(x: number, y: number, z: number): number; - - /** - * Gets the sky light at the given position, 0-15 - * @param x The x-coordinate of the position to get the sky light of - * @param y The y-coordinate of the position to get the sky light of - * @param z The z-coordinate of the position to get the sky light of - */ - getSkyLight(x: number, y: number, z: number): number; - - /** - * Finds the closest visible point on a block - * @param x The x-position of the block to find the closest visible point on - * @param y The y-position of the block to find the closest visible point on - * @param z The z-position of the block to find the closest visible point on - * @param side The side of the block to find the closest visible point on. If not specified, will use the closest side. - * @return Whether there was a visible point on the block within reach - */ - getClosestVisiblePoint(x: number, y: number, z: number, side?: string): Position | null; -} - -/** - * Defines a "thread", which is an action which can run "concurrently" with other threads. - * This is not concurrency in the sense you may be used to as a programmer. Only one thread - * can run at a time. When you start another thread, that thread gains control immediately, - * until either it stops or it calls the {@link tick} function, which allows other script - * threads to run their code, and the game to run a tick. Therefore, you do not have to - * worry about thread safety, as all operations are thread safe. - */ -declare class Thread { - /** - * The currently executing thread. If this thread is not a clientcommands thread or the main script thread, then - * this returns null. This is possible for example via JsMacros' JavaWrapper. - */ - static readonly current: Thread | null; - - /** - * Whether the thread is currently running. Note this does not necessarily mean this - * thread is the currently executing thread. To test that, use thread === Thread.current - */ - readonly running: boolean; - - /** - * Whether the thread has been paused by {@link pause}. To pause an unpause threads, use the methods - */ - readonly paused: boolean; - - /** - * Whether the thread is a daemon thread. If true, this thread will be killed when the parent thread - * stops; if false, this thread may outlive its parent - */ - readonly daemon: boolean; - - /** - * The thread which started this thread. If null, either this thread was not started by a script, or - * this thread is not a daemon and the parent thread has died - */ - readonly parent: Thread | null; - - /** - * An array view of running threads started by this thread - */ - readonly children: Array; - - /** - * Creates a thread which will execute the given function on it when run. Does not - * run automatically, remember to explicitly call the {@link run} function. - * @param action The function to be executed on this thread - * @param daemon Whether this thread will be killed when the thread which started it - * is terminated. Defaults to true. If false, the thread can outlive the thread which - * started it. - */ - constructor(action: () => void, daemon?: boolean); - - /** - * Starts the thread. Does nothing if the thread has already started. - */ - run(): void; - - /** - * Pauses the thread. The thread will not return from the {@link tick} function until it - * has been unpaused. If a thread pauses itself, it will continue execution until the next - * time it calls the {@link tick} function. - */ - pause(): void; - - /** - * Unpauses the thread - */ - unpause(): void; - - /** - * Kills the thread, which stops it running any more code. If a thread tries to kill itself, - * it will continue running until it calls the {@link tick} function, at which point it will - * be killed - */ - kill(): void; - - /** - * Blocks the currently executing thread until this thread has finished executing. An exception - * is thrown if a thread tries to wait for itself - */ - waitFor(): void; -} - -/** - * Contains information about a block state - */ -declare class BlockState { - - /** - * Returns the default block state of the given block - * @param block The block to get the default block state of - */ - static defaultState(block: string): BlockState; - - /** - * The block of this block state - */ - readonly block: string; - - /** - * A list of block state properties supported by this block, i.e. those that can be used - * in {@link World.getBlockProperty} - */ - readonly stateProperties: Array; - - /** - * Returns the value of the given property of the block state. - * If the property is a boolean or numeric property, then the value of the property - * is returned directly. Otherwise, a string representation of the value is returned. - * @param property The property to get - */ - getProperty(property: string): boolean | number | string; - - /** - * The light level emitted, 0-15 - */ - readonly luminance: number; - - /** - * The hardness of the block, proportional to how long it takes to mine. For example: - *
    - *
  • Tall grass: 0
    • - *
  • Dirt: 0.5
    • - *
  • Stone: 1.5
    • - *
  • Obsidian: 50
    • - *
  • Bedrock: -1
    • - *
- */ - readonly hardness: number; - - /** - * How resistant this block is to explosions. For example: - *
    - *
  • Stone: 6
    • - *
  • Obsidian: 1200
    • - *
  • Bedrock: 3600000
    • - *
- * Note: the wiki has these values 5 times larger than they should be - */ - readonly blastResistance: number; - - /** - * Whether this block responds to random ticks - */ - readonly randomTickable: boolean; - - /** - * A value between 0-1 indicating how slippery a block is. A value of 1 means no friction at all - * (as if an entity was moving sideways in air), a value of 0 will stop an entity instantly. Most - * blocks have a slipperiness of 0.6, while ice has a slipperiness of 0.98 - */ - readonly slipperiness: number; - - /** - * The loot table used to drop items after this block is mined - */ - readonly lootTable: string; - - /** - * The translation key used to get the name of this block - */ - readonly translationKey: string; - - /** - * The item corresponding to this block, or null if the block has no corresponding item - */ - readonly item: string | null; - - /** - * A unique ID of the material of the block, may change across Minecraft versions or when other mods - * add materials. It's safest to compare against the material ID of a block with a known material - */ - readonly materialId: number; - - /** - * The map color of this block, in packed 0xRRGGBB format - */ - readonly mapColor: number; - - /** - * How this block reacts to being pushed by a piston. - * - * - * - * - * - * - *
ValueExampleDescription
"normal"StonePiston will move the block
"destroy"TorchPiston will destroy the block (it will "pop off")
"block"ObsidianPiston cannot pull the block and block will prevent piston from pushing
"push_only"Glazed terracottaBlock can only be pushed, does not stick to slime
- */ - readonly pistonBehavior: string; - - /** - * Whether this block is flammable - */ - readonly flammable: boolean; - - /** - * Whether this block will drop without using the correct tool - */ - readonly canBreakByHand: boolean; - - /** - * Whether this block is a liquid - */ - readonly liquid: boolean; - - /** - * Whether this block blocks light TODO: investigate - */ - readonly blocksLight: boolean; - - /** - * Whether this block is replaced when placing a block, e.g. tall grass - */ - readonly replaceable: boolean; - - /** - * Whether this is a solid block TODO: investigate - */ - readonly solid: boolean; - - /** - * The burn chance, related to how quickly the block burns once it has caught fire - */ - readonly burnChance: number; - - /** - * The spread chance, related to how quickly a block catches fire in response to nearby fire - */ - readonly spreadChance: number; - - /** - * Whether this block will fall like sand when unsupported - */ - readonly fallable: boolean; - - /** - * The tags applying to this block - */ - readonly tags: Array; -} - -/** - * Represents an item stack, used to get certain properties of that stack. Note that translating - * to and from this representation is inefficient, so shouldn't be done unnecessarily frequently - */ -declare class ItemStack { - - /** - * Returns the ItemStack representation of the given item stack NBT - * @param stack The NBT representation of the item stack - */ - static of(stack: object): ItemStack; - - /** - * Creates an item stack of size 1 with the given item - * @param item The item to make a stack of - */ - static of(item: string): ItemStack; - - /** - * Returns the NBT representation of this item stack - */ - readonly stack: object; - - /** - * Gets the mining speed of this item stack against a given block state. This is a multiplier, - * where a value of 1 indicates the same speed as with a fist against a block which doesn't require - * a tool - * @param block The block or block state to test against - */ - getMiningSpeed(block: string | BlockState): number; - - /** - * Returns whether this item is effective against a block which requires a tool. Note this does not - * affect mining speed, only whether the block drops its items or not - * @param block The block or block state to test against - */ - isEffectiveOn(block: string | BlockState): boolean; - - /** - * The maximum stack size of this item. Usually 64, but may also be 1 or 16 in vanilla. - * A value of 1 indicates that this item is non-stackable - */ - readonly maxCount: number; - - /** - * The maximum amount of damage this item can take, if it is for example a tool - */ - readonly maxDamage: number; - - /** - * Whether this item is a food item - */ - readonly isFood: boolean; - - /** - * The amount of hunger this item restores, or 0 if this is not a food item - */ - readonly hungerRestored: number; - - /** - * The amount of saturation this item restores, or 0 if this is not a food item - */ - readonly saturationRestored: number; - - /** - * Whether this is a food item and is meat (used for whether wolves like it) - */ - readonly isMeat: boolean; - - /** - * Whether this is a food item and can be eaten even with full hunger (e.g. golden apple) - */ - readonly alwaysEdible: boolean; - - /** - * Whether this is a snack food item, which doesn't take as long to eat (e.g. berries) - */ - readonly isSnack: boolean; - - /** - * The tags applying to this item - */ - readonly tags: Array; -} - -/** - * Represents a 3D position - */ -interface Position { - x: number; - y: number; - z: number; -} - -/** - * Pathfinding hints - */ -interface PathfindingHints { - - /** - * A function that gets the path node type for the given coordinates. Returns null for vanilla behavior. - * A list of current path node types and their penalties as of 1.15 is as follows: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
NameDefault penalty
"blocked"-1
"open"0
"walkable"0
"trapdoor"0
"fence"-1
"lava"-1
"water"8
"water_border"8
"rail"0
"danger_fire"8
"damage_fire"16
"danger_cactus"8
"damage_cactus"-1
"danger_other"8
"damage_other"-1
"door_open"0
"door_wood_closed"-1
"door_iron_closed"-1
"breach"4
"leaves"-1
"sticky_honey"8
"cocoa"0
- */ - nodeTypeFunction?: (x: number, y: number, z: number) => string | null; - - /** - * A function that gets the pathfinding penalty for the given path node type. - *
    - *
  • Return 0 for no penalty.
    • - *
  • Return -1 for a completely impassable block.
    • - *
  • Return higher positive numbers for higher penalties.
    • - *
- * See {@link nodeTypeFunction} for a list of path node types and their default penalties - */ - penaltyFunction?: (type: string) => number | null; - - /** - * The maximum Euclidean distance to the target that the player can be at any one time. - * Defaults to twice the distance to the target. - */ - followRange?: number; - - /** - * The maximum distance from the target which is sufficient to reach. Defaults to 0 - */ - reachDistance?: number; - - /** - * The maximum length of a path at any one time. Defaults to twice the distance to the target. - */ - maxPathLength?: number; - -} diff --git a/docs/example_scripts/branch_mine.js b/examples_scripts/branch_mine.js similarity index 100% rename from docs/example_scripts/branch_mine.js rename to examples_scripts/branch_mine.js diff --git a/docs/example_scripts/build_platform.js b/examples_scripts/build_platform.js similarity index 100% rename from docs/example_scripts/build_platform.js rename to examples_scripts/build_platform.js diff --git a/typings/.gitignore b/typings/.gitignore new file mode 100644 index 0000000..c2658d7 --- /dev/null +++ b/typings/.gitignore @@ -0,0 +1 @@ +node_modules/ diff --git a/typings/README.md b/typings/README.md new file mode 100644 index 0000000..0e87cbf --- /dev/null +++ b/typings/README.md @@ -0,0 +1,2 @@ +# Clientcommands Scripting API +You should go [here](./modules/Clientcommands.html) diff --git a/typings/index.d.ts b/typings/index.d.ts new file mode 100644 index 0000000..6c00f7a --- /dev/null +++ b/typings/index.d.ts @@ -0,0 +1,990 @@ +// Type definitions for clientcommands-scripting +// Project: https://github.com/Earthcomputer/clientcommands-scripting +// Definitions by: Earthcomputer + +declare namespace Clientcommands { + /** + * The player which the user has control over + */ + const player: ControllablePlayer; + /** + * The client-side world which the player is in + */ + const world: World; + + /** + * Runs a client-side command and returns the result. Can also be an entity selector. + * @param command The command or entity selector to run. + * @return The integer result of the command, or list of matching entities in the case of an entity selector. + */ + function $(command: string): number | Array; + + /** + * Prints a string to client-side chat + * @param x The string to print + */ + function print(x: string): void; + + /** + * Sends a message to the game chat, prefix with "/" to run a server-side command. + * @param msg The message to send + */ + function chat(msg: string): void; + + /** + * Allows the game to run a tick. Pauses script execution until the next tick + */ + function tick(): void; + + /** + * Returns true if you are logged in to a game, false otherwise. Many operations are invalid if you are not logged in. + */ + function isLoggedIn(): boolean; + + /** + * If a string, matches items by their name, with the "minecraft:" prefix removed if it exists. + * If an object, matches the item NBT. + * If a function, it should return true or false based on the input item NBT. + */ + type ItemPredicate = string | object | ((itemNbt: object) => boolean); + + /** + * Represents a generic entity + */ + class Entity { + /** + * Whether this is a valid reference to an entity. A reference may be invalid if you are not ingame, you are in a + * different dimension to the entity, or the entity has died or unloaded. All other operations on this entity will + * fail if it is invalid. + */ + readonly valid: boolean; + /** + * The type of the entity, as used in commands. If the prefix, would be "minecraft:", then that prefix is stripped + */ + readonly type: string; + /** + * The x-position of the entity + */ + readonly x: number; + /** + * The y-position of the entity + */ + readonly y: number; + /** + * The z-position of the entity + */ + readonly z: number; + /** + * The yaw of the entity in degrees. 0 degrees is to the south, increasing clockwise + */ + readonly yaw: number; + /** + * The pitch of the entity in degrees. 0 degrees is forwards, increasing downwards + */ + readonly pitch: number; + /** + * The x-velocity of the entity + */ + readonly motionX: number; + /** + * The y-velocity of the entity + */ + readonly motionY: number; + /** + * The z-velocity of the entity + */ + readonly motionZ: number; + /** + * The NBT of the entity + */ + readonly nbt: object; + + /** + * Returns whether this entity is the same entity as the other entity + * @param other The other entity + */ + equals(other: Entity): boolean; + } + + /** + * A living entity, e.g. mobs, players + */ + class LivingEntity extends Entity { + /** + * The eye height of the entity in its current pose + */ + readonly eyeHeight: number; + /** + * The eye height of the entity in its standing pose + */ + readonly standingEyeHeight: number; + } + + /** + * A player + */ + class Player extends LivingEntity { + + } + + /** + * A player which the user has control over + */ + class ControllablePlayer extends Player { + + /** + * Teleports the player a limited distance. This function cannot teleport the player more than 0.5 blocks, + * and is meant for alignment rather than movement. Use properties like {@link pressingForward} and + * {@link sprinting} for movement. Returns whether successful (the player was close enough to the + * given position). + * @param x The x-position to snap the player to + * @param y The y-position to snap the player to + * @param z The z-position to snap the player to + * @param sync Whether to sync the position with the server immediately after the teleport, rather than + * at the start of the next tick. If absent, defaults to false + */ + snapTo(x: number, y: number, z: number, sync?: boolean): boolean; + + /** + * Moves the player in a straight line to the specified target position. Blocks until it reaches there. + * Returns whether successful + * @param x The x-position of the target + * @param z The z-position of the target + * @param smart Default true, whether to jump up single block gaps + */ + moveTo(x: number, z: number, smart?: boolean): boolean; + + /** + * Pathfinds the player to the specified target position. Blocks until it reaches there. + * Returns whether successful + * @param x The x-position of the target + * @param y The y-position of the target + * @param z The z-position of the target + * @param hints The pathfinding hints + */ + pathTo(x: number, y: number, z: number, hints?: PathfindingHints): boolean; + /** + * Pathfinds the player to the specified moving target entity. Blocks until it reaches there. + * Returns whether successful + * @param target The entity to follow + * @param hints The pathfinding hints + */ + pathTo(target: Entity, hints?: PathfindingHints): boolean; + /** + * Pathfinds the player to the specified moving target. The input function will be called periodically + * to update the target position. Returns whether successful + * @param movingTarget The moving target to follow + * @param hints The pathfinding hints + */ + pathTo(movingTarget: () => Position, hints?: PathfindingHints): boolean; + + /** + * The yaw of the player in degrees. 0 degrees is to the south, increasing clockwise + */ + yaw: number; + /** + * The pitch of the player in degrees. 0 degrees is forwards, increasing downwards + */ + pitch: number; + + /** + * Causes the player to look towards a point in space. + * @param x The x-position of the point to look at + * @param y The y-position of the point to look at + * @param z The z-position of the point to look at + */ + lookAt(x: number, y: number, z: number): void; + /** + * Causes the player to look towards an entity. If target is a {@link LivingEntity}, then + * the player will look at the eye height of that entity. Otherwise, it will look at the bottom + * of the entity. + * @param target The entity to look at + */ + lookAt(target: Entity): void; + + /** + * Forces a synchronization of the player's look angles with the server. By default, the player's + * new rotation is only sent to the server at the start of the next tick, meaning that if you + * perform certain actions that depend on the player's rotation, such as dropping an item, it will + * happen as if the player was still facing in the previous direction. Calling this function will + * immediately send the player's rotation to the server, so that further actions (like dropping an + * item) will be performed with the correct rotation. + */ + syncRotation(): void; + + /** + * The currently selected hotbar slot + */ + selectedSlot: number; + /** + * The player's inventory. Slot numbers are as follows: + * + * + * + * + * + * + * + * + *
NumberSlot
0-8Hotbar
9-35The rest of the main inventory
36-39Armor (head, torso, legs, feet)
40Offhand
41Crafting result slot
42-45Crafting grid
+ * Slots beyond the hotbar and main inventory will be inaccessible while the player is looking into + * a container. + */ + readonly inventory: Inventory; + /** + * The inventory of the container the player is looking in, or null if the player isn't looking + * in any container + */ + readonly currentContainer: Inventory | null; + + /** + * Opens a container by right clicking the block at the given block position, and wait for a container + * of type expectedContainerType to be opened. + * @param x The x-position of the container block + * @param y The y-position of the container block + * @param z The z-position of the container block + * @param expectedContainerType The container type to expect, or a function that returns true/false + * depending on whether a container type should be accepted + * @return Whether successful + */ + openContainer(x: number, y: number, z: number, expectedContainerType: string | ((containerType: string) => boolean)): boolean; + + /** + * Opens a container by right clicking the given entity, and wait for a container of type + * expectedContainerType to be opened. + * @param entity The entity to click on + * @param expectedContainerType The container type to expect, or a function that returns true/false + * depending on whether a container type should be accepted + * @return Whether successful + */ + openContainer(entity: Entity, expectedContainerType: string | ((containerType: string) => boolean)): boolean; + + /** + * Closes the currently opened container, if any is open. Due to a threading issue in 1.16, this method delays + * the script by 1 tick, if a container was open. + */ + closeContainer(): void; + + /** + * If the player currently has a crafting container open, crafts as many times as possible up to the given + * number of times. Places items matching the given parameters into the given pattern, waits for a result matching + * result to appear, and pulls it out of the crafting grid. + * @param result The expected result of the recipe + * @param craftCount The number of crafts + * @param pattern An array of rows of the pattern. Each character corresponds to an item, use spaces for blank slots + * @param ingredients Associates characters with items + * @return The number of crafts managed + */ + craft(result: ItemPredicate, + craftCount: number, + pattern: Array, + ingredients: {[keys: string]: ItemPredicate}): number; + + /** + * "picks" an item from the player's inventory, and selects it in the hotbar, in a similar fashion to the + * vanilla pick block feature. + * @param item The item to pick + * @return Whether a matching item could be found in the inventory + */ + pick(item: ItemPredicate): boolean; + + /** + * Right clicks the currently held item in air + * + * Warning: right-clicking some items is a continuous action. This function on its own + * will not work for this! For an easy way to eat food, see {@link longUseItem} + * @return Whether the item use was considered successful + */ + rightClick(): boolean; + /** + * Right clicks a block. Will click on the closest part of the block at the given position. + * This function also modifies the player rotation to look at where they clicked, if they are + * not already hovering over the block. + * @param x The x-position of the block to right click + * @param y The y-position of the block to right click + * @param z The z-position of the block to right click + * @param side The side of the block to click on. If not specified, will click on the closest side. + * @return Whether the right click was successful + */ + rightClick(x: number, y: number, z: number, side?: string): boolean; + /** + * Right clicks an entity. This function also modifies the player rotation to look at the entity they + * clicked on. + * @param entity The entity to right click + * @return Whether the right click was successful + */ + rightClick(entity: Entity): boolean; + + /** + * Left clicks on a block. Will click on the closest part of the block at the given position. + * This function also modifies the player rotation to look at where they clicked, if they are + * not already hovering over the block. + * + * Warning: left-clicking many blocks is a continuous mining action. This function on its own + * will not work for this! For an easy way to mine blocks, see {@link longMineBlock} + * @param x The x-position of the block to right click + * @param y The y-position of the block to right click + * @param z The z-position of the block to right click + * @param side The side of the block to click on. If not specified, will click on the closest side. + * @return Whether the left click was successful + */ + leftClick(x: number, y: number, z: number, side?: string): boolean; + /** + * Left clicks on an entity (i.e. usually attacking it). This function also modifies the player rotation to + * look at the entity they clicked on. + * @param entity The entity to left click + * @return Whether the left click was successful + */ + leftClick(entity: Entity): boolean; + + /** + * Blocks user input until either this script terminates or {@link unblockInput} is called (and so long as + * no other scripts are also blocking input). + */ + blockInput(): void; + + /** + * Stops this script blocking user input + */ + unblockInput(): void; + + /** + * Holds down right click until the item can be used no more! For food, this has the effect of eating a single + * food item. Pauses execution of the script until the action is finished. Also blocks input for the duration + * of item use. + */ + longUseItem(): boolean; + + /** + * Mines a block with the currently held item until it is broken. Pauses execution of the script until the + * action is finished. Also blocks input for the duration of the block breaking. + * @param x The x-position of the block to mine + * @param y The y-position of the block to mine + * @param z The z-position of the block to mine + */ + longMineBlock(x: number, y: number, z: number): boolean; + + /** + * Whether the script is pressing forward for the player. This shouldn't be used to get whether forward is + * being pressed, it will produce inconsistent results. It should be used to set whether forward + * is pressed by the current script. + */ + pressingForward: boolean; + /** + * Whether the script is pressing back for the player. This shouldn't be used to get whether back is + * being pressed, it will produce inconsistent results. It should be used to set whether back + * is pressed by the current script. + */ + pressingBack: boolean; + /** + * Whether the script is pressing left for the player. This shouldn't be used to get whether left is + * being pressed, it will produce inconsistent results. It should be used to set whether left + * is pressed by the current script. + */ + pressingLeft: boolean; + /** + * Whether the script is pressing right for the player. This shouldn't be used to get whether right is + * being pressed, it will produce inconsistent results. It should be used to set whether right + * is pressed by the current script. + */ + pressingRight: boolean; + /** + * Whether the script is pressing the jump key for the player. This shouldn't be used to get whether jump is + * being pressed, it will produce inconsistent results. It should be used to set whether jump + * is pressed by the current script. + */ + jumping: boolean; + /** + * Whether the script is pressing the sneak key for the player. This shouldn't be used to get whether sneak is + * being pressed, it will produce inconsistent results. It should be used to set whether sneak + * is pressed by the current script. + */ + sneaking: boolean; + /** + * Whether the script is pressing the sprint key for the player. This shouldn't be used to get whether sprint is + * being pressed, it will produce inconsistent results. It should be used to set whether sprint + * is pressed by the current script. + */ + sprinting: boolean; + + /** + * Attempts to disconnect from the server. Terminates the script if successful. + */ + disconnect(): void; + + /** + * Disconnects and reconnects the player to the server. Returns whether successful. This function may return before + * the player has fully logged in again; check {@link isLoggedIn()} in a loop to wait for the player to be logged + * in. If the relog failed, depending on how it failed, the script may terminate after the next tick. The script + * will continue running if successful. + */ + relog(): boolean; + } + + /** + * The options for an inventory click + */ + interface InventoryClickOptions { + /** + * The click type, one of: + * + * + * + * + * + * + * + * + * + *
ValueDescription
"pickup"Swaps the item held by the cursor with the item in the given slot. This is the default click type.
"quick_move""Shift-clicks" on the given slot, which is commonly a quick way of moving items into and out of a container
"swap"Swaps the given slot with a hotbar slot, specified by also setting the {@link hotbarSlot} property on this object
"clone"(Creative-mode-only) clones the item in the given slot, equivalent to a middle-click on it
"throw"Throws the item in the given slot out of the inventory
"quick_craft"Performs a quick-craft. Must be performed in multiple stages, specified by also setting the {@link quickCraftStage} property in this object
"pickup_all"Picks up all items of the type in the slot
+ */ + type?: string; + /** + * Whether to simulate a right click rather than a left click (which is the default). + * When {@link type} is "throw", then setting this to true throws all items rather than just one. + */ + rightClick?: boolean; + /** + * When {@link type} is "swap", specifies the hotbar slot to swap with + */ + hotbarSlot?: number; + /** + * When {@link type} is "quick_craft", specifies the quick craft stage (0-3) + */ + quickCraftStage?: number; + } + + /** + * Represents an inventory/container of items + */ + class Inventory { + /** + * The type of inventory. Returns either "player", "creative", "horse" or the container ID. + * Note that the container ID may be more generic than you might expect, e.g. "generic_9x3" + * for different types of chests. + */ + readonly type: string; + /** + * The items in the inventory. This is an array of item stack NBT objects. + */ + readonly items: Array; + + /** + * Simulates a click in an inventory slot. This function covers most inventory actions. + * @param slot The slot ID to click on. If null, this represents clicking outside + * the window (usually with the effect of dropping the stack under the cursor). + * @param options The options of the inventory action. See {@link InventoryClickOptions}. + */ + click(slot: number | null, options?: InventoryClickOptions): void; + + /** + * Finds the first slot in the container with an item that matches the given item predicate + * @param item The item to search for + * @param reverse If true, returns the last matching slot rather than the first one + * @return The index of the first matching slot, or null if no such slot is found. + */ + findSlot(item: ItemPredicate, reverse?: boolean): number | null; + + /** + * Lists the slots in the container with an item that matches the given item predicate, up + * until the maximum number of items has been reached. + * @param item The item to search for + * @param count The maximum amount of this item to search for, or -1 for no maximum + * @param reverse If true, returns the last matching slots first rather than the first matching slot first + * @return An array of matching slot indices + */ + findSlots(item: ItemPredicate, count: number, reverse?: boolean): Array; + + /** + * Shift clicks all the matching items in this container, up until the maximum number of items has been reached. + * @param item The item to search for + * @param count The maximum amount of this item to shift lick, or -1 for no maximum + * @param reverse If true, shift clicks the items in reverse order of slot indices + * @return The actual number of items shift clicked, may be greater than or equal to count if there + * are sufficient items in this container, or equal to the number of matching items if there are + * insufficient items. + */ + moveItems(item: ItemPredicate, count: number, reverse?: boolean): number; + + /** + * Return whether this inventory is the same as another inventory + * @param other The other inventory + */ + equals(other: Inventory): boolean; + } + + /** + * The type of the global world variable, the client-side world. + */ + class World { + /** + * The dimension ID of the current dimension. In vanilla, this can either be "overworld", + * "the_nether" or "the_end"; with datapacks or in modded this may take other values. + */ + readonly dimension: string; + + /** + * Gets the name of the block at the given position in the client-side world. + * @param x The x-position of the block to query + * @param y The y-position of the block to query + * @param z The z-position of the block to query + * @return The block name, as used in commands. If there would be a "minecraft:" prefix, the prefix is removed. + */ + getBlock(x: number, y: number, z: number): string; + + /** + * Gets the block state property with the given name at the given position. + * Equivalent to getBlockState(x, y, z).getProperty(property) + * @param x The x-position of the block state to query + * @param y The y-position of the block state to query + * @param z The z-position of the block state to query + * @param property The property name to query. E.g. could be "power" for redstone dust, or "bed_part" for beds. + */ + getBlockProperty(x: number, y: number, z: number, property: string): boolean | number | string; + + /** + * Gets the block state at the given position. + * @param x The x-position of the block state to get + * @param y The y-position of the block state to get + * @param z The z-position of the block state to get + */ + getBlockState(x: number, y: number, z: number): BlockState; + + /** + * Gets the client-side block entity NBT at the given coordinates + * @param x The x-position of the block entity whose NBT to get + * @param y The y-position of the block entity whose NBT to get + * @param z The z-position of the block entity whose NBT to get + * @return The NBT object of the block entity, or null if there was no block entity + */ + getBlockEntityNbt(x: number, y: number, z: number): object | null; + + /** + * Gets the block light at the given position, 0-15 + * @param x The x-coordinate of the position to get the block light of + * @param y The y-coordinate of the position to get the block light of + * @param z The z-coordinate of the position to get the block light of + */ + getBlockLight(x: number, y: number, z: number): number; + + /** + * Gets the sky light at the given position, 0-15 + * @param x The x-coordinate of the position to get the sky light of + * @param y The y-coordinate of the position to get the sky light of + * @param z The z-coordinate of the position to get the sky light of + */ + getSkyLight(x: number, y: number, z: number): number; + + /** + * Finds the closest visible point on a block + * @param x The x-position of the block to find the closest visible point on + * @param y The y-position of the block to find the closest visible point on + * @param z The z-position of the block to find the closest visible point on + * @param side The side of the block to find the closest visible point on. If not specified, will use the closest side. + * @return Whether there was a visible point on the block within reach + */ + getClosestVisiblePoint(x: number, y: number, z: number, side?: string): Position | null; + } + + /** + * Defines a "thread", which is an action which can run "concurrently" with other threads. + * This is not concurrency in the sense you may be used to as a programmer. Only one thread + * can run at a time. When you start another thread, that thread gains control immediately, + * until either it stops or it calls the {@link tick} function, which allows other script + * threads to run their code, and the game to run a tick. Therefore, you do not have to + * worry about thread safety, as all operations are thread safe. + */ + class Thread { + /** + * The currently executing thread. If this thread is not a clientcommands thread or the main script thread, then + * this returns null. This is possible for example via JsMacros' JavaWrapper. + */ + static readonly current: Thread | null; + + /** + * Whether the thread is currently running. Note this does not necessarily mean this + * thread is the currently executing thread. To test that, use thread === Thread.current + */ + readonly running: boolean; + + /** + * Whether the thread has been paused by {@link pause}. To pause an unpause threads, use the methods + */ + readonly paused: boolean; + + /** + * Whether the thread is a daemon thread. If true, this thread will be killed when the parent thread + * stops; if false, this thread may outlive its parent + */ + readonly daemon: boolean; + + /** + * The thread which started this thread. If null, either this thread was not started by a script, or + * this thread is not a daemon and the parent thread has died + */ + readonly parent: Thread | null; + + /** + * An array view of running threads started by this thread + */ + readonly children: Array; + + /** + * Creates a thread which will execute the given function on it when run. Does not + * run automatically, remember to explicitly call the {@link run} function. + * @param action The function to be executed on this thread + * @param daemon Whether this thread will be killed when the thread which started it + * is terminated. Defaults to true. If false, the thread can outlive the thread which + * started it. + */ + constructor(action: () => void, daemon?: boolean); + + /** + * Starts the thread. Does nothing if the thread has already started. + */ + run(): void; + + /** + * Pauses the thread. The thread will not return from the {@link tick} function until it + * has been unpaused. If a thread pauses itself, it will continue execution until the next + * time it calls the {@link tick} function. + */ + pause(): void; + + /** + * Unpauses the thread + */ + unpause(): void; + + /** + * Kills the thread, which stops it running any more code. If a thread tries to kill itself, + * it will continue running until it calls the {@link tick} function, at which point it will + * be killed + */ + kill(): void; + + /** + * Blocks the currently executing thread until this thread has finished executing. An exception + * is thrown if a thread tries to wait for itself + */ + waitFor(): void; + } + + /** + * Contains information about a block state + */ + class BlockState { + + /** + * Returns the default block state of the given block + * @param block The block to get the default block state of + */ + static defaultState(block: string): BlockState; + + /** + * The block of this block state + */ + readonly block: string; + + /** + * A list of block state properties supported by this block, i.e. those that can be used + * in {@link World.getBlockProperty} + */ + readonly stateProperties: Array; + + /** + * Returns the value of the given property of the block state. + * If the property is a boolean or numeric property, then the value of the property + * is returned directly. Otherwise, a string representation of the value is returned. + * @param property The property to get + */ + getProperty(property: string): boolean | number | string; + + /** + * The light level emitted, 0-15 + */ + readonly luminance: number; + + /** + * The hardness of the block, proportional to how long it takes to mine. For example: + *
    + *
  • Tall grass: 0
    • + *
  • Dirt: 0.5
    • + *
  • Stone: 1.5
    • + *
  • Obsidian: 50
    • + *
  • Bedrock: -1
    • + *
+ */ + readonly hardness: number; + + /** + * How resistant this block is to explosions. For example: + *
    + *
  • Stone: 6
    • + *
  • Obsidian: 1200
    • + *
  • Bedrock: 3600000
    • + *
+ * Note: the wiki has these values 5 times larger than they should be + */ + readonly blastResistance: number; + + /** + * Whether this block responds to random ticks + */ + readonly randomTickable: boolean; + + /** + * A value between 0-1 indicating how slippery a block is. A value of 1 means no friction at all + * (as if an entity was moving sideways in air), a value of 0 will stop an entity instantly. Most + * blocks have a slipperiness of 0.6, while ice has a slipperiness of 0.98 + */ + readonly slipperiness: number; + + /** + * The loot table used to drop items after this block is mined + */ + readonly lootTable: string; + + /** + * The translation key used to get the name of this block + */ + readonly translationKey: string; + + /** + * The item corresponding to this block, or null if the block has no corresponding item + */ + readonly item: string | null; + + /** + * A unique ID of the material of the block, may change across Minecraft versions or when other mods + * add materials. It's safest to compare against the material ID of a block with a known material + */ + readonly materialId: number; + + /** + * The map color of this block, in packed 0xRRGGBB format + */ + readonly mapColor: number; + + /** + * How this block reacts to being pushed by a piston. + * + * + * + * + * + * + *
ValueExampleDescription
"normal"StonePiston will move the block
"destroy"TorchPiston will destroy the block (it will "pop off")
"block"ObsidianPiston cannot pull the block and block will prevent piston from pushing
"push_only"Glazed terracottaBlock can only be pushed, does not stick to slime
+ */ + readonly pistonBehavior: string; + + /** + * Whether this block is flammable + */ + readonly flammable: boolean; + + /** + * Whether this block will drop without using the correct tool + */ + readonly canBreakByHand: boolean; + + /** + * Whether this block is a liquid + */ + readonly liquid: boolean; + + /** + * Whether this block blocks light TODO: investigate + */ + readonly blocksLight: boolean; + + /** + * Whether this block is replaced when placing a block, e.g. tall grass + */ + readonly replaceable: boolean; + + /** + * Whether this is a solid block TODO: investigate + */ + readonly solid: boolean; + + /** + * The burn chance, related to how quickly the block burns once it has caught fire + */ + readonly burnChance: number; + + /** + * The spread chance, related to how quickly a block catches fire in response to nearby fire + */ + readonly spreadChance: number; + + /** + * Whether this block will fall like sand when unsupported + */ + readonly fallable: boolean; + + /** + * The tags applying to this block + */ + readonly tags: Array; + } + + /** + * Represents an item stack, used to get certain properties of that stack. Note that translating + * to and from this representation is inefficient, so shouldn't be done unnecessarily frequently + */ + class ItemStack { + + /** + * Returns the ItemStack representation of the given item stack NBT + * @param stack The NBT representation of the item stack + */ + static of(stack: object): ItemStack; + + /** + * Creates an item stack of size 1 with the given item + * @param item The item to make a stack of + */ + static of(item: string): ItemStack; + + /** + * Returns the NBT representation of this item stack + */ + readonly stack: object; + + /** + * Gets the mining speed of this item stack against a given block state. This is a multiplier, + * where a value of 1 indicates the same speed as with a fist against a block which doesn't require + * a tool + * @param block The block or block state to test against + */ + getMiningSpeed(block: string | BlockState): number; + + /** + * Returns whether this item is effective against a block which requires a tool. Note this does not + * affect mining speed, only whether the block drops its items or not + * @param block The block or block state to test against + */ + isEffectiveOn(block: string | BlockState): boolean; + + /** + * The maximum stack size of this item. Usually 64, but may also be 1 or 16 in vanilla. + * A value of 1 indicates that this item is non-stackable + */ + readonly maxCount: number; + + /** + * The maximum amount of damage this item can take, if it is for example a tool + */ + readonly maxDamage: number; + + /** + * Whether this item is a food item + */ + readonly isFood: boolean; + + /** + * The amount of hunger this item restores, or 0 if this is not a food item + */ + readonly hungerRestored: number; + + /** + * The amount of saturation this item restores, or 0 if this is not a food item + */ + readonly saturationRestored: number; + + /** + * Whether this is a food item and is meat (used for whether wolves like it) + */ + readonly isMeat: boolean; + + /** + * Whether this is a food item and can be eaten even with full hunger (e.g. golden apple) + */ + readonly alwaysEdible: boolean; + + /** + * Whether this is a snack food item, which doesn't take as long to eat (e.g. berries) + */ + readonly isSnack: boolean; + + /** + * The tags applying to this item + */ + readonly tags: Array; + } + + /** + * Represents a 3D position + */ + interface Position { + x: number; + y: number; + z: number; + } + + /** + * Pathfinding hints + */ + interface PathfindingHints { + + /** + * A function that gets the path node type for the given coordinates. Returns null for vanilla behavior. + * A list of current path node types and their penalties as of 1.15 is as follows: + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
NameDefault penalty
"blocked"-1
"open"0
"walkable"0
"trapdoor"0
"fence"-1
"lava"-1
"water"8
"water_border"8
"rail"0
"danger_fire"8
"damage_fire"16
"danger_cactus"8
"damage_cactus"-1
"danger_other"8
"damage_other"-1
"door_open"0
"door_wood_closed"-1
"door_iron_closed"-1
"breach"4
"leaves"-1
"sticky_honey"8
"cocoa"0
+ */ + nodeTypeFunction?: (x: number, y: number, z: number) => string | null; + + /** + * A function that gets the pathfinding penalty for the given path node type. + *
    + *
  • Return 0 for no penalty.
    • + *
  • Return -1 for a completely impassable block.
    • + *
  • Return higher positive numbers for higher penalties.
    • + *
+ * See {@link nodeTypeFunction} for a list of path node types and their default penalties + */ + penaltyFunction?: (type: string) => number | null; + + /** + * The maximum Euclidean distance to the target that the player can be at any one time. + * Defaults to twice the distance to the target. + */ + followRange?: number; + + /** + * The maximum distance from the target which is sufficient to reach. Defaults to 0 + */ + reachDistance?: number; + + /** + * The maximum length of a path at any one time. Defaults to twice the distance to the target. + */ + maxPathLength?: number; + + } +} \ No newline at end of file diff --git a/typings/package-lock.json b/typings/package-lock.json new file mode 100644 index 0000000..086cbd2 --- /dev/null +++ b/typings/package-lock.json @@ -0,0 +1,386 @@ +{ + "name": "clientcommands-scripting", + "version": "1.0.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "clientcommands-scripting", + "version": "1.0.0", + "license": "MIT", + "devDependencies": { + "typedoc": "^0.22.5" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "node_modules/glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "node_modules/jsonc-parser": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", + "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", + "dev": true + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "node_modules/marked": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.7.tgz", + "integrity": "sha512-ctKqbnLuNbsHbI26cfMyOlKgXGfl1orOv1AvWWDX7AkgfMOwCWvmuYc+mVLeWhQ9W6hdWVBynOs96VkcscKo0Q==", + "dev": true, + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">= 12" + } + }, + "node_modules/minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "dependencies": { + "lru-cache": "^5.1.1" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/shiki": { + "version": "0.9.12", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.12.tgz", + "integrity": "sha512-VXcROdldv0/Qu0w2XvzU4IrvTeBNs/Kj/FCmtcEXGz7Tic/veQzliJj6tEiAgoKianhQstpYmbPDStHU5Opqcw==", + "dev": true, + "dependencies": { + "jsonc-parser": "^3.0.0", + "onigasm": "^2.2.5", + "vscode-textmate": "5.2.0" + } + }, + "node_modules/typedoc": { + "version": "0.22.5", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.5.tgz", + "integrity": "sha512-KFrWGU1iKiTGw0RcyjLNYDmhd7uICU14HgBNPmFKY/sT4Pm/fraaLyWyisst9vGTUAKxqibqoDITR7+ZcAkhHg==", + "dev": true, + "dependencies": { + "glob": "^7.2.0", + "lunr": "^2.3.9", + "marked": "^3.0.4", + "minimatch": "^3.0.4", + "shiki": "^0.9.11" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 12.10.0" + }, + "peerDependencies": { + "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x" + } + }, + "node_modules/typescript": { + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", + "dev": true, + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", + "dev": true + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + } + }, + "dependencies": { + "balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "requires": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "jsonc-parser": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", + "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", + "dev": true + }, + "lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "requires": { + "yallist": "^3.0.2" + } + }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "marked": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.7.tgz", + "integrity": "sha512-ctKqbnLuNbsHbI26cfMyOlKgXGfl1orOv1AvWWDX7AkgfMOwCWvmuYc+mVLeWhQ9W6hdWVBynOs96VkcscKo0Q==", + "dev": true + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "requires": { + "wrappy": "1" + } + }, + "onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "requires": { + "lru-cache": "^5.1.1" + } + }, + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true + }, + "shiki": { + "version": "0.9.12", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.12.tgz", + "integrity": "sha512-VXcROdldv0/Qu0w2XvzU4IrvTeBNs/Kj/FCmtcEXGz7Tic/veQzliJj6tEiAgoKianhQstpYmbPDStHU5Opqcw==", + "dev": true, + "requires": { + "jsonc-parser": "^3.0.0", + "onigasm": "^2.2.5", + "vscode-textmate": "5.2.0" + } + }, + "typedoc": { + "version": "0.22.5", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.5.tgz", + "integrity": "sha512-KFrWGU1iKiTGw0RcyjLNYDmhd7uICU14HgBNPmFKY/sT4Pm/fraaLyWyisst9vGTUAKxqibqoDITR7+ZcAkhHg==", + "dev": true, + "requires": { + "glob": "^7.2.0", + "lunr": "^2.3.9", + "marked": "^3.0.4", + "minimatch": "^3.0.4", + "shiki": "^0.9.11" + } + }, + "typescript": { + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", + "dev": true, + "peer": true + }, + "vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", + "dev": true + }, + "wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + } + } +} diff --git a/typings/package.json b/typings/package.json new file mode 100644 index 0000000..8862d30 --- /dev/null +++ b/typings/package.json @@ -0,0 +1,25 @@ +{ + "name": "clientcommands-scripting", + "version": "1.0.0", + "description": "This repository is the scripting module of [clientcommands](https://github.com/Earthcomputer/clientcommands). This mod is distributed as part of clientcommands, so please refer to clientcommands' readme for installation instructions.", + "typings": "index.d.ts", + "directories": { + "doc": "docs" + }, + "scripts": { + "docs": "typedoc" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Earthcomputer/clientcommands-scripting.git" + }, + "author": "Earthcomputer", + "license": "MIT", + "bugs": { + "url": "https://github.com/Earthcomputer/clientcommands-scripting/issues" + }, + "homepage": "https://github.com/Earthcomputer/clientcommands-scripting#readme", + "devDependencies": { + "typedoc": "^0.22.5" + } +} diff --git a/typings/tsconfig.json b/typings/tsconfig.json new file mode 100644 index 0000000..f51526a --- /dev/null +++ b/typings/tsconfig.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "module": "None", + }, + "files": [ + "index.d.ts" + ], + "typedocOptions": { + "entryPoints": ["index.d.ts"], + "out": "../docs/" + } +}