typesforbukkit/global/packages.ts

Types For Bukkit

// PACKAGE DESCRIPTIONS

namespace org {

    /** @description The root package of the Bukkit API, contains generalized API classes */
    export namespace bukkit {

        /** @description Classes relevant to advancements */
        export namespace advancement {}

        /** @description Classes relevant to attributes */
        export namespace attribute {}

        /** @description Classes used to manipulate the voxels in a world, including special states */
        export namespace block {

            /** @description Classes relevant to banner blocks */
            export namespace banner {}

            /** @description Generalized BlockData classes */
            export namespace data {

                /** @description Specific BlockData classes relevant to only a given block or set of blocks */
                export namespace type {}
            }

            /** @description Classes relevant to structure blocks */
            export namespace structure {}

        }

        /** @description Classes concerning the creation of boss bars that appear at the top of the player's screen */
        export namespace boss {}

        /** @description Classes relating to handling specialized non-chat player input */
        export namespace command {
            /** @description Commands for emulating the Minecraft commands and other necessary ones for use by a Bukkit implementation */
            export namespace defaults {}

        }

        /** @description Classes dedicated to handling a plugin's runtime configuration */
        export namespace configuration {

            /** @description Classes dedicated to facilitating configurations to be read and stored on the filesystem */
            export namespace file {}

            /** @description Classes dedicated to being able to perform serialization specialized for the Bukkit configuration implementation */
            export namespace serialization {}

        }

        /** @description Classes dedicated to facilitate direct player-to-plugin communication */
        export namespace conversations {}

        /** @description Classes relating to the specialized enhancements to item stacks, as part of the meta data */
        export namespace enchantments {}

        /** @description Interfaces for non-voxel objects that can exist in a world, including all players, monsters, projectiles, etc */
        export namespace entity {

            /** @description Classes concerning an entity's persistent memory */
            export namespace memory {}

            /** @description Interfaces for various Minecart types */
            export namespace minecart {}

        }

        /** @description Classes dedicated to handling triggered code executions */
        export namespace event {

            /** @description Events relating to when a block is changed or interacts with the world */
            export namespace block {}

            /** @description Events triggered from an enchantment table */
            export namespace enchantments {}

            /** @description Events relating to entities, excluding some directly referencing some more specific entity types */
            export namespace entity {}

            /** @description Events relating to entities that hang */
            export namespace hanging {}

            /** @description Events relating to inventory manipulation */
            export namespace inventory {}

            /** @description Events relating to players */
            export namespace player {}

            /** @description Events related to raids */
            export namespace raid {}

            /** @description Events relating to programmatic state changes on the server */
            export namespace server {}

            /** @description Events relating to vehicular entities */
            export namespace vehicle {}

            /** @description Events relating to weather */
            export namespace weather {}

            /** @description Events triggered by various world states or changes */
            export namespace world {}
        }

        /** @description Classes to facilitate world generation implementation */
        export namespace generator {}

        /** @description Classes used to manipulate the default command and topic assistance system */
        export namespace help {}

        /** @description Classes involved in manipulating player inventories and item interactions */
        export namespace inventory {

            /** @description The interfaces used when manipulating extra data can can be stored inside item stacks */
            export namespace meta {

                /** @description Classes that allow attaching custom data to items */
                export namespace tags {}
            }
        }

        /** @description Classes relevant to loot table manipulation and generation */
        export namespace loot {}

        /** @description Classes to facilitate plugin handling of map displays */
        export namespace map {}

        /** @description Classes that represents various voxel types and states */
        export namespace material {

            /** @description Classes relevant to specific material types */
            export namespace types {}

        }

        /** @description Classes dedicated to providing a layer of plugin specified data on various Minecraft concepts */
        export namespace metadata {}

        /** @description Classes dedicated to providing binary state properties to players */
        export namespace permissions {}

        /** @description Classes that allow attaching persistent data to various objects */
        export namespace persistance {}

        /** @description Classes specifically relating to loading software modules at runtime */
        export namespace plugin {

            /** @description Classes for handling plugins written in java */
            export namespace java_ {}

            /** @description Classes dedicated to specialized plugin to client protocols */
            export namespace messaging {}

        }

        /** @description Classes to represent various potion properties and manipulation */
        export namespace potion {}

        /** @description Classes to represent the source of a projectile */
        export namespace projectiles {}

        /** @description Classes relevant to player profiles */
        export namespace profile {}
        
        /** @description Classes dedicated to letting plugins run code at specific time intervals, including thread safety */
        export namespace scheduler {}

        /** @description Interfaces used to manage the client side score display system */
        export namespace scoreboard {}

        /** @description Classes related to creating or using structures without creating Structure blocks in the world */
        export namespace structure {}
        
        /** @description Multi and single purpose classes to facilitate various programmatic concepts */
        export namespace util {

            /** @description Classes used to facilitate stream processing for specific Bukkit concepts */
            export namespace io {}

            /** @description Classes dedicated to facilitating deterministic noise */
            export namespace noise {}

            /** @description Static methods for miscellaneous permission functionality */
            export namespace permissions {}

        }
    }

    /** @description Spigot-specific classes */
    export namespace spigotmc {

        export namespace event {

            /** @description Spigot-specific entity events */
            export namespace entity {}

            /** @description Spigot-specific player events */
            export namespace player {}
            
        }
    }
}