player_actions API

完整接口目录 · 玩家查询用法 · 工具包下载

模块说明

Exact-name Bedrock convenience intents over the native command gate.

PlayerActions

class PlayerActions

SDK 说明：

Prepare only; submit and inspect the original receipt with Operations.

Requires the broad framework.command.execute permission. Exact player names
are execution-time selectors, not durable UUID bindings or online checks.
Each call needs a caller-owned key and fixed deadline. No automatic retry,
command-feedback changes, permission grants, or synthetic success results.

PlayerActions.__init__

def __init__(self, operations: Operations)

PlayerActions.teleport

def teleport(
    self,
    name: str,
    position,
    *,
    idempotency_key: str,
    deadline: str,
    rotation = None,
    check_for_blocks: bool = False,
) -> OperationIntent

SDK 说明：

Absolute coordinates in the command executor's dimension; yaw, pitch optional.

PlayerActions.teleport_to

def teleport_to(
    self,
    name: str,
    destination_name: str,
    *,
    idempotency_key: str,
    deadline: str,
    check_for_blocks: bool = False,
) -> OperationIntent

SDK 说明：

Teleport to another exact-name player, resolved by the server at execution.

PlayerActions.give

def give(
    self,
    name: str,
    item: str,
    *,
    idempotency_key: str,
    deadline: str,
    count: int = 1,
    data: int = 0,
) -> OperationIntent

SDK 说明：

Give a basic item. Custom NBT belongs to the existing World item helpers.

PlayerActions.clear

def clear(
    self,
    name: str,
    item: str | None = None,
    *,
    idempotency_key: str,
    deadline: str,
    data: int = -1,
    max_count: int = -1,
) -> OperationIntent

SDK 说明：

Omit item to clear the entire inventory; max_count=0 only tests matches.

PlayerActions.effect

def effect(
    self,
    name: str,
    effect: str,
    *,
    idempotency_key: str,
    deadline: str,
    seconds: int = 30,
    amplifier: int = 0,
    hide_particles: bool = False,
) -> OperationIntent

SDK 说明：

Timed effect; seconds=0 removes that effect using the older Bedrock form.

PlayerActions.clear_effect

def clear_effect(
    self,
    name: str,
    effect: str | None = None,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

SDK 说明：

Clear all effects, or one effect via a zero-second application.

PlayerActions.gamemode

def gamemode(
    self,
    name: str,
    mode: str,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

PlayerActions.tag_add

def tag_add(
    self,
    name: str,
    tag: str,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

PlayerActions.tag_remove

def tag_remove(
    self,
    name: str,
    tag: str,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

PlayerActions.tag_list

def tag_list(self, name: str, *, idempotency_key: str, deadline: str) -> OperationIntent

SDK 说明：

Keep native output messages; no locale-dependent tag-list parsing.

PlayerActions.tag_test

def tag_test(
    self,
    name: str,
    tag: str,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

SDK 说明：

Test exact-name + tag via testfor. No match can also mean player offline.

PlayerActions.playsound

def playsound(
    self,
    name: str,
    sound: str,
    *,
    idempotency_key: str,
    deadline: str,
    position = None,
    volume: float = 1,
    pitch: float = 1,
    minimum_volume: float = 0,
) -> OperationIntent

SDK 说明：

Play at the target's current position/dimension unless an absolute position is supplied.

PlayerActions.stopsound

def stopsound(
    self,
    name: str,
    sound: str | None = None,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

SDK 说明：

Omit sound to stop every sound for the target.

PlayerActions.kick

def kick(
    self,
    name: str,
    reason: str,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

PlayerActions.xp

def xp(
    self,
    name: str,
    points: int,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

SDK 说明：

Add nonnegative experience points (not levels).

PlayerActions.spawnpoint

def spawnpoint(
    self,
    name: str,
    position,
    *,
    idempotency_key: str,
    deadline: str,
) -> OperationIntent

SDK 说明：

Set an absolute respawn position in the command executor's dimension.

PlayerActions.operations

self.operations

公开实例属性，在 __init__ 中设置。

PlayerActions.commands

self.commands

公开实例属性，在 __init__ 中设置。