Version: Unity 6 Beta (6000.0)
LanguageEnglish
  • C#

GameObject.CompareTag

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

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); } } }
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961