Sandbox.Physics.CollisionRules/Result GetCollisionRule( string left, string right )

book_4_sparkGenerated
code_blocksInput

Description

The GetCollisionRule method in the PhysicsWorld class is used to determine the collision rules between two specified collision groups. This method returns a CollisionRules.Result which indicates the type of collision interaction that should occur between the two groups.

Usage

To use the GetCollisionRule method, you need to provide two string parameters representing the names of the collision groups you want to check. The method will return a CollisionRules.Result that describes the collision behavior between these groups.

Example

// Example usage of GetCollisionRule
PhysicsWorld physicsWorld = new PhysicsWorld();
string groupA = "Player";
string groupB = "Environment";

// Get the collision rule between Player and Environment
var collisionResult = physicsWorld.GetCollisionRule(groupA, groupB);

// Check the result
if (collisionResult == CollisionRules.Result.Ignore)
{
    // Handle the case where collisions are ignored
}
else if (collisionResult == CollisionRules.Result.Collide)
{
    // Handle the case where collisions occur
}