soulfire.world_connect.WorldServiceSync

class soulfire.world_connect.WorldServiceSync[source]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
get_player_snapshot(request: soulfire.world_pb2.GetPlayerSnapshotRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.GetPlayerSnapshotRequest, soulfire.world_pb2.GetPlayerSnapshotResponse]) → soulfire.world_pb2.GetPlayerSnapshotResponse[source]
get_world_block(request: soulfire.world_pb2.GetWorldBlockRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.GetWorldBlockRequest, soulfire.world_pb2.GetWorldBlockResponse]) → soulfire.world_pb2.GetWorldBlockResponse[source]
query_blocks(request: soulfire.world_pb2.QueryBlocksRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.QueryBlocksRequest, soulfire.world_pb2.QueryBlocksResponse]) → soulfire.world_pb2.QueryBlocksResponse[source]
get_world_entity(request: soulfire.world_pb2.GetWorldEntityRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.GetWorldEntityRequest, soulfire.world_pb2.GetWorldEntityResponse]) → soulfire.world_pb2.GetWorldEntityResponse[source]
query_entities(request: soulfire.world_pb2.QueryEntitiesRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.QueryEntitiesRequest, soulfire.world_pb2.QueryEntitiesResponse]) → soulfire.world_pb2.QueryEntitiesResponse[source]
raycast(request: soulfire.world_pb2.RaycastRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.RaycastRequest, soulfire.world_pb2.RaycastResponse]) → soulfire.world_pb2.RaycastResponse[source]
can_see_block(request: soulfire.world_pb2.CanSeeBlockRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.CanSeeBlockRequest, soulfire.world_pb2.CanSeeBlockResponse]) → soulfire.world_pb2.CanSeeBlockResponse[source]
estimate_dig_time(request: soulfire.world_pb2.EstimateDigTimeRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.EstimateDigTimeRequest, soulfire.world_pb2.EstimateDigTimeResponse]) → soulfire.world_pb2.EstimateDigTimeResponse[source]
estimate_explosion_damage(request: soulfire.world_pb2.EstimateExplosionDamageRequest, ctx: connectrpc.request.RequestContext[soulfire.world_pb2.EstimateExplosionDamageRequest, soulfire.world_pb2.EstimateExplosionDamageResponse]) → soulfire.world_pb2.EstimateExplosionDamageResponse[source]