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

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

    Component

    class in UnityEngine

    /

    Inherits from:Object

    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

    Description

    Base class for everything that can be attached to a GameObject.

    Note that you don't instantiate the Component class directly. Instead, you write code in MonoBehaviour scripts, which inherit from Component, and attach the scripts to a GameObject. Additional resources: ScriptableObject as a way to create scripts that do not attach to any GameObject.

    Properties

    Property Description
    gameObjectThe game object this component is attached to. A component is always attached to a game object.
    tagThe tag of this game object.
    transformThe Transform attached to this GameObject.
    transformHandleThe TransformHandle of this GameObject.

    Public Methods

    Method Description
    BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
    CompareTagChecks the GameObject's tag against the defined tag.
    GetComponentGets a reference to a component of type T on the same GameObject as the component specified.
    GetComponentInChildrenGets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject.
    GetComponentIndexGets the index of the component on its parent GameObject.
    GetComponentInParentGets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject.
    GetComponentsGets references to all components of type T on the same GameObject as the component specified.
    GetComponentsInChildrenGets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject.
    GetComponentsInParentGets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject.
    SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
    SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
    TryGetComponentGets the component of the specified type, if it exists.

    Inherited Members

    Properties

    PropertyDescription
    hideFlagsControls whether the object is hidden, saved with the scene, and editable by the user.
    nameThe name of the object.

    Public Methods

    MethodDescription
    GetEntityIdGets the EntityId of the object.
    GetHashCodeReturns the hash code for the object.
    ToStringReturns the name of the object.

    Static Methods

    MethodDescription
    DestroyRemoves a GameObject, component, or asset.
    DestroyImmediateDestroys the specified object immediately. Use with caution and in Edit mode only.
    DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
    FindAnyObjectByTypeRetrieves any active loaded object of Type T.
    FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
    InstantiateClones the object original and returns the clone.
    InstantiateAsyncCaptures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.

    Operators

    OperatorDescription
    boolDetermines whether the object exists.
    operator !=Compares if two objects refer to a different object.
    operator ==Compares two object references to see if they refer to the same object.

    Web Proxy Viewer  |  New URL  |  Original Page