For the complete documentation index, see llms.txt. This page is also available as Markdown.

PhysicsService

PhysicsService : Instance

Overview

PhysicsService is a service that finely controls collision rules between objects in physics computation, allowing you to create collision groups and configure whether each group interacts with the others.

For example, it can be used to let players pass through specific walls based on their level.

Properties

Methods

IsChannelRegistered

Returns whether the given CollisionChannel can currently be used.

Parameters

Enum.CollisionChannel Channel

The collision channel to check.

Return

boolean

true if the channel is registered (usable), false otherwise.

Code Samples

IsCustomChannel

Returns whether the given CollisionChannel is a custom channel registered by the developer, as opposed to one of Studio's built-in default channels.

Parameters

Enum.CollisionChannel Channel

The CollisionChannel to check.

Return

boolean

true if the channel is a custom, developer-registered channel, false if it is a built-in channel or not registered.

Code Samples

IsCustomProfile

Returns whether the given collision profile was created by, or is editable by, the developer, as opposed to being one of OVERDARE's built-in default profiles.

Parameters

string ProfileString

The name of the collision profile to check.

Return

boolean

true if the profile is a custom, editable profile, false if it is a built-in default profile or does not exist.

Code Samples

IsProfileRegistered

Returns whether a collision profile with the given name currently exists.

Parameters

string ProfileString

The name of the collision profile to check.

Return

boolean

true if a profile with that name is registered, false otherwise.

Code Samples

Events

See also

https://github.com/overdare/creator-guide-eng/blob/main/manual/studio-manual/game-development/collision-groups.md

Last updated