# QuestScript Python API — Preview fixture (not supported)

This reference is generated from `types.pyi`. Public member names use the
`snake_case` Python projection of QuestScript's shared semantic API.

## Classes

- [BlockVolume](classes/BlockVolume.md) — Immutable inclusive block volume.
- [ItemStack](classes/ItemStack.md) — A detached, mutable item stack value owned by QuestScript.

## Protocols

- [Block](protocols/Block.md) — A live block at a fixed location in a dimension.
- [BlockFillOperation](protocols/BlockFillOperation.md) — A cooperative block-fill operation.
- [BlockPermutation](protocols/BlockPermutation.md) — An immutable detached block type and its complete registered state values.
- [BlockStates](protocols/BlockStates.md) — Bounded catalog of Java Edition block property definitions.
- [BlockStateType](protocols/BlockStateType.md) — An immutable QuestScript-owned block-state definition.
- [BlockType](protocols/BlockType.md) — An immutable QuestScript-owned block type value.
- [BlockTypes](protocols/BlockTypes.md) — Bounded catalog of registered block types.
- [BlockVector3](protocols/BlockVector3.md) — A mutable numeric vector produced from an integer block position.
- [BrokenBlockPermutation](protocols/BrokenBlockPermutation.md) — Block permutation captured for a block-break event.
- [BulkOperation](protocols/BulkOperation.md) — Cancelable Script-owned handle for cooperative bounded work.
- [BulkOperationCompletion](protocols/BulkOperationCompletion.md) — Immutable terminal outcome for one bounded bulk operation.
- [BulkOperationProgress](protocols/BulkOperationProgress.md) — Immutable progress snapshot for one bounded bulk operation.
- [CapabilityDeniedError](protocols/CapabilityDeniedError.md) — Stable catchable error raised when a Script operation lacks effective capability authority.
- [Dimension](protocols/Dimension.md) — A live Minecraft dimension exposed through a QuestScript-owned facade.
- [Entity](protocols/Entity.md) — A live Minecraft entity exposed through a QuestScript-owned facade.
- [EntityHurtBeforeEvent](protocols/EntityHurtBeforeEvent.md) — Cancelable event fired before damage is applied to an entity.
- [EntityHurtBeforeEventSignal](protocols/EntityHurtBeforeEventSignal.md)
- [Equipment](protocols/Equipment.md) — Mutable equipment slots of one player.
- [FillBlocksResult](protocols/FillBlocksResult.md) — Temporary bounded result for synchronous block fill until ListBlockVolume is implemented.
- [InventoryLease](protocols/InventoryLease.md) — Recoverable ownership of one player's temporary inventory replacement.
- [InventoryLeaseRegistry](protocols/InventoryLeaseRegistry.md) — Registry of unfinished inventory leases owned by the current Script.
- [InventorySnapshot](protocols/InventorySnapshot.md) — Detached player inventory state captured by `PlayerInventory.capture`.
- [LegacyBlockResult](protocols/LegacyBlockResult.md) — Deprecated synchronous result returned by `minecraft.get_block`.
- [LegacyGameRules](protocols/LegacyGameRules.md)
- [Minecraft](protocols/Minecraft.md) — Deprecated pre-release Minecraft API object.
- [Player](protocols/Player.md) — A live server player with inventory and messaging APIs.
- [PlayerBreakBlockAfterEvent](protocols/PlayerBreakBlockAfterEvent.md) — Event fired after a player successfully breaks a block.
- [PlayerBreakBlockAfterEventSignal](protocols/PlayerBreakBlockAfterEventSignal.md)
- [PlayerBreakBlockBeforeEvent](protocols/PlayerBreakBlockBeforeEvent.md) — Cancelable event fired before a player breaks a block.
- [PlayerBreakBlockBeforeEventSignal](protocols/PlayerBreakBlockBeforeEventSignal.md)
- [PlayerInventory](protocols/PlayerInventory.md) — Mutable main inventory of one player.
- [PlayerJoinAfterEvent](protocols/PlayerJoinAfterEvent.md) — Event fired after a player becomes available to the server.
- [PlayerJoinAfterEventSignal](protocols/PlayerJoinAfterEventSignal.md)
- [PlayerLeaveAfterEvent](protocols/PlayerLeaveAfterEvent.md) — Event fired after a player leaves the server.
- [PlayerLeaveAfterEventSignal](protocols/PlayerLeaveAfterEventSignal.md)
- [QuotaExceededError](protocols/QuotaExceededError.md) — Stable catchable error raised before a Script operation exceeds its effective resource quota.
- [RunCommandResult](protocols/RunCommandResult.md) — Result of an administrative command execution.
- [ScriptCapabilities](protocols/ScriptCapabilities.md) — Read-only effective capability view for the current Script Run.
- [ScriptEventReceiveEvent](protocols/ScriptEventReceiveEvent.md) — Data delivered for one received `/scriptevent` message.
- [ScriptEventReceiveEventSignal](protocols/ScriptEventReceiveEventSignal.md)
- [ScriptExports](protocols/ScriptExports.md) — Frozen callable registry published by one exact loaded Script Run.
- [ScriptHost](protocols/ScriptHost.md) — Global used to publish callables for other Scripts.
- [ScriptLimits](protocols/ScriptLimits.md) — Read-only effective security-limit view for the current Script Run.
- [ScriptStorage](protocols/ScriptStorage.md) — Persistent storage bounded by questscript:max_storage_keys, max_storage_key_bytes, max_storage_string_bytes, max_storage_value_depth, max_storage_collection_entries, max_storage_value_bytes, and max_storage_bytes.
- [ScriptUnloadBeforeEvent](protocols/ScriptUnloadBeforeEvent.md) — Data supplied to the final synchronous Script unload event.
- [ScriptUnloadBeforeEventSignal](protocols/ScriptUnloadBeforeEventSignal.md)
- [System](protocols/System.md) — Scheduler in QuestScript's final server-thread scripting phase.
- [SystemAfterEvents](protocols/SystemAfterEvents.md) — Observational system event streams.
- [SystemBeforeEvents](protocols/SystemBeforeEvents.md) — Synchronous lifecycle events fired before teardown completes.
- [TriggerEntityEvent](protocols/TriggerEntityEvent.md) — Player membership change emitted by a trigger volume.
- [TriggerSignal](protocols/TriggerSignal.md) — Subscription surface for one trigger-volume event kind.
- [TriggerTickEvent](protocols/TriggerTickEvent.md) — Periodic membership snapshot emitted by a trigger volume.
- [TriggerVolume](protocols/TriggerVolume.md) — A Script-Owned, tick-sampled trigger over an inclusive block volume.
- [TriggerVolumeAfterEvents](protocols/TriggerVolumeAfterEvents.md) — Event streams emitted by a trigger volume.
- [Vector3](protocols/Vector3.md) — A three-dimensional coordinate or direction.
- [World](protocols/World.md) — Main QuestScript-owned entry point for world access and Script state.
- [WorldAfterEvents](protocols/WorldAfterEvents.md) — Observational world event streams fired after their actions.
- [WorldBeforeEvents](protocols/WorldBeforeEvents.md) — Synchronous, cancelable world event streams.

