Version: 2023.1
LanguageEnglish
  • C#

GameObject

class in UnityEngine

/

Inherits from:Object

/

Implemented in:UnityEngine.CoreModule

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

Description

Base class for all entities in Unity Scenes.

Note: Many variables in the GameObject class have been removed. To access GameObject.renderer in csharp, for example, use GetComponent<Renderer>() instead.

See Also: Component.

Properties

activeInHierarchyDefines whether the GameObject is active in the Scene.
activeSelfThe local active state of this GameObject. (Read Only)
isStaticGets and sets the GameObject's StaticEditorFlags.
layerThe layer the GameObject is in.
sceneScene that the GameObject is part of.
sceneCullingMaskScene culling mask Unity uses to determine which scene to render the GameObject in.
tagThe tag of this GameObject.
transformThe Transform attached to this GameObject.

Constructors

GameObjectCreates a new GameObject, named name.

Public Methods

AddComponentAdds a component class of type componentType to the GameObject. C# Users can use a generic version.
BroadcastMessageCalls the method named methodName on every MonoBehaviour in this GameObject or any of its children.
CompareTagIs this GameObject tagged with tag ?
GetComponentGets a reference to a component of type T on the specified GameObject.
GetComponentInChildrenGets a reference to a component of type T on the specified GameObject, or any child of the GameObject.
GetComponentInParentGets a reference to a component of type T on the specified GameObject, or any parent of the GameObject.
GetComponentsGets references to all components of type T on the specified GameObject.
GetComponentsInChildrenGets references to all components of type T on the specified GameObject, and any child of the GameObject.
GetComponentsInParentGets references to all components of type T on the specified GameObject, and any parent of the GameObject.
SendMessageCalls the method named methodName on every MonoBehaviour in this GameObject.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this GameObject and on every ancestor of the behaviour.
SetActiveActivates/Deactivates the GameObject, depending on the given true or false value.
TryGetComponentGets the component of the specified type, if it exists.

Static Methods

CreatePrimitiveCreates a GameObject with a primitive mesh renderer and appropriate collider.
FindFinds a GameObject by name and returns it.
FindGameObjectsWithTagReturns an array of active GameObjects tagged tag. Returns empty array if no GameObject was found.
FindWithTagReturns one active GameObject tagged tag. Returns null if no GameObject was found.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.