Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GameObject

Namespace: 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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Base class for all entities in Unity scenes.

See Also: Component.

Variables

activeInHierarchy Is the GameObject active in the scene?
activeSelf The local active state of this GameObject. (Read Only)
animation The Animation attached to this GameObject (Read Only). (null if there is none attached).
audio The AudioSource attached to this GameObject (Read Only). (null if there is none attached).
camera The Camera attached to this GameObject (Read Only). (null if there is none attached).
collider The Collider attached to this GameObject (Read Only). (null if there is none attached).
collider2D The Collider2D component attached to this object.
constantForce The ConstantForce attached to this GameObject (Read Only). (null if there is none attached).
guiText The GUIText attached to this GameObject (Read Only). (null if there is none attached).
guiTexture The GUITexture attached to this GameObject (Read Only). (null if there is none attached).
hingeJoint The HingeJoint attached to this GameObject (Read Only). (null if there is none attached).
isStatic Editor only API that specifies if a game object is static.
layer The layer the game object is in. A layer is in the range [0...31].
light The Light attached to this GameObject (Read Only). (null if there is none attached).
networkView The NetworkView attached to this GameObject (Read Only). (null if there is none attached).
particleEmitter The ParticleEmitter attached to this GameObject (Read Only). (null if there is none attached).
particleSystem The ParticleSystem attached to this GameObject (Read Only). (null if there is none attached).
renderer The Renderer attached to this GameObject (Read Only). (null if there is none attached).
rigidbody The Rigidbody attached to this GameObject (Read Only). (null if there is none attached).
rigidbody2D The Rigidbody2D component attached to this GameObject. (Read Only)
tag The tag of this game object.
transform The Transform attached to this GameObject. (null if there is none attached).

Constructors

GameObject Creates a new game object, named name.

Functions

AddComponent Adds a component class named className to the game object.
BroadcastMessage Calls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTag Is this game object tagged with /tag/?
GetComponent Returns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildren Returns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParent Finds component in the parent.
GetComponents Returns all components of Type type in the GameObject.
GetComponentsInChildren Returns all components of Type type in the GameObject or any of its children.
GetComponentsInParent Returns all components of Type type in the GameObject or any of its parents.
SampleAnimation Samples an animation at a given time for any animated properties.
SendMessage Calls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwards Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
SetActive Activates/Deactivates the GameObject.

Static Functions

CreatePrimitive Creates a game object with a primitive mesh renderer and appropriate collider.
Find Finds a game object by name and returns it.
FindGameObjectsWithTag Returns a list of active GameObjects tagged tag. Returns empty array if no GameObject was found.
FindWithTag Returns one active GameObject tagged tag. Returns null if no GameObject was found.

Inherited members

Variables

hideFlags Should the object be hidden, saved with the scene or modifiable by the user?
name The name of the object.

Functions

GetInstanceID Returns the instance id of the object.
ToString Returns the name of the game object.

Static Functions

Destroy Removes a gameobject, component or asset.
DestroyImmediate Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad Makes the object target not be destroyed automatically when loading a new scene.
FindObjectOfType Returns the first active loaded object of Type type.
FindObjectsOfType Returns a list of all active loaded objects of Type type.
Instantiate Clones the object original and returns the clone.

Operators

bool Does the object exist?
operator != Compares if two objects refer to a different object.
operator == Compares if two objects refer to the same.