Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

CompareTag

Checks if the specified tag is attached to the GameObject.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

CompareTag(string)

Checks if the specified tag is attached to the GameObject.
public bool CompareTag(string tag)

Parameters

tag

string
The tag to check for on the GameObject.

Returns

Type

Description

bool
true
if the GameObject has the given tag, 
false
otherwise.

Remarks

The example below calls 
CompareTag
on a Collider to check if it has the 
Player
tag.
// 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.gameObject.CompareTag("Player"))        {            Destroy(other.gameObject);        }    }}
Additional Resources: GameObject.FindWithTag

CompareTag(TagHandle)

Checks if the specified tag is attached to the GameObject.
public bool CompareTag(TagHandle tag)

Parameters

tag

TagHandle
A TagHandle representing the tag to check for on the GameObject.

Returns

Type

Description

bool
true
if the GameObject has the given tag, 
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.
The example below calls 
CompareTag
with a 
TagHandle
on a Collider to check if it has the 
Player
tag:
// 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.gameObject.CompareTag(_playerTag))        {            Destroy(other.gameObject);        }    }}
Additional Resources: TagHandle