Nebula
Containers

PortalQueryOptions

Settings of a portal query (docs/portals.md D32, D33).

generated from the sources
public sealed class PortalQueryOptions

Settings of a portal query (docs/portals.md D32, D33). Make one and keep it: a query takes it by reference and allocates nothing itself. The defaults are every layer but NebulaConfig.PortalProxyLayer, triggers ignored, the present, and a scope's own scene.

Fields

LayerMask

public int LayerMask = ~0;

The layers to hit. NebulaConfig.PortalProxyLayer is always left out: a proxy is never hit.

Triggers

public QueryTriggerInteraction Triggers = QueryTriggerInteraction.Ignore;

Whether triggers are hit.

Tick

public uint Tick;

The server tick to look at (a lag-compensated query), or 0 for now. The far leg is tested against the pose every entity there had at this tick (HistoryRewind); an entity that crossed during the interval is found on the side it was on. Workers only: a client keeps no history.

RewindNear

public bool RewindNear;

Also rewind the scope the cast starts in. Leave it off when the game already rewinds that scope itself (with HistoryRewind or its own colliders), and set it to have Nebula do both legs.

Space

public Container Space;

The physics frame the cast starts in, when it starts on ground that is a carrier's (docs/portals.md D26): the frame's owner container, in whose simulation space the cast's points are. Null for a scope's own scene.

On this page