Script API - v1.21.80
    Preparing search index...

    Module @minecraft/server - v1.19.0

    Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.

    Manifest Details

    {
    "module_name": "@minecraft/server",
    "version": "1.19.0"
    }

    @minecraft/common (Optional in Manifest Details)

    • Requires v1.1.0 or above
    {
    "module_name": "@minecraft/common",
    "version": "1.1.0"
    }

    Install type definition for @minecraft/server module using npm:

    npm i @minecraft/server@1.19.0
    

    Enumerations

    BlockComponentTypes
    BlockPistonState
    BlockVolumeIntersection
    ButtonState
    CustomComponentNameErrorReason
    Difficulty
    Direction
    DisplaySlotId
    DyeColor
    EasingType
    EnchantmentSlot
    EntityComponentTypes
    EntityDamageCause
    EntityInitializationCause
    EquipmentSlot
    FluidType
    GameMode
    GameRule
    HudElement
    HudVisibility
    InputButton
    InputMode
    InputPermissionCategory
    ItemComponentTypes
    ItemLockMode
    LiquidType
    MemoryTier
    MoonPhase
    NamespaceNameErrorReason
    ObjectiveSortOrder
    PaletteColor
    PlatformType
    ScoreboardIdentityType
    ScriptEventSource
    SignSide
    StructureAnimationMode
    StructureMirrorAxis
    StructureRotation
    StructureSaveMode
    TimeOfDay
    WeatherType

    Classes

    Block
    BlockComponent
    BlockComponentEntityFallOnEvent
    BlockComponentOnPlaceEvent
    BlockComponentPlayerDestroyEvent
    BlockComponentPlayerInteractEvent
    BlockComponentPlayerPlaceBeforeEvent
    BlockComponentRandomTickEvent
    BlockComponentRegistry
    BlockComponentStepOffEvent
    BlockComponentStepOnEvent
    BlockComponentTickEvent
    BlockCustomComponentAlreadyRegisteredError
    BlockCustomComponentReloadNewComponentError
    BlockCustomComponentReloadNewEventError
    BlockCustomComponentReloadVersionError
    BlockEvent
    BlockExplodeAfterEvent
    BlockExplodeAfterEventSignal
    BlockFluidContainerComponent
    BlockInventoryComponent
    BlockLocationIterator
    BlockPermutation
    BlockPistonComponent
    BlockRecordPlayerComponent
    BlockSignComponent
    BlockStates
    BlockStateType
    BlockType
    BlockTypes
    BlockVolume
    BlockVolumeBase
    ButtonPushAfterEvent
    ButtonPushAfterEventSignal
    Camera
    ClientSystemInfo
    CommandError
    CommandResult
    Component
    Container
    ContainerSlot
    CustomComponentInvalidRegistryError
    CustomComponentNameError
    DataDrivenEntityTriggerAfterEvent
    DataDrivenEntityTriggerAfterEventSignal
    Dimension
    DimensionType
    DimensionTypes
    Effect
    EffectAddAfterEvent
    EffectAddAfterEventSignal
    EffectAddBeforeEvent
    EffectAddBeforeEventSignal
    EffectType
    EffectTypes
    EnchantmentLevelOutOfBoundsError
    EnchantmentType
    EnchantmentTypeNotCompatibleError
    EnchantmentTypes
    EnchantmentTypeUnknownIdError
    Entity
    EntityAddRiderComponent
    EntityAgeableComponent
    EntityAttributeComponent
    EntityBaseMovementComponent
    EntityBreathableComponent
    EntityCanClimbComponent
    EntityCanFlyComponent
    EntityCanPowerJumpComponent
    EntityColor2Component
    EntityColorComponent
    EntityComponent
    EntityDefinitionFeedItem
    EntityDieAfterEvent
    EntityDieAfterEventSignal
    EntityEquippableComponent
    EntityFireImmuneComponent
    EntityFloatsInLiquidComponent
    EntityFlyingSpeedComponent
    EntityFrictionModifierComponent
    EntityGroundOffsetComponent
    EntityHealableComponent
    EntityHealthChangedAfterEvent
    EntityHealthChangedAfterEventSignal
    EntityHealthComponent
    EntityHitBlockAfterEvent
    EntityHitBlockAfterEventSignal
    EntityHitEntityAfterEvent
    EntityHitEntityAfterEventSignal
    EntityHurtAfterEvent
    EntityHurtAfterEventSignal
    EntityInventoryComponent
    EntityIsBabyComponent
    EntityIsChargedComponent
    EntityIsChestedComponent
    EntityIsDyeableComponent
    EntityIsHiddenWhenInvisibleComponent
    EntityIsIgnitedComponent
    EntityIsIllagerCaptainComponent
    EntityIsSaddledComponent
    EntityIsShakingComponent
    EntityIsShearedComponent
    EntityIsStackableComponent
    EntityIsStunnedComponent
    EntityIsTamedComponent
    EntityItemComponent
    EntityLavaMovementComponent
    EntityLeashableComponent
    EntityLoadAfterEvent
    EntityLoadAfterEventSignal
    EntityMarkVariantComponent
    EntityMovementAmphibiousComponent
    EntityMovementBasicComponent
    EntityMovementComponent
    EntityMovementFlyComponent
    EntityMovementGenericComponent
    EntityMovementGlideComponent
    EntityMovementHoverComponent
    EntityMovementJumpComponent
    EntityMovementSkipComponent
    EntityMovementSwayComponent
    EntityNavigationClimbComponent
    EntityNavigationComponent
    EntityNavigationFloatComponent
    EntityNavigationFlyComponent
    EntityNavigationGenericComponent
    EntityNavigationHoverComponent
    EntityNavigationWalkComponent
    EntityOnFireComponent
    EntityProjectileComponent
    EntityPushThroughComponent
    EntityRemoveAfterEvent
    EntityRemoveAfterEventSignal
    EntityRemoveBeforeEvent
    EntityRemoveBeforeEventSignal
    EntityRideableComponent
    EntityRidingComponent
    EntityScaleComponent
    EntitySkinIdComponent
    EntitySpawnAfterEvent
    EntitySpawnAfterEventSignal
    EntityStrengthComponent
    EntityTameableComponent
    EntityTameMountComponent
    EntityType
    EntityTypeFamilyComponent
    EntityTypes
    EntityUnderwaterMovementComponent
    EntityVariantComponent
    EntityWantsJockeyComponent
    ExplosionAfterEvent
    ExplosionAfterEventSignal
    ExplosionBeforeEvent
    ExplosionBeforeEventSignal
    FeedItem
    FeedItemEffect
    FluidContainer
    GameRuleChangeAfterEvent
    GameRuleChangeAfterEventSignal
    GameRules
    IButtonPushAfterEventSignal
    ILeverActionAfterEventSignal
    InputInfo
    InvalidContainerSlotError
    InvalidEntityError
    InvalidIteratorError
    InvalidStructureError
    IPlayerJoinAfterEventSignal
    IPlayerLeaveAfterEventSignal
    IPlayerSpawnAfterEventSignal
    ItemCompleteUseAfterEvent
    ItemCompleteUseAfterEventSignal
    ItemCompleteUseEvent
    ItemComponent
    ItemComponentBeforeDurabilityDamageEvent
    ItemComponentCompleteUseEvent
    ItemComponentConsumeEvent
    ItemComponentHitEntityEvent
    ItemComponentMineBlockEvent
    ItemComponentRegistry
    ItemComponentUseEvent
    ItemComponentUseOnEvent
    ItemCompostableComponent
    ItemCooldownComponent
    ItemCustomComponentAlreadyRegisteredError
    ItemCustomComponentReloadNewComponentError
    ItemCustomComponentReloadNewEventError
    ItemCustomComponentReloadVersionError
    ItemDurabilityComponent
    ItemEnchantableComponent
    ItemFoodComponent
    ItemReleaseUseAfterEvent
    ItemReleaseUseAfterEventSignal
    ItemStack
    ItemStartUseAfterEvent
    ItemStartUseAfterEventSignal
    ItemStartUseOnAfterEvent
    ItemStartUseOnAfterEventSignal
    ItemStopUseAfterEvent
    ItemStopUseAfterEventSignal
    ItemStopUseOnAfterEvent
    ItemStopUseOnAfterEventSignal
    ItemType
    ItemTypes
    ItemUseAfterEvent
    ItemUseAfterEventSignal
    ItemUseBeforeEvent
    ItemUseBeforeEventSignal
    ItemUseOnAfterEvent
    ItemUseOnAfterEventSignal
    ItemUseOnBeforeEvent
    ItemUseOnBeforeEventSignal
    ItemUseOnEvent
    LeverActionAfterEvent
    LeverActionAfterEventSignal
    ListBlockVolume
    LocationInUnloadedChunkError
    LocationOutOfWorldBoundariesError
    MinecraftDimensionTypes
    MolangVariableMap
    NamespaceNameError
    PistonActivateAfterEvent
    PistonActivateAfterEventSignal
    PlaceJigsawError
    Player
    PlayerBreakBlockAfterEvent
    PlayerBreakBlockAfterEventSignal
    PlayerBreakBlockBeforeEvent
    PlayerBreakBlockBeforeEventSignal
    PlayerButtonInputAfterEvent
    PlayerButtonInputAfterEventSignal
    PlayerCursorInventoryComponent
    PlayerDimensionChangeAfterEvent
    PlayerDimensionChangeAfterEventSignal
    PlayerEmoteAfterEvent
    PlayerEmoteAfterEventSignal
    PlayerGameModeChangeAfterEvent
    PlayerGameModeChangeAfterEventSignal
    PlayerGameModeChangeBeforeEvent
    PlayerGameModeChangeBeforeEventSignal
    PlayerInputModeChangeAfterEvent
    PlayerInputModeChangeAfterEventSignal
    PlayerInputPermissionCategoryChangeAfterEvent
    PlayerInputPermissionCategoryChangeAfterEventSignal
    PlayerInputPermissions
    PlayerInteractWithBlockAfterEvent
    PlayerInteractWithBlockAfterEventSignal
    PlayerInteractWithBlockBeforeEvent
    PlayerInteractWithBlockBeforeEventSignal
    PlayerInteractWithEntityAfterEvent
    PlayerInteractWithEntityAfterEventSignal
    PlayerInteractWithEntityBeforeEvent
    PlayerInteractWithEntityBeforeEventSignal
    PlayerJoinAfterEvent
    PlayerJoinAfterEventSignal
    PlayerLeaveAfterEvent
    PlayerLeaveAfterEventSignal
    PlayerLeaveBeforeEvent
    PlayerLeaveBeforeEventSignal
    PlayerPlaceBlockAfterEvent
    PlayerPlaceBlockAfterEventSignal
    PlayerSpawnAfterEvent
    PlayerSpawnAfterEventSignal
    PressurePlatePopAfterEvent
    PressurePlatePopAfterEventSignal
    PressurePlatePushAfterEvent
    PressurePlatePushAfterEventSignal
    ProjectileHitBlockAfterEvent
    ProjectileHitBlockAfterEventSignal
    ProjectileHitEntityAfterEvent
    ProjectileHitEntityAfterEventSignal
    RawMessageError
    Scoreboard
    ScoreboardIdentity
    ScoreboardObjective
    ScoreboardScoreInfo
    ScreenDisplay
    ScriptEventCommandMessageAfterEvent
    ScriptEventCommandMessageAfterEventSignal
    Seat
    Structure
    StructureManager
    System
    SystemAfterEvents
    SystemInfo
    TargetBlockHitAfterEvent
    TargetBlockHitAfterEventSignal
    Trigger
    TripWireTripAfterEvent
    TripWireTripAfterEventSignal
    UnloadedChunksError
    WeatherChangeAfterEvent
    WeatherChangeAfterEventSignal
    WeatherChangeBeforeEvent
    WeatherChangeBeforeEventSignal
    World
    WorldAfterEvents
    WorldBeforeEvents
    WorldInitializeAfterEvent
    WorldInitializeAfterEventSignal
    WorldInitializeBeforeEvent
    WorldInitializeBeforeEventSignal

    Interfaces

    BlockBoundingBox
    BlockCustomComponent
    BlockEventOptions
    BlockFillOptions
    BlockFilter
    BlockHitInformation
    BlockRaycastHit
    BlockRaycastOptions
    CameraDefaultOptions
    CameraEaseOptions
    CameraFadeOptions
    CameraFadeTimeOptions
    CameraFixedBoomOptions
    CameraSetFacingOptions
    CameraSetLocationOptions
    CameraSetPosOptions
    CameraSetRotOptions
    CameraTargetOptions
    DefinitionModifier
    DimensionLocation
    Enchantment
    EntityApplyDamageByProjectileOptions
    EntityApplyDamageOptions
    EntityDamageSource
    EntityDataDrivenTriggerEventOptions
    EntityEffectOptions
    EntityEventOptions
    EntityFilter
    EntityHitInformation
    EntityQueryOptions
    EntityQueryPropertyOptions
    EntityQueryScoreOptions
    EntityRaycastHit
    EntityRaycastOptions
    EqualsComparison
    ExplosionOptions
    GreaterThanComparison
    GreaterThanOrEqualsComparison
    InputEventOptions
    ItemCustomComponent
    JigsawPlaceOptions
    JigsawStructurePlaceOptions
    LessThanComparison
    LessThanOrEqualsComparison
    MusicOptions
    NotEqualsComparison
    PlayAnimationOptions
    PlayerSoundOptions
    ProjectileShootOptions
    RangeComparison
    RawMessage
    RawMessageScore
    RawText
    RGB
    RGBA
    ScoreboardObjectiveDisplayOptions
    ScriptEventMessageFilterOptions
    StructureCreateOptions
    StructurePlaceOptions
    TeleportOptions
    TitleDisplayOptions
    Vector2
    Vector3
    VectorXZ
    WorldSoundOptions

    Type Aliases

    BlockComponentReturnType
    BlockComponentTypeMap
    BlockStateArg
    EntityComponentReturnType
    EntityComponentTypeMap
    ItemComponentReturnType
    ItemComponentTypeMap

    Variables

    HudElementsCount
    HudVisibilityCount
    MoonPhaseCount
    system
    TicksPerSecond
    world