## Typed Dictionaries

- [EntityQueryOptions](typed-dicts/EntityQueryOptions.md) — Filters supported by entity and player queries.
- [FillBlocksAsyncOptions](typed-dicts/FillBlocksAsyncOptions.md) — Limits applied to one cooperative fill operation.
- [FillBlocksOptions](typed-dicts/FillBlocksOptions.md) — Limits applied to one synchronous fill operation.
- [InventoryLeaseOptions](typed-dicts/InventoryLeaseOptions.md) — Options for a temporary inventory replacement lease.
- [InventoryLoadout](typed-dicts/InventoryLoadout.md) — Player inventory, equipment, and selected slot applied as one loadout.
- [InventorySnapshotOptions](typed-dicts/InventorySnapshotOptions.md) — Selects optional player state captured in an inventory snapshot.
- [ScriptEventOptions](typed-dicts/ScriptEventOptions.md) — Filters applied to a Script Event subscription.
- [ScriptExportOptions](typed-dicts/ScriptExportOptions.md) — Metadata attached to an explicitly registered Script Export.
- [TeleportOptions](typed-dicts/TeleportOptions.md) — Options that control an entity teleport.
- [TriggerVolumeOptions](typed-dicts/TriggerVolumeOptions.md) — Options used to create a Script-Owned trigger volume.
- [Vector3Mapping](typed-dicts/Vector3Mapping.md) — Mapping form of a three-dimensional coordinate.

## Type Aliases

- [BlockStateValue](type-aliases/BlockStateValue.md) — A boolean, integer, or enum-like string stored by a block-state property.
- [DamageCause](type-aliases/DamageCause.md) — A normalized cause reported by the current entity-hurt event surface.
- [DataValue](type-aliases/DataValue.md) — A non-null value that Script Storage and item data can persist.
- [DimensionInput](type-aliases/DimensionInput.md)
- [EntityOrLocationInput](type-aliases/EntityOrLocationInput.md)
- [EquipmentSlot](type-aliases/EquipmentSlot.md) — An equipment slot exposed by the QuestScript equipment facade.
- [GameMode](type-aliases/GameMode.md) — A player game mode understood by Java Edition.
- [InventoryLeaseState](type-aliases/InventoryLeaseState.md) — Lifecycle state of a temporary inventory lease.
- [InventoryLeaseUnloadPolicy](type-aliases/InventoryLeaseUnloadPolicy.md) — Action taken for an unfinished inventory lease when its Script unloads.
- [ScriptEventId](type-aliases/ScriptEventId.md) — Explicit author-chosen `<namespace>:<path>` Script Event message ID.
- [ScriptEventSource](type-aliases/ScriptEventSource.md)
- [ScriptExportDeprecation](type-aliases/ScriptExportDeprecation.md)
- [ScriptUnloadReason](type-aliases/ScriptUnloadReason.md) — Reason supplied during one Script Run's synchronous unload phase.
- [Vector3Dto](type-aliases/Vector3Dto.md)
- [Vector3Like](type-aliases/Vector3Like.md) — A vector facade, vector-shaped mapping, or three-element tuple.

## Variables

- [import_script](variables/import_script.md) — Return the frozen exports of an already loaded Script.
- [minecraft](variables/minecraft.md) — Deprecated low-level Minecraft API object.
- [script](variables/script.md) — Explicit cross-Script export registrar for the current Script Run.
- [system](variables/system.md) — Tick scheduling and system events for the current Script Run.
- [world](variables/world.md) — Main QuestScript-owned world API for the current Script Run.