Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

CollisionFlags

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

CollisionFlags is a bitmask returned by CharacterController.Move.

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

	function Update () {
		var controller : CharacterController = GetComponent.<CharacterController>();
		if (controller.collisionFlags == CollisionFlags.None)
			print("Free floating!");

if (controller.collisionFlags & CollisionFlags.Sides) print("Touching sides!"); if (controller.collisionFlags == CollisionFlags.Sides) print("Only touching sides, nothing else!");

if (controller.collisionFlags & CollisionFlags.Above) print("Touching sides!"); if (controller.collisionFlags == CollisionFlags.Above) print("Only touching Ceiling, nothing else!");

if (controller.collisionFlags & CollisionFlags.Below) print("Touching ground!"); if (controller.collisionFlags == CollisionFlags.Below) print("Only touching ground, nothing else!"); }
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 sides!"); 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!"); } }

Variables

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