Skip to main content

Module query

Module query 

Source
Expand description

/query filter evaluation and ordering for SceneAsset, SceneRegion, SceneObject and SceneAvatar (draft-atwood-jmap-scene-00 §SceneAsset/query, §SceneRegion/query, §SceneObject/query, §SceneAvatar/query).

Pure functions a backend’s query_objects can apply to its stored objects; the reference MemoryBackend uses them.

Functions§

asset_matches
true if asset matches filter (§SceneAsset/query): “All filter properties are combined with logical AND.”
avatar_matches
true if avatar matches filter (§SceneAvatar/query): “All filter properties are combined with logical AND.”
compare_assets
Order two assets by sort (“Sort properties: createdAt, name, size”; RFC 8620 §5.5: later comparators break ties of earlier ones), then by id so the order is total.
compare_avatars
Order two avatars by sort (“Sort properties: joinedAt, displayName”; RFC 8620 §5.5: later comparators break ties of earlier ones), then by id so the order is total.
compare_objects
Order two objects by sort (“Sort properties: createdAt, name”; RFC 8620 §5.5: later comparators break ties of earlier ones), then by id so the order is total.
compare_regions
Order two regions by sort (“Sort properties: createdAt, name, activeAvatarCount”; RFC 8620 §5.5: later comparators break ties of earlier ones), then by id so the order is total.
object_matches
true if object, whose region-local position is position (see region_local_position), matches filter (§SceneObject/query): “All filter properties are combined with logical AND.”
region_local_position
The position of object in region-local coordinates.
region_matches
true if region matches filter (§SceneRegion/query): “All filter properties are combined with logical AND.”