Module builtin_methods 

Built-in verbs for the Bevy Remote Protocol.

Structs

BrpDespawnEntityParams

world.despawn_entity: Given an ID, despawns the entity with that ID.

BrpGetComponentsParams

world.get_components: Retrieves one or more components from the entity with the given ID.

BrpGetResourcesParams

world.get_resources: Retrieves the value of a given resource.

BrpGetResourcesResponse

The response to a world.get_resources request.

BrpInsertComponentsParams

world.insert_components: Adds one or more components to an entity.

BrpInsertResourcesParams

world.insert_resources: Inserts a resource into the world with a given value.

BrpJsonSchemaQueryFilter

Constraints that can be placed on a query to include or exclude certain definitions.

BrpListComponentsParams

world.list_components: Returns a list of all type names of registered components in the system (no params provided), or those on an entity (params provided).

BrpListComponentsWatchingResponse

A single response from a world.list_components+watch request.

BrpMutateComponentsParams

world.mutate_components:

BrpMutateResourcesParams

world.mutate_resources:

BrpQuery

Describes the data that is to be fetched in a query.

BrpQueryFilter

Additional constraints that can be placed on a query to include or exclude certain entities.

BrpQueryParams

world.query: Performs a query over components in the ECS, returning entities and component values that match.

BrpQueryRow

One query match result: a single entity paired with the requested components.

BrpRemoveComponentsParams

world.remove_components: Deletes one or more components from an entity.

BrpRemoveResourcesParams

world.remove_resources: Removes the given resource from the world.

BrpReparentEntitiesParams

world.reparent_entities: Assign a new parent to one or more entities.

BrpSpawnEntityParams

world.spawn_entity: Creates a new entity with the given components and responds with its ID.

BrpSpawnEntityResponse

A response from the world to the client that specifies a single entity.

JsonSchemaTypeLimit

Additional BrpJsonSchemaQueryFilter constraints that can be placed on a query to include or exclude certain definitions.

Enums

BrpGetComponentsResponse

The response to a world.get_components request.

BrpGetComponentsWatchingResponse

A single response from a world.get_components+watch request.

ComponentSelector

A selector for components in a query.

Constants

BRP_DESPAWN_COMPONENTS_METHOD

The method path for a world.despawn_entity request.

BRP_GET_COMPONENTS_AND_WATCH_METHOD

The method path for a world.get_components+watch request.

BRP_GET_COMPONENTS_METHOD

The method path for a world.get_components request.

BRP_GET_RESOURCE_METHOD

The method path for a world.get_resources request.

BRP_INSERT_COMPONENTS_METHOD

The method path for a world.insert_components request.

BRP_INSERT_RESOURCE_METHOD

The method path for a world.insert_resources request.

BRP_LIST_COMPONENTS_AND_WATCH_METHOD

The method path for a world.list_components+watch request.

BRP_LIST_COMPONENTS_METHOD

The method path for a world.list_components request.

BRP_LIST_RESOURCES_METHOD

The method path for a world.list_resources request.

BRP_MUTATE_COMPONENTS_METHOD

The method path for a world.mutate_components request.

BRP_MUTATE_RESOURCE_METHOD

The method path for a world.mutate_resources request.

BRP_QUERY_METHOD

The method path for a world.query request.

BRP_REGISTRY_SCHEMA_METHOD

The method path for a registry.schema request.

BRP_REMOVE_COMPONENTS_METHOD

The method path for a world.remove_components request.

BRP_REMOVE_RESOURCE_METHOD

The method path for a world.remove_resources request.

BRP_REPARENT_ENTITIES_METHOD

The method path for a world.reparent_entities request.

BRP_SPAWN_ENTITY_METHOD

The method path for a world.spawn_entity request.

RPC_DISCOVER_METHOD

The method path for a rpc.discover request.

Functions

export_registry_types

Handles a registry.schema request (list all registry types in form of schema) coming from a client.

process_remote_despawn_entity_request

Handles a world.despawn_entity (despawn entity) request coming from a client.

process_remote_get_components_request

Handles a world.get_components request coming from a client.

process_remote_get_components_watching_request

Handles a world.get_components+watch request coming from a client.

process_remote_get_resources_request

Handles a world.get_resources request coming from a client.

process_remote_insert_components_request

Handles a world.insert_components request (insert components) coming from a client.

process_remote_insert_resources_request

Handles a world.insert_resources request coming from a client.

process_remote_list_components_request

Handles a world.list_components request (list all components) coming from a client.

process_remote_list_components_watching_request

Handles a world.list_components+watch request coming from a client.

process_remote_list_methods_request

Handles a rpc.discover request coming from a client.

process_remote_list_resources_request

Handles a world.list_resources request coming from a client.

process_remote_mutate_components_request

Handles a world.mutate_components request coming from a client.

process_remote_mutate_resources_request

Handles a world.mutate_resources request coming from a client.

process_remote_query_request

Handles a world.query request coming from a client.

process_remote_remove_components_request

Handles a world.remove_components request (remove components) coming from a client.

process_remote_remove_resources_request

Handles a world.remove_resources request coming from a client.

process_remote_reparent_entities_request

Handles a world.reparent_entities request coming from a client.

process_remote_spawn_entity_request

Handles a world.spawn_entity request coming from a client.

Type Aliases

BrpListComponentsResponse

The response to a world.list_components request.

BrpListResourcesResponse

The response to a world.list_resources request.

BrpQueryResponse

The response to a world.query request.