This version of Unity is unsupported.

GameObject.CompareTag

Switch to Manual

Declaration

public bool CompareTag(string tag);

Parameters

tag The tag to compare.

Returns

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

Description

Is this GameObject tagged with tag ?

The example below shows CompareTag check a Collider having a tag of Player.

// 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); } } }

Declaration

public bool CompareTag(TagHandle tag);

Parameters

tag A TagHandle representing the tag to compare.

Returns

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

Description

Is this GameObject tagged with tag?

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 shows CompareTag to check if a Collider has a tag of Player, using a TagHandle:

// 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); } } }