hytopia
Version:
The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.
106 lines (49 loc) • 1.78 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [server](./server.md) > [CollisionGroupsBuilder](./server.collisiongroupsbuilder.md)
## CollisionGroupsBuilder class
A helper class for building and decoding collision groups.
When to use: creating custom collision filters for colliders and rigid bodies. Do NOT use for: per-frame changes; collision group changes are usually infrequent.
**Signature:**
```typescript
export default class CollisionGroupsBuilder
```
## Remarks
Use the static methods directly to encode or decode collision group masks.
\*\*Category:\*\* Physics
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[buildRawCollisionGroups(collisionGroups)](./server.collisiongroupsbuilder.buildrawcollisiongroups.md)
</td><td>
`static`
</td><td>
Builds a raw collision group mask from a set of collision groups.
</td></tr>
<tr><td>
[decodeCollisionGroups(collisionGroups)](./server.collisiongroupsbuilder.decodecollisiongroups.md)
</td><td>
`static`
</td><td>
Decodes collision groups into their string equivalents.
</td></tr>
<tr><td>
[decodeRawCollisionGroups(groups)](./server.collisiongroupsbuilder.decoderawcollisiongroups.md)
</td><td>
`static`
</td><td>
Decodes a raw collision group mask into a set of collision groups.
</td></tr>
<tr><td>
[isDefaultCollisionGroups(collisionGroups)](./server.collisiongroupsbuilder.isdefaultcollisiongroups.md)
</td><td>
`static`
</td><td>
Checks if the collision groups are the default collision groups.
</td></tr>
</tbody></table>