[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/Component.CompareTag.html [Back]  [Original]

Unity - Scripting API: Component.CompareTag
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    Component.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
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Declaration

    public bool CompareTag(string tag);

    Parameters

    Parameter Description
    tag The tag to compare.

    Returns

    bool Returns true if GameObject has same tag. Returns false otherwise.

    Description

    Checks the GameObject's tag against the defined 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.CompareTag("Player")) { Destroy(other.gameObject); } } }

    Declaration

    public bool CompareTag(TagHandle tag);

    Parameters

    Parameter Description
    tag A TagHandle representing the tag to compare.

    Returns

    bool Returns true if GameObject has same tag. Returns false otherwise.

    Description

    Checks the GameObject's tag against the defined 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.

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

    Web Proxy Viewer  |  New URL  |  Original Page