Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CollisionFlags

CollisionFlags is a bitmask returned by CharacterController.Move.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Enum
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule
public enum CollisionFlags

Remarks

It gives you a broad overview of where your character collided with any other objects.

Examples

using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ void Update() { CharacterController controller = GetComponent<CharacterController>(); if (controller.collisionFlags == CollisionFlags.None) { print("Free floating!"); } if ((controller.collisionFlags & CollisionFlags.Sides) != 0) { print("Touching sides!"); } if (controller.collisionFlags == CollisionFlags.Sides) { print("Only touching sides, nothing else!"); } if ((controller.collisionFlags & CollisionFlags.Above) != 0) { print("Touching Ceiling!"); } if (controller.collisionFlags == CollisionFlags.Above) { print("Only touching Ceiling, nothing else!"); } if ((controller.collisionFlags & CollisionFlags.Below) != 0) { print("Touching ground!"); } if (controller.collisionFlags == CollisionFlags.Below) { print("Only touching ground, nothing else!"); } }}

Fields

Value

Description

AboveCollisionFlags is a bitmask returned by CharacterController.Move.
BelowCollisionFlags is a bitmask returned by CharacterController.Move.
NoneCollisionFlags is a bitmask returned by CharacterController.Move.
SidesCollisionFlags is a bitmask returned by CharacterController.Move.