@minecraft/creator-tools

{ "typeDefs": [{"name":"@minecraft/server","content":["// Type definitions for Minecraft Bedrock Edition script APIs", "// Project: https://docs.microsoft.com/minecraft/creator/", "// Definitions by: Jake Shirley <https://github.com/JakeShirley>", "// Mike Ammerlaan <https://github.com/mammerla>", "/* *****************************************************************************", " Copyright (c) Microsoft Corporation.", " ***************************************************************************** */", "/**", " * @beta", " * @packageDocumentation", " * Contains many types related to manipulating a Minecraft", " * world, including entities, blocks, dimensions, and more.", " *", " * Manifest Details", " * ```json", " * {", " * 'module_name': '@minecraft/server',", " * 'version': '1.15.0-beta'", " * }", " * ```", " *", " */", "import * as minecraftcommon from '@minecraft/common';", "/**", " * The types of block components that are accessible via", " * function Block.getComponent.", " */", "export enum BlockComponentTypes {", " /**", " * @remarks", " * Represents the inventory of a block in the world. Used with", " * blocks like chests.", " *", " */", " Inventory = 'minecraft:inventory',", " /**", " * @beta", " * @remarks", " * Represents a fluid container block that currently contains", " * lava.", " *", " */", " LavaContainer = 'minecraft:lavaContainer',", " /**", " * @remarks", " * When present, this block has piston-like behavior. Contains", " * additional properties for discovering block piston state.", " *", " */", " Piston = 'minecraft:piston',", " /**", " * @beta", " * @remarks", " * Represents a fluid container block that currently contains a", " * potion.", " *", " */", " PotionContainer = 'minecraft:potionContainer',", " /**", " * @rc", " * @remarks", " * Represents a block that can play a record.", " *", " */", " RecordPlayer = 'minecraft:record_player',", " /**", " * @remarks", " * Represents a block that can display text on it.", " *", " */", " Sign = 'minecraft:sign',", " /**", " * @beta", " * @remarks", " * Represents a fluid container block that currently contains", " * snow.", " *", " */", " SnowContainer = 'minecraft:snowContainer',", " /**", " * @beta", " * @remarks", " * Represents a fluid container block that currently contains", " * water.", " *", " */", " WaterContainer = 'minecraft:waterContainer',", "}", "/**", " * An enumeration describing the state of a block piston.", " */", "export enum BlockPistonState {", " /**", " * @remarks", " * Whether the piston is fully expanded.", " *", " */", " Expanded = 'Expanded',", " /**", " * @remarks", " * Whether the piston is in the process of expanding.", " *", " */", " Expanding = 'Expanding',", " /**", " * @remarks", " * Whether the piston is fully retracted.", " *", " */", " Retracted = 'Retracted',", " /**", " * @remarks", " * Whether the piston is in the process of retracting.", " *", " */", " Retracting = 'Retracting',", "}", "/**", " * @beta", " * Description of the resulting intersection test on two", " * BlockVolume objects", " */", "export enum BlockVolumeIntersection {", " /**", " * @remarks", " * Volume B has no intersection points with Volume A", " *", " */", " Disjoint = 0,", " /**", " * @remarks", " * Volume B resides completely inside Volume A", " *", " */", " Contains = 1,", " /**", " * @remarks", " * Volume B partially intersects Volume A", " *", " */", " Intersects = 2,", "}", "/**", " * @beta", " * The Action enum determines how the CompoundBlockVolume", " * considers the associated CompoundBlockVolumeItem when", " * performing inside/outside calculations.", " */", "export enum CompoundBlockVolumeAction {", " /**", " * @remarks", " * The associated BlockVolume is considered a positive space,", " * and any intersection tests are considered hits", " *", " */", " Add = 0,", " /**", " * @remarks", " * The associated BlockVolume is considered a negative or void", " * space, and any intersection tests are considered misses.", " * Using the Subtract action, it is possible to `punch holes`", " * in block volumes so that any intersection tests may pass", " * through such spaces", " *", " */", " Subtract = 1,", "}", "/**", " * @beta", " * An enum describing the relativity of the", " * CompoundBlockVolumeItem, relative to the parent", " * CompoundVolume.", " */", "export enum CompoundBlockVolumePositionRelativity {", " /**", " * @remarks", " * The locations within the associated BlockVolume are relative", " * to the CompoundBlockVolume to which they were added", " *", " */", " Relative = 0,", " /**", " * @remarks", " * The locations within the associated BlockVolume are in", " * absolute world space", " *", " */", " Absolute = 1,", "}", "export enum CustomComponentNameErrorReason {", " NoNamespace = 1,", " DisallowedNamespace = 2,", "}", "/**", " * @beta", " * An enumeration for the various difficulty levels of", " * Minecraft.", " */", "export enum Difficulty {", " /**", " * @remarks", " * Peaceful difficulty level.", " *", " */", " Peaceful = 0,", " /**", " * @remarks", " * Easy difficulty level.", " *", " */", " Easy = 1,", " /**", " * @remarks", " * Normal difficulty level.", " *", " */", " Normal = 2,", " /**", " * @remarks", " * Hard difficulty level.", " *", " */", " Hard = 3,", "}", "/**", " * A general purpose relative direction enumeration.", " */", "export enum Direction {", " /**", " * @remarks", " * Returns the {@link Block} beneath (y - 1) of this item.", " *", " */", " Down = 'Down',", " /**", " * @remarks", " * Returns the {@link Block} to the east (x + 1) of this item.", " *", " */", " East = 'East',", " /**", " * @remarks", " * Returns the {@link Block} to the east (z + 1) of this item.", " *", " */", " North = 'North',", " /**", " * @remarks", " * Returns the {@link Block} to the south (z - 1) of this item.", " *", " */", " South = 'South',", " /**", " * @remarks", " * Returns the {@link Block} above (y + 1) of this item.", " *", " */", " Up = 'Up',", " /**", " * @remarks", " * Returns the {@link Block} to the west (x - 1) of this item.", " *", " */", " West = 'West',", "}", "/**", " * Specifies a mechanism for displaying scores on a scoreboard.", " */", "export enum DisplaySlotId {", " /**", " * @remarks", " * Displays the score below the player's name.", " *", " */", " BelowName = 'BelowName',", " /**", " * @remarks", " * Displays the score as a list on the pause screen.", " *", " */", " List = 'List',", " /**", " * @remarks", " * Displays the score on the side of the player's screen.", " *", " */", " Sidebar = 'Sidebar',", "}", "/**", " * Specifies different colors for use as dye.", " */", "export enum DyeColor {", " /**", " * @remarks", " * Black dye color.", " *", " */", " Black = 'Black',", " /**", " * @remarks", " * Blue dye color.", " *", " */", " Blue = 'Blue',", " /**", " * @remarks", " * Brown dye color.", " *", " */", " Brown = 'Brown',", " /**", " * @remarks", " * Cyan dye color.", " *", " */", " Cyan = 'Cyan',", " /**", " * @remarks", " * Gray dye color.", " *", " */", " Gray = 'Gray',", " /**", " * @remarks", " * Green dye color.", " *", " */", " Green = 'Green',", " /**", " * @remarks", " * Light blue dye color.", " *", " */", " LightBlue = 'LightBlue',", " /**", " * @remarks", " * Lime dye color.", " *", " */", " Lime = 'Lime',", " /**", " * @remarks", " * Magenta dye color.", " *", " */", " Magenta = 'Magenta',", " /**", " * @remarks", " * Orange dye color.", " *", " */", " Orange = 'Orange',", " /**", " * @remarks", " * Pink dye color.", " *", " */", " Pink = 'Pink',", " /**", " * @remarks", " * Purple dye color.", " *", " */", " Purple = 'Purple',", " /**", " * @remarks", " * Red dye color.", " *", " */", " Red = 'Red',", " /**", " * @remarks", " * Silver dye color.", " *", " */", " Silver = 'Silver',", " /**", " * @remarks", " * White dye color.", " *", " */", " White = 'White',", " /**", " * @remarks", " * Yellow dye color.", " *", " */", " Yellow = 'Yellow',", "}", "export enum EasingType {", " InBack = 'InBack',", " InBounce = 'InBounce',", " InCirc = 'InCirc',", " InCubic = 'InCubic',", " InElastic = 'InElastic',", " InExpo = 'InExpo',", " InOutBack = 'InOutBack',", " InOutBounce = 'InOutBounce',", " InOutCirc = 'InOutCirc',", " InOutCubic = 'InOutCubic',", " InOutElastic = 'InOutElastic',", " InOutExpo = 'InOutExpo',", " InOutQuad = 'InOutQuad',", " InOutQuart = 'InOutQuart',", " InOutQuint = 'InOutQuint',", " InOutSine = 'InOutSine',", " InQuad = 'InQuad',", " InQuart = 'InQuart',", " InQuint = 'InQuint',", " InSine = 'InSine',", " Linear = 'Linear',", " OutBack = 'OutBack',", " OutBounce = 'OutBounce',", " OutCirc = 'OutCirc',", " OutCubic = 'OutCubic',", " OutElastic = 'OutElastic',", " OutExpo = 'OutExpo',", " OutQuad = 'OutQuad',", " OutQuart = 'OutQuart',", " OutQuint = 'OutQuint',", " OutSine = 'OutSine',", " Spring = 'Spring',", "}", "export enum EnchantmentSlot {", " ArmorFeet = 'ArmorFeet',", " ArmorHead = 'ArmorHead',", " ArmorLegs = 'ArmorLegs',", " ArmorTorso = 'ArmorTorso',", " Axe = 'Axe',", " Bow = 'Bow',", " CarrotStick = 'CarrotStick',", " CosmeticHead = 'CosmeticHead',", " Crossbow = 'Crossbow',", " Elytra = 'Elytra',", " FishingRod = 'FishingRod',", " Flintsteel = 'Flintsteel',", " Hoe = 'Hoe',", " Pickaxe = 'Pickaxe',", " Shears = 'Shears',", " Shield = 'Shield',", " Shovel = 'Shovel',", " Spear = 'Spear',", " Sword = 'Sword',", "}", "/**", " * The types of entity components that are accessible via", " * function Entity.getComponent.", " */", "export enum EntityComponentTypes {", " /**", " * @remarks", " * When added, this component makes the entity spawn with a", " * rider of the specified entityType.", " *", " */", " AddRider = 'minecraft:addrider',", " /**", " * @remarks", " * Adds a timer for the entity to grow up. It can be", " * accelerated by giving the entity the items it likes as", " * defined by feedItems.", " *", " */", " Ageable = 'minecraft:ageable',", " /**", " * @beta", " * @remarks", " * Defines what blocks this entity can breathe in and gives", " * them the ability to suffocate.", " *", " */", " Breathable = 'minecraft:breathable',", " /**", " * @remarks", " * When added, this component signifies that the entity can", " * climb up ladders.", " *", " */", " CanClimb = 'minecraft:can_climb',", " /**", " * @remarks", " * When added, this component signifies that the entity can", " * fly, and the pathfinder won't be restricted to paths where a", " * solid block is required underneath it.", " *", " */", " CanFly = 'minecraft:can_fly',", " /**", " * @remarks", " * When added, this component signifies that the entity can", " * power jump like the horse does within Minecraft.", " *", " */", " CanPowerJump = 'minecraft:can_power_jump',", " /**", " * @remarks", " * Defines the entity's color. Only works on certain entities", " * that have predefined color values (e.g., sheep, llama,", " * shulker).", " *", " */", " Color = 'minecraft:color',", " /**", " * @remarks", " * Defines the entity's secondary color. Only works on certain", " * entities that have predefined secondary color values (e.g.,", " * tropical fish).", " *", " */", " Color2 = 'minecraft:color2',", " /**", " * @rc", " */", " CursorInventory = 'minecraft:cursor_inventory',", " /**", " * @remarks", " * Provides access to a mob's equipment slots. This component", " * exists for all mob entities.", " *", " */", " Equippable = 'minecraft:equippable',", " /**", " * @remarks", " * When added, this component signifies that this entity", " * doesn't take damage from fire.", " *", " */", " FireImmune = 'minecraft:fire_immune',", " /**", " * @remarks", " * When added, this component signifies that this entity can", " * float in liquid blocks.", " *", " */", " FloatsInLiquid = 'minecraft:floats_in_liquid',", " /**", " * @remarks", " * Represents the flying speed of an entity.", " *", " */", " FlyingSpeed = 'minecraft:flying_speed',", " /**", " * @remarks", " * Defines how much friction affects this entity.", " *", " */", " FrictionModifier = 'minecraft:friction_modifier',", " /**", " * @remarks", " * Sets the offset from the ground that the entity is actually", " * at.", " *", " */", " GroundOffset = 'minecraft:ground_offset',", " /**", " * @remarks", " * Defines the interactions with this entity for healing it.", " *", " */", " Healable = 'minecraft:healable',", " /**", " * @remarks", " * Defines the health properties of an entity.", " *", " */", " Health = 'minecraft:health',", " /**", " * @remarks", " * Defines this entity's inventory properties.", " *", " */", " Inventory = 'minecraft:inventory',", " /**", " * @remarks", " * When added, this component signifies that this entity is a", " * baby.", " *", " */", " IsBaby = 'minecraft:is_baby',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * charged.", " *", " */", " IsCharged = 'minecraft:is_charged',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * currently carrying a chest.", " *", " */", " IsChested = 'minecraft:is_chested',", " /**", " * @remarks", " * When added, this component signifies that dyes can be used", " * on this entity to change its color.", " *", " */", " IsDyeable = 'minecraft:is_dyeable',", " /**", " * @remarks", " * When added, this component signifies that this entity can", " * hide from hostile mobs while invisible.", " *", " */", " IsHiddenWhenInvisible = 'minecraft:is_hidden_when_invisible',", " /**", " * @remarks", " * When added, this component signifies that this entity this", " * currently on fire.", " *", " */", " IsIgnited = 'minecraft:is_ignited',", " /**", " * @remarks", " * When added, this component signifies that this entity is an", " * illager captain.", " *", " */", " IsIllagerCaptain = 'minecraft:is_illager_captain',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * currently saddled.", " *", " */", " IsSaddled = 'minecraft:is_saddled',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * currently shaking.", " *", " */", " IsShaking = 'minecraft:is_shaking',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * currently sheared.", " *", " */", " IsSheared = 'minecraft:is_sheared',", " /**", " * @remarks", " * When added, this component signifies that this entity can be", " * stacked.", " *", " */", " IsStackable = 'minecraft:is_stackable',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * currently stunned.", " *", " */", " IsStunned = 'minecraft:is_stunned',", " /**", " * @remarks", " * When added, this component signifies that this entity is", " * currently tamed.", " *", " */", " IsTamed = 'minecraft:is_tamed',", " /**", " * @remarks", " * If added onto the entity, this indicates that the entity", " * represents a free-floating item in the world. Lets you", " * retrieve the actual item stack contents via the itemStack", " * property.", " *", " */", " Item = 'minecraft:item',", " /**", " * @remarks", " * Defines the base movement speed in lava of this entity.", " *", " */", " LavaMovement = 'minecraft:lava_movement',", " /**", " * @remarks", " * Allows this entity to be leashed and defines the conditions", " * and events for this entity when is leashed.", " *", " */", " Leashable = 'minecraft:leashable',", " /**", " * @remarks", " * When added, this component signifies that this entity", " * contains an additional variant value. Can be used to further", " * differentiate variants.", " *", " */", " MarkVariant = 'minecraft:mark_variant',", " /**", " * @remarks", " * Defines the general movement speed of this entity.", " *", " */", " Movement = 'minecraft:movement',", " /**", " * @remarks", " * When added, this movement control allows the mob to swim in", " * water and walk on land.", " *", " */", " MovementAmphibious = 'minecraft:movement.amphibious',", " /**", " * @remarks", " * When added, this component allows the movement of an entity.", " *", " */", " MovementBasic = 'minecraft:movement.basic',", " /**", " * @remarks", " * When added, this move control causes the mob to fly.", " *", " */", " MovementFly = 'minecraft:movement.fly',", " /**", " * @remarks", " * When added, this move control allows a mob to fly, swim,", " * climb, etc.", " *", " */", " MovementGeneric = 'minecraft:movement.generic',", " /**", " * @remarks", " * When added, this movement control allows the mob to glide.", " *", " */", " MovementGlide = 'minecraft:movement.glide',", " /**", " * @remarks", " * When added, this move control causes the mob to hover.", " *", " */", " MovementHover = 'minecraft:movement.hover',", " /**", " * @remarks", " * Move control that causes the mob to jump as it moves with a", " * specified delay between jumps.", " *", " */", " MovementJump = 'minecraft:movement.jump',", " /**", " * @remarks", " * When added, this move control causes the mob to hop as it", " * moves.", " *", " */", " MovementSkip = 'minecraft:movement.skip',", " /**", " * @remarks", " * When added, this move control causes the mob to sway side to", " * side giving the impression it is swimming.", " *", " */", " MovementSway = 'minecraft:movement.sway',", " /**", " * @remarks", " * Allows this entity to generate paths that include vertical", " * walls (for example, like Minecraft spiders do.)", " *", " */", " NavigationClimb = 'minecraft:navigation.climb',", " /**", " * @remarks", " * Allows this entity to generate paths by flying around the", " * air like the regular Ghast.", " *", " */", " NavigationFloat = 'minecraft:navigation.float',", " /**", " * @remarks", " * Allows this entity to generate paths in the air (for", " * example, like Minecraft parrots do.)", " *", " */", " NavigationFly = 'minecraft:navigation.fly',", " /**", " * @remarks", " * Allows this entity to generate paths by walking, swimming,", " * flying and/or climbing around and jumping up and down a", " * block.", " *", " */", " NavigationGeneric = 'minecraft:navigation.generic',", " /**", " * @remarks", " * Allows this entity to generate paths in the air (for", " * example, like the Minecraft Bees do.) Keeps them from", " * falling out of the skies and doing predictive movement.", " *", " */", " NavigationHover = 'minecraft:navigation.hover',", " /**", " * @remarks", " * Allows this entity to generate paths by walking around and", " * jumping up and down a block like regular mobs.", " *", " */", " NavigationWalk = 'minecraft:navigation.walk',", " /**", " * @beta", " * @remarks", " * Adds NPC capabilities to an entity such as custom skin,", " * name, and dialogue interactions.", " *", " */", " Npc = 'minecraft:npc',", " /**", " * @remarks", " * When present on an entity, this entity is on fire.", " *", " */", " OnFire = 'minecraft:onfire',", " /**", " * @remarks", " * The projectile component controls the properties of a", " * projectile entity and allows it to be shot in a given", " * direction. This component is present when the entity has the", " * minecraft:projectile component.", " *", " */", " Projectile = 'minecraft:projectile',", " /**", " * @remarks", " * Sets the distance through which the entity can push through.", " *", " */", " PushThrough = 'minecraft:push_through',", " /**", " * @remarks", " * When added, this component adds the capability that an", " * entity can be ridden by another entity.", " *", " */", " Rideable = 'minecraft:rideable',", " /**", " * @remarks", " * This component is added to any entity when it is riding", " * another entity.", " *", " */", " Riding = 'minecraft:riding',", " /**", " * @remarks", " * Sets the entity's visual size.", " *", " */", " Scale = 'minecraft:scale',", " /**", " * @remarks", " * Skin Id value. Can be used to differentiate skins, such as", " * base skins for villagers.", " *", " */", " SkinId = 'minecraft:skin_id',", " /**", " * @remarks", " * Defines the entity's strength to carry items.", " *", " */", " Strength = 'minecraft:strength',", " /**", " * @remarks", " * Defines the rules for an entity to be tamed by the player.", " *", " */", " Tameable = 'minecraft:tameable',", " /**", " * @remarks", " * Contains options for taming a rideable entity based on the", " * entity that mounts it.", " *", " */", " TameMount = 'minecraft:tamemount',", " /**", " * @remarks", " * Used to determine the type families the entity belongs to.", " *", " */", " TypeFamily = 'minecraft:type_family',", " /**", " * @remarks", " * Defines the general movement speed underwater of this", " * entity.", " *", " */", " UnderwaterMovement = 'minecraft:underwater_movement',", " /**", " * @remarks", " * Used to differentiate the component group of a variant of an", " * entity from others. (e.g. ocelot, villager).", " *", " */", " Variant = 'minecraft:variant',", " /**", " * @remarks", " * When added, this component signifies that this entity wants", " * to become a jockey.", " *", " */", " WantsJockey = 'minecraft:wants_jockey',", "}", "/**", " * Describes the source of damage from an Entity.", " */", "export enum EntityDamageCause {", " /**", " * @remarks", " * Damage caused by a falling anvil.", " *", " */", " anvil = 'anvil',", " /**", " * @remarks", " * Damage caused from a non-Entity explosion. For example, an", " * exploding bed.", " *", " */", " blockExplosion = 'blockExplosion',", " /**", " * @remarks", " * Damage caused by Campfires.", " *", " */", " campfire = 'campfire',", " /**", " * @remarks", " * Unused.", " *", " */", " charging = 'charging',", " /**", " * @remarks", " * Damage caused by physically touching an Entity or Block. For", " * example, touching a Sweet Berry bush or Pufferfish.", " *", " */", " contact = 'contact',", " /**", " * @remarks", " * Damage caused by an Entity being out of air and inside a", " * liquid block.", " *", " */", " drowning = 'drowning',", " /**", " * @remarks", " * Damage caused by an Entity attack.", " *", " */", " entityAttack = 'entityAttack',", " /**", " * @remarks", " * Damage caused by an Entity explosion. For example, a Creeper", " * or Wither.", " *", " */", " entityExplosion = 'entityExplosion',", " /**", " * @remarks", " * Damage caused by falling onto the ground.", " *", " */", " fall = 'fall',", " /**", " * @remarks", " * Damage caused by falling blocks. Note: Anvils and", " * Stalactites have their own damage causes.", " *", " */", " fallingBlock = 'fallingBlock',", " /**", " * @remarks", " * Damage caused by catching on fire.", " *", " */", " fire = 'fire',", " /**", " * @remarks", " * Damage caused by burning over time.", " *", " */", " fireTick = 'fireTick',", " /**", " * @remarks", " * Damage caused by fireworks.", " *", " */", " fireworks = 'fireworks',", " /**", " * @remarks", " * Damage caused by flying into a wall at high speed while", " * gliding with Elytra.", " *", " */", " flyIntoWall = 'flyIntoWall',", " /**", " * @remarks", " * Damage caused by staying inside a Powder Snow block.", " *", " */", " freezing = 'freezing',", " /**", " * @remarks", " * Damage caused by touching a Lava block.", " *", " */", " lava = 'lava',", " /**", " * @remarks", " * Damage caused by being struck by lightning.", " *", " */", " lightning = 'lightning',", " maceSmash = 'maceSmash',", " /**", " * @remarks", " * Damage caused by magical attacks. For example, Evoker Fang", " * or Conduit Block.", " *", " */", " magic = 'magic',", " /**", " * @remarks", " * Damage caused by touching a Magma block.", " *", " */", " magma = 'magma',", " /**", " * @remarks", " * Damage caused by no source. For example, from a command or", " * script.", " *", " */", " none = 'none',", " /**", " * @remarks", " * Damage caused by an indirect source. For example, setting a", " * mob's health to 0 in a behavior pack.", " *", " */", " override = 'override',", " /**", " * @remarks", " * Damage caused by a Piston.", " *", " */", " piston = 'piston',", " /**", " * @remarks", " * Damage caused by a projectile.", " *", " */", " projectile = 'projectile',", " /**", " * @remarks", " * Damage caused by Goat ramming.", " *", " */", " ramAttack = 'ramAttack',", " /**", " * @remarks", " * Damage caused by the /kill command.", " *", " */", " selfDestruct = 'selfDestruct',", " /**", " * @remarks", " * Damage caused by the Warden's Sonic Boom attack.", " *", " */", " sonicBoom = 'sonicBoom',", " /**", " * @remarks", " * Damage caused by a Soul Campfire.", " *", " */", " soulCampfire = 'soulCampfire',", " /**", " * @remarks", " * Damage caused by a falling Stalactite block.", " *", " */", " stalactite = 'stalactite',", " /**", " * @remarks", " * Damage caused by touching a Stalagmite block.", " *", " */", " stalagmite = 'stalagmite',", " /**", " * @remarks", " * Damage caused over time by having an empty hunger bar.", " *", " */", " starve = 'starve',", " /**", " * @remarks", " * Damage caused by an Entity being out of air and inside a", " * non-liquid block.", " *", " */", " suffocation = 'suffocation',", " /**", " * @remarks", " * Damage caused by an Entity killing itself. For example, from", " * the /kill command.", " *", " */", " suicide = 'suicide',", " /**", " * @remarks", " * Damage caused by an Entity being in an inhabitable climate.", " * For example, a Snow Golem in a biome with a temperature", " * greater than 1.", " *", " */", " temperature = 'temperature',", " /**", " * @remarks", " * Damage caused by the Thorns armor enchantment and by the", " * Guardian thorns effect.", " *", " */", " thorns = 'thorns',", " /**", " * @remarks", " * Damage caused over time by falling into the void.", " *", " */", " 'void' = 'void',", " /**", " * @remarks", " * Damage caused by the Wither effect. For example, from", " * touching a Wither Rose.", " *", " */", " wither = 'wither',", "}", "/**", " * An enumeration describing initialization cause of an entity.", " */", "export enum EntityInitializationCause {", " /**", " * @remarks", " * Case when an entity is created as child of other entity or", " * entities, e.g., cows making a cow or slimes making smaller", " * slimes after dying.", " *", " */", " Born = 'Born',", " /**", " * @remarks", " * Case when an entity is created by an event, e.g., a", " * Wandering trader spawning llamas.", " *", " */", " Event = 'Event',", " /**", " * @remarks", " * Case when an entity is loaded into the world.", " *", " */", " Loaded = 'Loaded',", " /**", " * @remarks", " * Case when an entity is naturally spawned in the world.", " *", " */", " Spawned = 'Spawned',", " /**", " * @remarks", " * Case when an entity is transformed into another entity.", " *", " */", " Transformed = 'Transformed',", "}", "/**", " * The equipment slot of the mob. This includes armor, offhand", " * and mainhand slots.", " */", "export enum EquipmentSlot {", " /**", " * @beta", " * @remarks", " * The body slot. This slot is used to hold armor for", " * non-humanoid mobs.", " *", " */", " Body = 'Body',", " /**", " * @remarks", " * The chest slot. This slot is used to hold items such as", " * Chestplate or Elytra.", " *", " */", " Chest = 'Chest',", " /**", " * @remarks", " * The feet slot. This slot is used to hold items such as", " * Boots.", " *", " */", " Feet = 'Feet',", " /**", " * @remarks", " * The head slot. This slot is used to hold items such as", " * Helmets or Carved Pumpkins.", " *", " */", " Head = 'Head',", " /**", " * @remarks", " * The legs slot. This slot is used to hold items such as", " * Leggings.", " *", " */", " Legs = 'Legs',", " /**", " * @remarks", " * The mainhand slot. For players, the mainhand slot refers to", " * the currently active hotbar slot.", " *", " */", " Mainhand = 'Mainhand',", " /**", " * @remarks", " * The offhand slot. This slot is used to hold items such as", " * shields and maps.", " *", " */", " Offhand = 'Offhand',", "}", "/**", " * Represents the type of fluid for use within a fluid", " * containing block, like a cauldron.", " */", "export enum FluidType {", " /**", " * @remarks", " * Represents lava as a type of fluid.", " *", " */", " Lava = 'Lava',", " /**", " * @remarks", " * Represents a potion as a type of fluid.", " *", " */", " Potion = 'Potion',", " /**", " * @remarks", " * Represents powder snow as a type of fluid.", " *", " */", " PowderSnow = 'PowderSnow',", " /**", " * @remarks", " * Represents water as a type of fluida.", " *", " */", " Water = 'Water',", "}", "/**", " * Represents a game mode for the current world experience.", " */", "export enum GameMode {", " /**", " * @remarks", " * World is in a more locked-down experience, where blocks may", " * not be manipulated.", " *", " */", " adventure = 'adventure',", " /**", " * @remarks", " * World is in a full creative mode. In creative mode, the", " * player has all the resources available in the item selection", " * tabs and the survival selection tab. They can also destroy", " * blocks instantly including those which would normally be", " * indestructible. Command and structure blocks can also be", " * used in creative mode. Items also do not lose durability or", " * disappear.", " *", " */", " creative = 'creative',", " /**", " * @remarks", " * World is in spectator mode. In spectator mode, spectators", " * are always flying and cannot become grounded. Spectators can", " * pass through solid blocks and entities without any", " * collisions, and cannot use items or interact with blocks or", " * mobs. Spectators cannot be seen by mobs or other players,", " * except for other spectators; spectators appear as a", " * transparent floating head.", " *", " */", " spectator = 'spectator',", " /**", " * @remarks", " * World is in a survival mode, where players can take damage", " * and entities may not be peaceful. Survival mode is where the", " * player must collect resources, build structures while", " * surviving in their generated world. Activities can, over", " * time, chip away at player health and hunger bar.", " *", " */", " survival = 'survival',", "}", "/**", " * Game rules. These values can also be controlled via the", " * /gamerule command.", " */", "export enum GameRule {", " /**", " * @remarks", " * Whether command blocks should notify admins when they", " * perform commands.", " *", " */", " CommandBlockOutput = 'commandBlockOutput',", " /**", " * @remarks", " * Controls whether command blocks can execute commands.", " *", " */", " CommandBlocksEnabled = 'commandBlocksEnabled',", " /**", " * @remarks", " * Controls whether the day and night cycles progress.", " *", " */", " DoDayLightCycle = 'doDayLightCycle',", " /**", " * @remarks", " * Controls whether non-mob entities do drops. ie. Item Frame", " *", " */", " DoEntityDrops = 'doEntityDrops',", " /**", " * @remarks", " * Controls whether fire spreads.", " *", " */", " DoFireTick = 'doFireTick',", " /**", " * @remarks", " * Controls whether players immediately respawn or are shown", " * the death screen.", " *", " */", " DoImmediateRespawn = 'doImmediateRespawn',", " /**", " * @remarks", " * Controls whether players deal with the effects of not", " * sleeping (such as Phantom spawning).", " *", " */", " DoInsomnia = 'doInsomnia',", " /**", " * @remarks", " * Determines whether players should be able to craft only", " * those recipes that they've unlocked first - when", " * dolimitedcrafting is set to true.", " *", " */", " DoLimitedCrafting = 'doLimitedCrafting',", " /**", " * @remarks", " * Controls whether mobs drop loot.", " *", " */", " DoMobLoot = 'doMobLoot',", " /**", " * @remarks", " * Controls whether mobs spawn naturally in the world.", " *", " */", " DoMobSpawning = 'doMobSpawning',", " /**", " * @remarks", " * Controls whether blocks drop items when destroyed.", " *", " */", " DoTileDrops = 'doTileDrops',", " /**", " * @remarks", " * Controls whether the weather can change naturally.", " *", " */", " DoWeatherCycle = 'doWeatherCycle',", " /**", " * @remarks", " * Controls whether entities take damage from drowning.", " *", " */", " DrowningDamage = 'drowningDamage',", " /**", " * @remarks", " * Controls whether entities take damage from falling.", " *", " */", " FallDamage = 'fallDamage',", " /**", " * @remarks", " * Controls whether entities take damage from fire.", " *", " */", " FireDamage = 'fireDamage',", " /**", " * @remarks", " * Controls whether there is damage from freezing.", " *", " */", " FreezeDamage = 'freezeDamage',", " /**", " * @remarks", " * The maximum number of commands that can be executed", " * simultaneously by the /function command.", " *", " */", " FunctionCommandLimit = 'functionCommandLimit',", " /**", " * @remarks", " * Controls whether players keep their inventories when they", " * die.", " *", " */", " KeepInventory = 'keepInventory',", " /**", " * @remarks", " * The maximum number of chained commands that can execute per", " * tick.", " *", " */", " MaxCommandChainLength = 'maxCommandChainLength',", " /**", " * @remarks", " * Controls whether mob griefing can happen in the world.", " * Example: A Creeper explosion destroying blocks.", " *", " */", " MobGriefing = 'mobGriefing',", " /**", " * @remarks", " * Controls whether players can regenerate health.", " *", " */", " NaturalRegeneration = 'naturalRegeneration',", " /**", " * @remarks", " * The percentage of players required to be sleeping in order", " * to advance to the next day.", " *", " */", " PlayersSleepingPercentage = 'playersSleepingPercentage',", " /**", " * @remarks", " * Controls whether projectiles (entities with a projectile", " * component, like Arrows, thrown Tridents or Fireworks) can", " * destroy certain blocks that support this interaction (such", " * as Chorus Fruit, Dripstone or Decorated Pots). Restrictions", " * on which projectiles can destroy certain blocks apply.", " *", " */", " ProjectilesCanBreakBlocks = 'projectilesCanBreakBlocks',", " /**", " * @remarks", " * Controls whether players can damage each other.", " *", " */", " Pvp = 'pvp',", " /**", " * @remarks", " * Controls how frequently random ticks occur. A value of 0 or", " * less will disable random ticks. The default value is 1.", " *", " */", " RandomTickSpeed = 'randomTickSpeed',", " /**", " * @remarks", " * Controls whether built-in (vanilla) recipes automatically", " * unlock as the player progresses through the game (one", " * alternative to this is to use the /recipe command based on", " * custom gameplay logic.)", " *", " */", " RecipesUnlock = 'recipesUnlock',", " /**", " * @remarks", " * Controls whether respawn blocks (e.g. Bed, Respawn Anchor)", " * explode in other dimensions.", " *", " */", " RespawnBlocksExplode = 'respawnBlocksExplode',", " /**", " * @remarks", " * Controls whether command output is displayed to players.", " * Also controls whether Command Block output is stored by", " * default.", " *", " */", " SendCommandFeedback = 'sendCommandFeedback',", " /**", " * @remarks", " * Controls whether Border Block effects are shown.", " *", " */", " ShowBorderEffect = 'showBorderEffect',", " /**", " * @remarks", " * Controls whether player coordinates are displayed.", " *", " */", " ShowCoordinates = 'showCoordinates',", " /**", " * @remarks", " * Controls whether the days a player has played is displayed.", " *", " */", " ShowDaysPlayed = 'showDaysPlayed',", " /**", " * @remarks", " * Controls whether death messages are displayed in chat.", " *", " */", " ShowDeathMessages = 'showDeathMessages',", " /**", " * @remarks", " * Controls whether standard player notifications for recipes", " * will show. When set to false, 'player unlocked recipes' are", " * no longer sent as player notifications.", " *", " */", " ShowRecipeMessages = 'showRecipeMessages',", " /**", " * @remarks", " * Controls whether item tags are shown. E.g. 'Can Place On',", " * 'Can Destroy', item lock icons, etc.", " *", " */", " ShowTags = 'showTags',", " /**", " * @remarks", " * The block radius from world spawn that a player is allowed", " * to spawn in. Does not affect Adventure mode. The default", " * value is 10 blocks.", " *", " */", " SpawnRadius = 'spawnRadius',", " /**", " * @remarks", " * Affects whether TNT blocks can be lit.", " *", " */", " TntExplodes = 'tntExplodes',", " /**", " * @remarks", " * Controls whether blocks randomly drop loot or all blocks", " * drop loot when destroyed by an explosion. Defaults to false.", " *", " */", " TntExplosionDropDecay = 'tntExplosionDropDecay',", "}", "export enum HudElement {", " PaperDoll = 0,", " Armor = 1,", " ToolTips = 2,", " TouchControls = 3,", " Crosshair = 4,", " Hotbar = 5,", " Health = 6,", " ProgressBar = 7,", " Hunger = 8,", " AirBubbles = 9,", " HorseHealth = 10,", " StatusEffects = 11,", " ItemText = 12,", "}", "/**", " * Enumeration that specifies how to treat the visibility of a", " * HUD element.", " */", "export enum HudVisibility {", " /**", " * @remarks", " * Specifies that this HUD element should be hidden.", " *", " */", " Hide = 0,", " /**", " * @remarks", " * Specifies that this HUD element should be reset to its", " * default state (while most HUD elements are visible, some HUD", " * elements can be hidden by the player via settings.)", " *", " */", " Reset = 1,", "}", "/**", " * Input permission categories. Used by", " * @minecraft/server.PlayerInputPermissionCategoryChangeAfterEvent", " * to specify which category was changed.", " */", "export enum InputPermissionCategory {", " /**", " * @remarks", " * Player input relating to camera movement.", " *", " */", " Camera = 1,", " /**", " * @remarks", " * Player input relating to movement.", " *", " */", " Movement = 2,", "}", "/**", " * The types of item components that are accessible via", " * function ItemStack.getComponent.", " */", "export enum ItemComponentTypes {", " /**", " * @remarks", " * The minecraft:cooldown component.", " *", " */", " Cooldown = 'minecraft:cooldown',", " /**", " * @remarks", " * The minecraft:durability component.", " *", " */", " Durability = 'minecraft:durability',", " /**", " * @remarks", " * The minecraft:enchantable component.", " *", " */", " Enchantable = 'minecraft:enchantable',", " /**", " * @remarks", " * The minecraft:food component.", " *", " */", " Food = 'minecraft:food',", " /**", " * @beta", " */", " Potion = 'minecraft:potion',", "}", "/**", " * Describes how an an item can be moved within a container.", " */", "export enum ItemLockMode {", " /**", " * @remarks", " * The item cannot be dropped or crafted with.", " *", " */", " inventory = 'inventory',", " /**", " * @remarks", " * The item has no container restrictions.", " *", " */", " none = 'none',", " /**", " * @remarks", " * The item cannot be moved from its slot, dropped or crafted", " * with.", " *", " */", " slot = 'slot',", "}", "/**", " * Enum containing the different phases of the moon based on", " * the current day.,Obtain the current MoonPhase using", " * world.getMoonPhase.", " *", " * The fullness of the moon controls various mob behaviors such", " * as the number of slimes that spawn in Swamp biomes, the", " * chance skeletons and zombies have to spawn with armor, as", " * well as the chance for spiders to spawn with certain status", " * effects.", " */", "export enum MoonPhase {", " /**", " * @remarks", " * The brightest moon phase. During this phase, cats have a 50%", " * chance of spawning as black cats.", " *", " */", " FullMoon = 0,", " /**", " * @remarks", " * The phase following the Full Moon.", " *", " */", " WaningGibbous = 1,", " /**", " * @remarks", " * The phase following the Waxing Crescent.", " *", " */", " FirstQuarter = 2,", " /**", " * @remarks", " * The phase following the Last Quarter.", " *", " */", " WaningCrescent = 3,", " /**", " * @remarks", " * The darkest moon phase.", " *", " */", " NewMoon = 4,", " /**", " * @remarks", " * The phase following the New Moon.", " *", " */", " WaxingCrescent = 5,", " /**", " * @remarks", " * The phase following the Waning Gibbous.", " *", " */", " LastQuarter = 6,", " /**", " * @remarks", " * The phase following the First Quarter.", " *", " */", " WaxingGibbous = 7,", "}", "/**", " * Used for specifying a sort order for how to display an", " * objective and its list of participants.", " */", "export enum ObjectiveSortOrder {", " /**", " * @remarks", " * Objective participant list is displayed in ascending (e.g.,", " * A-Z) order.", " *", " */", " Ascending = 0,", " /**", " * @remarks", " * Objective participant list is displayed in descending (e.g.,", " * Z-A) order.", " *", " */", " Descending = 1,", "}", "/**", " * Enum containing colors to be used with EntityColorComponent", " * and EntityColor2Component", " */", "export enum PaletteColor {", " /**", " * @remarks", " * Hex color #f0f0f0", " *", " */", " White = 0,", " /**", " * @remarks", " * Hex color #F9801D", " *", " */", " Orange = 1,", " /**", " * @remarks", " * Hex color #C74EBD", " *", " */", " Magenta = 2,", " /**", " * @remarks", " * Hex color #3AB3DA", " *", " */", " LightBlue = 3,", " /**", " * @remarks", " * Hex color #FED83D", " *", " */", " Yellow = 4,", " /**", " * @remarks", " * Hex color #80C71F", " *", " */", " Lime = 5,", " /**", " * @remarks", " * Hex color #F38BAA", " *", " */", " Pink = 6,", " /**", " * @remarks", " * Hex color #474F52", " *", " */", " Gray = 7,", " /**", " * @remarks", " * Hex color #9D9D97", " *", " */", " Silver = 8,", " /**", " * @remarks", " * Hex color #169C9C", " *", " */", " Cyan = 9,", " /**", " * @remarks", " * Hex color #8932B8", " *", " */", " Purple = 10,", " /**", " * @remarks", " * Hex color #3C44AA", " *", " */", " Blue = 11,", " /**", " * @remarks", " * Hex color #835432", " *", " */", " Brown = 12,", " /**", " * @remarks", " * Hex color #5E7C16", " *", " */", " Green = 13,", " /**", " * @remarks", " * Hex color #B02E26", " *", " */", " Red = 14,", " /**", " * @remarks", " * Hex color #1D1D21", " *", " */", " Black = 15,", "}", "/**", " * Contains objectives and participants for the scoreboard.", " */", "export enum ScoreboardIdentityType {", " /**", " * @remarks", " * This scoreboard participant is tied to an entity.", " *", " */", " Entity = 'Entity',", " /**", " * @remarks", " * This scoreboard participant is tied to a pseudo player", " * entity - typically this is used to store scores as data or", " * as abstract progress.", " *", " */", " FakePlayer = 'FakePlayer',", " /**", " * @remarks", " * This scoreboard participant is tied to a player.", " *", " */", " Player = 'Player',", "}", "/**", " * Describes where the script event originated from.", " */", "export enum ScriptEventSource {", " /**", " * @remarks", " * The script event originated from a Block such as a Command", " * Block.", " *", " */", " Block = 'Block',", " /**", " * @remarks", " * The script event originated from an Entity such as a Player,", " * Command Block Minecart or Animation Controller.", " *", " */", " Entity = 'Entity',", " /**", " * @remarks", " * The script event originated from an NPC dialogue.", " *", " */", " NPCDialogue = 'NPCDialogue',", " /**", " * @remarks", " * The script event originated from the server, such as from a", " * runCommand API call or a dedicated server console.", " *", " */", " Server = 'Server',", "}", "/**", " * Represents a side of a sign.", " */", "export enum SignSide {", " /**", " * @remarks", " * The back of the sign.", " *", " */", " Back = 'Back',", " /**", " * @remarks", " * The front of the sign.", " *", " */", " Front = 'Front',", "}", "/**", " * Specifies how structure blocks should be animated when a", " * structure is placed.", " */", "export enum StructureAnimationMode {", " /**", " * @remarks", " * Blocks will be randomly placed one at at time. Use", " * @minecraft/server.StructurePlaceOptions.animationSeconds to", " * control how long it t