Sites

Menu

Visualizing authority and interest

Learn about how to visualize worker write access authority and write interest in the workspaces of the new Inspector.

Before you begin, ensure that the modules in your workspace are configured properly to get data for worker authority and interest.

Worker write access authority

In the new Inspector, you can visualize worker write access authority. This helps you debug the load balancing strategy of your deployment, for example, to check if a specific worker instance has authority over the expected components over entities.

Note: To visualize write access authority, ensure that you’ve selected the Include authority map check box in the query editor.

Based on your use cases, you can configure the settings in different modules to visualize worker instance authority.

In the viewport module

You can visualize worker write access authority by entity here. When multiple worker instances have write access authority over different components of an entity, you can see multiple colored “hats” over an entity.

Alternatively, you can also hover over the entity and see the names of worker instance that have write access authority over it.

The following screenshot shows that you hover over an entity and see UnrealWorker1 has write access authority over it:

In the entity table module

You can visualize worker write access authority by component here. You can configure to see the worker instance in color whether on hover or always when it has write access authority over an entity component.

The following screenshot shows that you see the worker instance that has write access authority over components always in color:

In the entity details module

You can visualize write access authority on components of an entity sorted by Worker or Components in the authority tab.

The following screenshot shows that you can sort the write access authority of an entity by Workers:

Worker interest

In the new Inspector, you can visualize which entity components worker instances want to receive updates about. This helps you better understand the current interest configurations of your game, and also debug why you are or are not seeing relevant data in your game.

Before you start, ensure that you’re familiar with query-based interest and have enabled and specified query-based interest.

Note: To visualize worker interest, ensure that you’ve added the improbable.Interest component to your components streamed in the query editor.

Based on your use cases, you can configure the settings in different modules to visualize worker interest.

In the viewport module

You can visualize worker interest based on QBI (query-based interest) spatial constraints only.

In the entity details module

You can see QBI configurations on an entity in the Interest tab.

The following example screenshot shows when a worker instance gains write access authority over the Improbable.Position component of entityId = 1036, it also gains interest in all components that match the query. The query is defined as follows:

  • Constraints of the OrConstraint type:
    • Relative cylinder with radius 150: indicates if any entity is within a 150 meter radius of the entityId = 1036.
    • Component: 9997, component: 9995, component: 9983: indicates if any entity in the game world has component ID: 9997, component: 9995, or component: 9983.
  • Result Type of all components: indicates if any entity in the game world meets either of the preceding constraints, the worker instance receives updates about all components of that entity.


————
2019-11-25 Page added with limited editorial review

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums