Crate

Définition d’une caisse

ManifiestoProporcionado por Crate

Manifest entry describing a crate definition and its configuration. All dynamic information (open counts, milestones, etc.) must be stored in the linked [CrateArtifactEntry] via the [dataArtifact] field using the AssetManager.

Campos

Campo	Tipo	Predeterminado	Descripción
dataArtifact	Ref<CrateArtifactEntry>	—	Artifact qui enregistre les données de la caisse (ouvertures, clés, etc.)
displayNpc	Ref<out ManifestEntry>	—	NPC représentant visuellement la caisse
noKeyMessage	Var<String>	You need a key	Message envoyé lorsque le joueur n'a pas de clé
fireworkColors	List<Color>	—	Couleurs des feux d'artifice lors de l'ouverture
fireworkType	FireworkEffect.Type	FireworkEffect.Type.BALL	Type du feu d'artifice final
rewards	List<CrateReward>	empty	Récompenses possibles lors de l'ouverture de la caisse CrateReward (5) Campo Tipo Predeterminado Descripción action Ref<out TriggerableEntry> — Entrée déclenchée lorsque la récompense est sélectionnée lore List<Var<String>> empty Description de la récompense rarity String — Rareté de la récompense item Var<Item> — Item affiché dans la prévisualisation grantItem Boolean true Automatically give this item to the player; disable when the action gives it itself.
milestones	List<CrateMilestone>	empty	Jalons offrant des récompenses supplémentaires CrateMilestone (2) Campo Tipo Predeterminado Descripción openings Int 0 Nombre d'ouvertures requis reward Ref<out TriggerableEntry> — Récompense déclenchée à ce jalon
rarities	List<CrateRarity>	empty	Raretés disponibles pour les récompenses CrateRarity (1) Campo Tipo Predeterminado Descripción weight Double 1.0 Poids relatif des récompenses de cette rareté
chanceLore	Var<String>	—	Ligne ajoutée au lore indiquant la probabilité d'obtention (placeholders: {chance}, {rarity})
rarityLore	Var<String>	—	Ligne ajoutée au lore indiquant la rareté de la récompense (placeholders: {rarity}, {chance})
rewardSlots	String	—	Slots dans lesquels les récompenses sont affichées (ex: '2-10,15')
icon	CrateIcon	—	Icône représentant la caisse dans le menu global CrateIcon (4) Campo Tipo Predeterminado Descripción x Int 0 Position X de l'icône dans le menu global (0-8) y Int 0 Position Y de l'icône dans le menu global (0-5) item Var<Item> — Item utilisé pour représenter la caisse lore List<Var<String>> empty Description de l'icône (placeholders: %crate_<id>_keys%, %crate_<id>_keys_used%, %crate_<id>_openings%, %crate_<id>_last_open%, %crate_<id>_milestone%)
menuName	Var<String>	—	Nom du menu de la caisse (placeholders: %crate_<id>_keys%, %crate_<id>_keys_used%, %crate_<id>_openings%, %crate_<id>_last_open%, %crate_<id>_milestone%)
preview	CratePreviewOptions	—	Paramètres de prévisualisation de la caisse CratePreviewOptions (9) Campo Tipo Predeterminado Descripción distance Double 1.5 Front distance of the preview from the player's eyes followPlayer Boolean true Keep preview entities attached while the player moves or rotates followIntervalTicks Long 1 Follow interval in ticks; 1 is continuous, values above 5 are clamped layoutSpacing Double 1.6 Spacing between rewards in FLEX previews maxVisibleRewards Int 24 Maximum number of simultaneous reward displays for classic previews definitionLocation CratePreviewOffset — Position relative de la définition de caisse par rapport au joueur CratePreviewOffset (3) Campo Tipo Predeterminado Descripción x Double 0.0 Décalage latéral (négatif = gauche) y Double 0.0 Décalage vertical z Double 0.0 Décalage vers l'avant (positif = plus loin du joueur) itemDisplayOffset CratePreviewOffset — Décalage de la roulette d'items par rapport à la définition CratePreviewOffset (3) Campo Tipo Predeterminado Descripción x Double 0.0 Décalage latéral (négatif = gauche) y Double 0.0 Décalage vertical z Double 0.0 Décalage vers l'avant (positif = plus loin du joueur) textDisplayLocation CratePreviewOffset — Décalage des TextDisplay et hologrammes par rapport à la roulette d'items CratePreviewOffset (3) Campo Tipo Predeterminado Descripción x Double 0.0 Décalage latéral (négatif = gauche) y Double 0.0 Décalage vertical z Double 0.0 Décalage vers l'avant (positif = plus loin du joueur) textDisplayStyle CrateTextDisplayStyle — Personnalisation du TextDisplay affichant le nom et le lore de l'objet CrateTextDisplayStyle (6) Campo Tipo Predeterminado Descripción backgroundColor Color? — Couleur de fond ARGB du TextDisplay backgroundOpacity Int? — Opacité de fond (0-255) textOpacity Int? — Opacité du texte (0-255) lineWidth Int? — Largeur maximale des lignes shadow Boolean? — Activer l'ombre du texte seeThrough Boolean? — Rendre le texte traversable
openAnimation	Ref<out TriggerableEntry>	—	Animation exécutée lors de l'ouverture
hologramLines	List<String>	empty	Texte de l'hologramme affiché au-dessus de la caisse (placeholders: {openings}, {keys}, {last_open}, {milestone})
buttons	List<CrateButtonSlot>	empty	Boutons personnalisés dans le menu de la caisse CrateButtonSlot (6) Campo Tipo Predeterminado Descripción type CrateButtonType INFORMATION Type du boutonValores:INFORMATIONNEXTPREVIOUSFILL x Int 0 Position X dans la grille (0-8) y Int 0 Position Y dans la grille (0-5) item Var<Item> — Item personnalisé du bouton lore List<Var<String>> empty Description de l'item (placeholders: %crate_<id>_keys%, %crate_<id>_keys_used%, %crate_<id>_openings%, %crate_<id>_last_open%, %crate_<id>_milestone%) action Ref<out TriggerableEntry> — Action exécutée lors du clic
frameItem	Var<Item>	—	Item utilisé pour le cadre statique du menu (vide = aucun cadre)
itemsPerPage	Int	0	Nombre de récompenses par page (0 = automatique)
paginationColumn	Int	-1	Colonne de pagination (0-8, -1 = automatique)
cardBackItem	Var<Item>	—	Objet affiché au dos de la carte lors de l'ouverture
guiLayout	CrateGuiLayout	PAGINATED	GUI layout type for the crate reward menuValores:PAGINATEDFLEXSIMPLE
minigame	Ref<out CrateMinigameEntry>	—	Mini-jeu d'ouverture (vide = animation classique). Le gain est tiré côté serveur avant l'animation.Variantes:CardMinigameEntry CardMinigameEntry (14) Campo Tipo Predeterminado Descripción cardCount Int 8 Nombre de cartes affichées columns Int 4 Nombre de cartes par rangée rows Int 0 Maximum number of rows (0 = automatic, maximum 10) spacing Double 1.8 Espacement entre les cartes (blocs) forwardDistance Double 2.5 Distance des cartes devant le joueur (blocs) verticalOffset Double 0.0 Décalage vertical de toute la grille (négatif = plus bas) followRotation Boolean false Faire pivoter la grille lorsque le joueur tourne la vue flipDurationTicks Int 10 Durée de l'animation de retournement (ticks) cascadeDelayTicks Int 4 Délai entre le retournement des cartes leurres (ticks) closeDelayTicks Int 40 Délai avant fermeture après révélation (ticks) cardBackItem Var<Item> — Item du dos des cartes (vide = utilise celui de la caisse) hitboxSize Double 1.0 Taille de la zone cliquable de chaque carte (blocs) flipSound Sound EMPTY Son joué au retournement d'une carte winSound Sound EMPTY Son joué à la révélation du gain

How to use it

Fields that work together:

• Rewards and rarities — each reward has a rarity that must match the name of an entry in rarities. The weight of that rarity sets the chance. chanceLore and rarityLore add a line to the reward lore in the menu, with {chance} (percentage with two decimals) and {rarity}.
• rewardSlots — the slots of the reward menu, from 0 to 53, as numbers and ranges such as 2-10,15. At least one is required, and none may repeat. They are also what tells the menu how many rows it needs.
• grantItem — on by default: the reward item is given to the player (the overflow drops at their feet) and then the action runs. Turn it off when the action gives the item itself.
• milestones — after openings openings (above zero, each value once), the reward trigger fires once.
• minigame — leave empty for the classic opening, where rewards float in front of the player and openAnimation is triggered. Set it to a card mini-game for a pick-a-card opening.
• Preview — preview.distance, followPlayer, followIntervalTicks, layoutSpacing, maxVisibleRewards and the three offsets position the displays in the world. displayNpc adds an NPC, hologramLines adds floating text, and textDisplayStyle styles the labels.
• Menu — menuName, icon, buttons, frameItem, itemsPerPage, paginationColumn and guiLayout shape the menus.

A crate that fails validation will not open; the log says why.