CompareTag
Checks the GameObject's tag against the defined tag.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
CompareTag(string)
Checks the GameObject's tag against the defined tag.
public bool CompareTag(string tag)
Parameters
The tag to compare.
Returns
Type | Description |
|---|---|
| bool | Returns true if GameObject has same tag. Returns false otherwise. |
Examples
// Immediate death trigger.// Destroys any colliders that enter the trigger, if they are tagged player.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ void OnTriggerEnter(Collider other) { if (other.CompareTag("Player")) { Destroy(other.gameObject); } }}
CompareTag(TagHandle)
Checks the GameObject's tag against the defined tag.
public bool CompareTag(TagHandle tag)
Parameters
A TagHandle representing the tag to compare.
Returns
Type | Description |
|---|---|
| bool | Returns true if GameObject has same tag. Returns false otherwise. |
Remarks
This overload of the method, which takes a TagHandle, can be faster than the overload which takes a string, particularly if the same TagHandle can be reused for many calls.
Examples
// Immediate death trigger.// Destroys any colliders that enter the trigger, if they are tagged "Player".using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ private TagHandle _playerTag; public void OnEnable() { _playerTag = TagHandle.GetExistingTag("Player"); } void OnTriggerEnter(Collider other) { if (other.CompareTag(_playerTag)) { Destroy(other.gameObject); } }}