Python API reference

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

Classes

• BlockVolume — Immutable inclusive block volume.
• ItemStack — A detached, mutable item stack value owned by QuestScript.

Protocols

• Block — A live block at a fixed location in a dimension.
• BlockVector3 — A mutable numeric vector produced from an integer block position.
• BrokenBlockPermutation — Block permutation captured for a block-break event.
• Dimension — A live Minecraft dimension exposed through a QuestScript-owned facade.
• Entity — A live Minecraft entity exposed through a QuestScript-owned facade.
• EntityHurtBeforeEvent — Cancelable event fired before damage is applied to an entity.
• EntityHurtBeforeEventSignal
• Equipment — Mutable equipment slots of one player.
• FillBlocksResult — Result of a bounded block fill.
• InventoryLease — Recoverable ownership of one player's temporary inventory replacement.
• InventoryLeaseRegistry — Registry of unfinished inventory leases owned by the current Script.
• InventorySnapshot — Detached player inventory state captured by PlayerInventory.capture.
• ItemStackData — Serializable, typed snapshot accepted by ItemStack.from_data.
• LegacyBlockResult — Deprecated synchronous result returned by minecraft.get_block.
• LegacyGameRules
• LegacyPlayerBreakBlockAfterEvent
• LegacyPlayerBreakBlockAfterEventSignal
• LegacyPlayerBreakBlockBeforeEvent
• LegacyPlayerBreakBlockBeforeEventSignal
• Minecraft — Deprecated pre-release Minecraft API object.
• MinecraftAfterEvents
• MinecraftBeforeEvents
• Player — A live server player with inventory and messaging APIs.
• PlayerBreakBlockAfterEvent — Event fired after a player successfully breaks a block.
• PlayerBreakBlockAfterEventSignal
• PlayerBreakBlockBeforeEvent — Cancelable event fired before a player breaks a block.
• PlayerBreakBlockBeforeEventSignal
• PlayerInventory — Mutable main inventory of one player.
• PlayerJoinAfterEvent — Event fired after a player becomes available to the server.
• PlayerJoinAfterEventSignal
• PlayerLeaveAfterEvent — Event fired after a player leaves the server.
• PlayerLeaveAfterEventSignal
• RunCommandResult — Result of an administrative command execution.
• ScriptEventReceiveEvent — Data delivered for one received /scriptevent message.
• ScriptEventReceiveEventSignal
• ScriptExports — Frozen callable registry published by one exact loaded Script Run.
• ScriptHost — Global used to publish callables for other Scripts.
• ScriptStorage — Persistent key-value storage scoped to the current Script identity.
• ScriptUnloadBeforeEvent — Data supplied to the final synchronous Script unload event.
• ScriptUnloadBeforeEventSignal
• System — Scheduler in QuestScript's final server-thread scripting phase.
• SystemAfterEvents — Observational system event streams.
• SystemBeforeEvents — Synchronous lifecycle events fired before teardown completes.
• TriggerEntityEvent — Player membership change emitted by a trigger volume.
• TriggerSignal — Subscription surface for one trigger-volume event kind.
• TriggerTickEvent — Periodic membership snapshot emitted by a trigger volume.
• TriggerVolume — A Script-Owned, tick-sampled trigger over an inclusive block volume.
• TriggerVolumeAfterEvents — Event streams emitted by a trigger volume.
• Vector3 — A three-dimensional coordinate or direction.
• World — Main QuestScript-owned entry point for world access and Script state.
• WorldAfterEvents — Observational world event streams fired after their actions.
• WorldBeforeEvents — Synchronous, cancelable world event streams.

Typed Dictionaries

• EntityQueryOptions — Filters supported by entity and player queries.
• FillBlocksOptions — Limits applied to one bounded fill operation.
• InventoryLeaseOptions — Options for a temporary inventory replacement lease.
• InventoryLoadout — Player inventory, equipment, and selected slot applied as one loadout.
• InventorySnapshotOptions — Selects optional player state captured in an inventory snapshot.
• ItemStackDataInput — Typed mapping form accepted by ItemStack.from_data.
• PositionDto
• ScriptEventOptions — Filters applied to a Script Event subscription.
• ScriptExportOptions — Metadata attached to an explicitly registered Script Export.
• SetBlocksOptions
• TeleportOptions — Options that control an entity teleport.
• TriggerVolumeOptions — Options used to create a Script-Owned trigger volume.
• Vector3Mapping — Mapping form of a three-dimensional coordinate.

Type Aliases

• DamageCause — A normalized cause reported by the current entity-hurt event surface.
• DataValue — A value accepted by Script Storage and item data.
• DimensionInput
• EntityOrLocationInput
• EquipmentSlot — An equipment slot exposed by the QuestScript equipment facade.
• GameMode — A player game mode understood by Java Edition.
• InventoryLeaseState — Lifecycle state of a temporary inventory lease.
• InventoryLeaseUnloadPolicy — Action taken for an unfinished inventory lease when its Script unloads.
• ScriptEventId — Explicit author-chosen <namespace>:<path> Script Event message ID.
• ScriptEventSource
• ScriptExportDeprecation
• ScriptUnloadReason — Reason supplied during one Script Run's synchronous unload phase.
• Vector3Dto
• Vector3Like — A vector facade, vector-shaped mapping, or three-element tuple.

Variables

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