Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

GameObject

Namespace: UnityEngine

/

Inherits from: Object

Description

Base class for all entities in Unity scenes.

See Also: Component.

Variables

activeInHierarchyIs the GameObject active in the scene?
activeSelfThe local active state of this GameObject. (Read Only)
animationThe Animation attached to this GameObject (Read Only). (null if there is none attached).
audioThe AudioSource attached to this GameObject (Read Only). (null if there is none attached).
cameraThe Camera attached to this GameObject (Read Only). (null if there is none attached).
colliderThe Collider attached to this GameObject (Read Only). (null if there is none attached).
collider2DThe Collider2D component attached to this object.
constantForceThe ConstantForce attached to this GameObject (Read Only). (null if there is none attached).
guiTextThe GUIText attached to this GameObject (Read Only). (null if there is none attached).
guiTextureThe GUITexture attached to this GameObject (Read Only). (null if there is none attached).
hingeJointThe HingeJoint attached to this GameObject (Read Only). (null if there is none attached).
isStaticEditor only API that specifies if a game object is static.
layerThe layer the game object is in. A layer is in the range [0...31].
lightThe Light attached to this GameObject (Read Only). (null if there is none attached).
networkViewThe NetworkView attached to this GameObject (Read Only). (null if there is none attached).
particleEmitterThe ParticleEmitter attached to this GameObject (Read Only). (null if there is none attached).
particleSystemThe ParticleSystem attached to this GameObject (Read Only). (null if there is none attached).
rendererThe Renderer attached to this GameObject (Read Only). (null if there is none attached).
rigidbodyThe Rigidbody attached to this GameObject (Read Only). (null if there is none attached).
rigidbody2DThe Rigidbody2D component attached to this GameObject. (Read Only)
tagThe tag of this game object.
transformThe Transform attached to this GameObject. (null if there is none attached).

Constructors

GameObjectCreates a new game object, named name.

Functions

AddComponentAdds a component class named className to the game object.
BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with /tag/?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentFinds component in the parent.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SampleAnimationSamples an animation at a given time for any animated properties.
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.
SetActiveActivates/Deactivates the GameObject.

Static Functions

CreatePrimitiveCreates a game object with a primitive mesh renderer and appropriate collider.
FindFinds a game object by name and returns it.
FindGameObjectsWithTagReturns a list 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

Variables

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

Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active 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 if two objects refer to the same.