Your cart is empty
Looks like the spiders padded through here. Pick a plugin and it will show up here. Continue shoppingPhoenix Crates API Documentation
This page provides an overview of all public classes, interfaces, enums, and annotations in this project.
Packages
| Package | Contents |
|---|---|
| com.phoenixplugins.phoenixcrates.api | 1 interface, 2 class |
| com.phoenixplugins.phoenixcrates.api.crate | 4 interface |
| com.phoenixplugins.phoenixcrates.api.crate.animation | 2 enum, 3 interface, 1 class |
| com.phoenixplugins.phoenixcrates.api.crate.cost | 1 interface |
| com.phoenixplugins.phoenixcrates.api.crate.engine | 2 interface |
| com.phoenixplugins.phoenixcrates.api.crate.events | 10 class |
| com.phoenixplugins.phoenixcrates.api.crate.exceptions | 2 class |
| com.phoenixplugins.phoenixcrates.api.crate.hologram | 2 interface |
| com.phoenixplugins.phoenixcrates.api.events.items | 2 class, 1 enum |
| com.phoenixplugins.phoenixcrates.api.internal | 1 class |
| com.phoenixplugins.phoenixcrates.api.key | 1 interface |
| com.phoenixplugins.phoenixcrates.api.managers | 3 interface |
| com.phoenixplugins.phoenixcrates.api.player | 3 interface |
| com.phoenixplugins.phoenixcrates.api.registries | 1 interface |
| com.phoenixplugins.phoenixcrates.api.reward | 4 interface, 2 enum |
| com.phoenixplugins.phoenixcrates.api.session | 4 class, 1 interface |
All Classes
| Class | Package | Description |
|---|---|---|
Interface
CratesPlugin
|
com.phoenixplugins.phoenixcrates.api |
Represents the main entry point for interacting with the Crates API. Provides access to the core managers responsible... |
Class
PhoenixCratesAPI
|
com.phoenixplugins.phoenixcrates.api |
Main entry point for the PhoenixCrates API. Provides access to core managers, registries, and internal utilities. Use... |
Class
PhoenixCratesAPI.Unsafe
|
com.phoenixplugins.phoenixcrates.api |
Unsafe class to handle sensitive operations like setting the provider and registry. |
Interface
CrateBlockType
|
com.phoenixplugins.phoenixcrates.api.crate |
Represents a type of block used in a crate. This interface provides methods to access the block's material, raw data,... |
Interface
CrateHologram
|
com.phoenixplugins.phoenixcrates.api.crate |
Represents a holographic display associated with a crate. This interface allows checking the availability of the holo... |
Interface
CrateInstance
|
com.phoenixplugins.phoenixcrates.api.crate |
The Crate interface represents a container that can hold items and be opened by players. It defines methods for retri... |
Interface
CrateType Deprecated
|
com.phoenixplugins.phoenixcrates.api.crate |
Represents a specific configuration of a crate. Defines key properties such as the display name, engine configuration... |
Enum
AnimationEnvironment
|
com.phoenixplugins.phoenixcrates.api.crate.animation |
Describes where an animation phase is presented. |
Interface
AnimationPhase Deprecated
|
com.phoenixplugins.phoenixcrates.api.crate.animation |
Represents an animation with a specific phase, identifier, display name, and item. This interface defines the structu... |
Class
AnimationProperties
|
com.phoenixplugins.phoenixcrates.api.crate.animation |
Represents a collection of properties for configuring an animation. This class allows you to dynamically add, retriev... |
Interface
OpeningAnimationHandler
|
com.phoenixplugins.phoenixcrates.api.crate.animation |
Interface to handle the opening animation lifecycle for a crate. This interface defines the methods necessary to acce... |
Interface
PhaseRunner
|
com.phoenixplugins.phoenixcrates.api.crate.animation |
Interface to handle the running of an animation within an opening animation session. This interface defines the metho... |
Enum
PhaseType
|
com.phoenixplugins.phoenixcrates.api.crate.animation |
Represents the different phases of a crate opening animation. Used to track the state of the crate opening process. |
Interface
CostEngineType
|
com.phoenixplugins.phoenixcrates.api.crate.cost |
Represents the payment method used to charge a player when opening a crate. Defines only the cost engine's identity; ... |
Interface
EngineData
|
com.phoenixplugins.phoenixcrates.api.crate.engine |
Represents the data for a specific crate engine implementation. Provides access to the type of engine, which defines ... |
Interface
EngineType
|
com.phoenixplugins.phoenixcrates.api.crate.engine |
Represents a type of crate engine. Defines the engine's identifier, display name, and visual representation. This is ... |
Class
CrateOpenEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Represents an event that occurs when a crate is opened by a player. This event contains information about the crate a... |
Class
CratePlaceEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Called when a player places a crate block in the world. Can be cancelled to prevent the placement. |
Class
CratePreOpenEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Represents an event that occurs before a crate is opened by a player. This event allows for cancellation, preventing ... |
Class
CratePreRerollEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
|
Class
CratePreviewOpenEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Represents an event that occurs when a player opens a crate preview. This event can be cancelled, preventing the prev... |
Class
CrateRerollEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Event triggered when a crate is rerolled for a player. Contains information about the crate being rerolled, the rewar... |
Class
CrateRewardPlayerEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Represents an event triggered when a player receives a reward from opening a crate. This event contains information a... |
Class
CrateRewardSelectionEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
|
Class
CrateRewardWinItemsEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Represents an event triggered right before reward items are given to a player. This allows listeners to mutate or rep... |
Class
CrateSelectiveConfirmEvent
|
com.phoenixplugins.phoenixcrates.api.crate.events |
Fired immediately before a selective-mode reward opening is confirmed by the player. This event is called after the p... |
Class
CrateOpeningException
|
com.phoenixplugins.phoenixcrates.api.crate.exceptions |
Exception thrown when a crate cannot be opened successfully. Contains information about whether knockback effects sho... |
Class
CratePreviewException
|
com.phoenixplugins.phoenixcrates.api.crate.exceptions |
Exception thrown when a crate preview cannot be displayed successfully. This may occur due to invalid preview data, m... |
Interface
Hologram
|
com.phoenixplugins.phoenixcrates.api.crate.hologram |
Represents a hologram component responsible for displaying, updating, and managing holograms associated with a specif... |
Interface
HologramProperties
|
com.phoenixplugins.phoenixcrates.api.crate.hologram |
Defines the structure for managing hologram configuration data. Implementations of this interface should provide mech... |
Class
ItemDeliveryEvent
|
com.phoenixplugins.phoenixcrates.api.events.items |
Fired when crate-related items are about to be delivered to a player context. This event is called before final inven... |
Enum
ItemDeliverySource
|
com.phoenixplugins.phoenixcrates.api.events.items |
Identifies the origin of an item delivery attempt. Listeners can branch handling and messaging logic based on this so... |
Class
RewardCommandsEvent
|
com.phoenixplugins.phoenixcrates.api.events.items |
|
Class
Item
|
com.phoenixplugins.phoenixcrates.api.internal |
Represents a generic item used as a base for various implementations. This interface is intended to provide a standar... |
Interface
Key
|
com.phoenixplugins.phoenixcrates.api.key |
Represents a crate key used in the crate system. A CrateKey could be a physical or virtual item that a player uses to... |
Interface
CratesManager
|
com.phoenixplugins.phoenixcrates.api.managers |
Class for managing crate types and crate instances. Implementations handle lifecycle, persistence, and caching intern... |
Interface
KeysManager
|
com.phoenixplugins.phoenixcrates.api.managers |
Class for accessing and managing crate keys. Implementations manage caching, file I/O and lifecycle internally; only ... |
Interface
PlayersManager
|
com.phoenixplugins.phoenixcrates.api.managers |
Class for managing player data lifecycle and access. Implementations handle caching, persistence, and disposal intern... |
Interface
PlayerData
|
com.phoenixplugins.phoenixcrates.api.player |
Represents player-specific data within the PhoenixCrates API. Implementations can provide access to player state, sta... |
Interface
PlayerDataLayer
|
com.phoenixplugins.phoenixcrates.api.player |
Represents a data layer that can decide whether to return its own cached data or fetch from the next layer (typically... |
Interface
PlayerDbModel
|
com.phoenixplugins.phoenixcrates.api.player |
Represents a player database model abstraction. This interface defines all getters and setters required to access and... |
Interface
AnimationsRegistry
|
com.phoenixplugins.phoenixcrates.api.registries |
Registry for managing animation phases within the API. This interface provides methods to register, unregister, and r... |
Interface
AlternativeReward Deprecated
|
com.phoenixplugins.phoenixcrates.api.reward |
Represents an alternative reward that can be given to a player. Alternative rewards are used when the primary reward ... |
Interface
BaseReward
|
com.phoenixplugins.phoenixcrates.api.reward |
A base reward that defines common properties and behavior for all types of rewards. This can be extended by more spec... |
Enum
GuaranteedRewardType
|
com.phoenixplugins.phoenixcrates.api.reward |
Represents the type of guaranteed reward behavior for a crate. Guaranteed Rewards ensure that players receive specifi... |
Interface
Reward Deprecated
|
com.phoenixplugins.phoenixcrates.api.reward |
Represents a crate reward in the crate system. A Reward defines the items, commands, and behaviors that the player wi... |
Interface
RewardsGenerator Deprecated
|
com.phoenixplugins.phoenixcrates.api.reward |
Generates a list of rewards for a crate opening session. Implementations define how rewards are generated and returne... |
Enum
RewardsMode
|
com.phoenixplugins.phoenixcrates.api.reward |
Represents the mode for rewards. RANDOM - Rewards are given randomly. SELECTIVE - Rewards are given based on player s... |
Class
OpeningContext
|
com.phoenixplugins.phoenixcrates.api.session |
Represents the context of a crate opening session for a player. This includes the player's information and the type o... |
Class
OpeningContext.MassSelectiveOpeningContext
|
com.phoenixplugins.phoenixcrates.api.session |
Represents a mass selective crate opening session where multiple rewards are chosen. |
Class
OpeningContext.RandomOpeningContext
|
com.phoenixplugins.phoenixcrates.api.session |
Represents a random crate opening session for a player. |
Class
OpeningContext.SelectiveOpeningContext
|
com.phoenixplugins.phoenixcrates.api.session |
Represents a selective crate opening session for a player, where a specific reward is chosen. |
Interface
OpeningSession
|
com.phoenixplugins.phoenixcrates.api.session |
Represents an opening session for a crate. An OpeningSession encapsulates all of the components involved in the proce... |