SoulFire LogoSoulFire

SoulFireWorld

Public Python members of SoulFireWorld.

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.

player

@fn("SoulFireWorld.player")
def player(
    self, *, timeout_ms: int | None = None
) -> EffectGen[PlayerSnapshot, SoulFireOperationError]

Source

block

@fn("SoulFireWorld.block")
def block(
    self,
    position: BlockPosition,
    *,
    include_block_entity: bool = False,
    include_shapes: bool = False,
    timeout_ms: int | None = None,
) -> EffectGen[GetWorldBlockResponse, SoulFireOperationError]

Source

query_blocks

@fn("SoulFireWorld.query_blocks")
def query_blocks(
    self,
    region: QueryRegion,
    selector: BlockSelector,
    *,
    sort: QuerySort = QUERY_SORT_UNSPECIFIED,
    page_size: int = 0,
    page_token: str = "",
    timeout_ms: int | None = None,
) -> EffectGen[QueryBlocksResponse, SoulFireOperationError]

Source

entity

@fn("SoulFireWorld.entity")
def entity(
    self, reference: EntityReference, *, timeout_ms: int | None = None
) -> EffectGen[GetWorldEntityResponse, SoulFireOperationError]

Source

query_entities

@fn("SoulFireWorld.query_entities")
def query_entities(
    self,
    radius: float,
    selector: EntitySelector,
    *,
    origin: WorldPosition | None = None,
    sort: QuerySort = QUERY_SORT_UNSPECIFIED,
    page_size: int = 0,
    page_token: str = "",
    timeout_ms: int | None = None,
) -> EffectGen[QueryEntitiesResponse, SoulFireOperationError]

Source

raycast

@fn("SoulFireWorld.raycast")
def raycast(
    self,
    origin: WorldPosition,
    direction: Vec3,
    maximum_distance: float,
    *,
    include_fluids: bool = False,
    include_entities: bool = True,
    timeout_ms: int | None = None,
) -> EffectGen[RaycastResponse, SoulFireOperationError]

Source

raycast_from_player

@fn("SoulFireWorld.raycast_from_player")
def raycast_from_player(
    self,
    maximum_distance: float = 6,
    *,
    include_fluids: bool = False,
    include_entities: bool = True,
    timeout_ms: int | None = None,
) -> EffectGen[RaycastResponse, SoulFireOperationError]

Source

block_at_cursor

@fn("SoulFireWorld.block_at_cursor")
def block_at_cursor(
    self, maximum_distance: float = 256, *, timeout_ms: int | None = None
) -> EffectGen[BlockSnapshot | None, SoulFireOperationError]

Source

entity_at_cursor

@fn("SoulFireWorld.entity_at_cursor")
def entity_at_cursor(
    self, maximum_distance: float = 3.5, *, timeout_ms: int | None = None
) -> EffectGen[EntitySnapshot | None, SoulFireOperationError]

Source

estimate_explosion_damage

@fn("SoulFireWorld.estimate_explosion_damage")
def estimate_explosion_damage(
    self,
    target: EntityReference,
    center: WorldPosition,
    power: float,
    *,
    timeout_ms: int | None = None,
) -> EffectGen[EstimateExplosionDamageResponse, SoulFireOperationError]

Source

can_see_block

@fn("SoulFireWorld.can_see_block")
def can_see_block(
    self, position: BlockPosition, *, timeout_ms: int | None = None
) -> EffectGen[CanSeeBlockResponse, SoulFireOperationError]

Source

estimate_dig_time

@fn("SoulFireWorld.estimate_dig_time")
def estimate_dig_time(
    self, position: BlockPosition, *, timeout_ms: int | None = None
) -> EffectGen[EstimateDigTimeResponse, SoulFireOperationError]

Source

How is this page?

Last updated on

On this page