These are the docs for 13.8, an old version of SpatialOS. The docs for this version are frozen: we do not correct, update or republish them. 14.1 is the newest →

Component filters

You must specify which components a worker instance can receive updates about. You do this using component filters. This is in addition to setting up read access permission and interest (QBI(t) or CBI).

The static component filter (all entities)

Use the component delivery field (in the bridge configuration section of the worker configuration file) to specify the components that worker instances of a particular type can receive updates about. You can either set checkoutAllInitially to true to allow all components, or you can whitelist individual components using checkout_initially.

Static component filtering acts as a whitelist, and takes precedence over both QBI and CBI. By default, no components are whitelisted.

This means that you need to whitelist a component (or set checkoutAllInitially to true) for QBI and CBI to work.

Tip: If you’re using QBI, we recommend setting checkoutAllInitially to true rather than whitelisting individual components.

The dynamic component filter (specific entities)

You can set up filters on specific entities during runtime via a message to SpatialOS (see the API documentation for C++/C#/Java).

You set up dynamic component filters to override the static component filter.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums