Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

MonoBehaviour.OnControllerColliderHit(ControllerColliderHit)

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

Submission failed

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

Close

Cancel

Description

OnControllerColliderHit is called when the controller hits a collider while performing a Move.

This can be used to push objects when they collide with the character.

// this script pushes all rigidbodies that the character touches

var pushPower : float = 2.0; function OnControllerColliderHit (hit : ControllerColliderHit) { var body : Rigidbody = hit.collider.attachedRigidbody; // no rigidbody if (body == null || body.isKinematic) return;

// We dont want to push objects below us if (hit.moveDirection.y < -0.3) return;

// Calculate push direction from move direction, // we only push objects to the sides never up and down var pushDir : Vector3 = Vector3 (hit.moveDirection.x, 0, hit.moveDirection.z);

// If you know how fast your character is trying to move, // then you can also multiply the push velocity by that.

// Apply the push body.velocity = pushDir * pushPower; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public float pushPower = 2.0F; void OnControllerColliderHit(ControllerColliderHit hit) { Rigidbody body = hit.collider.attachedRigidbody; if (body == null || body.isKinematic) return; if (hit.moveDirection.y < -0.3F) return; Vector3 pushDir = new Vector3(hit.moveDirection.x, 0, hit.moveDirection.z); body.velocity = pushDir * pushPower; } }

Did you find this page useful? Please give it a rating: