Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Component.GetComponent

Switch to Manual
public function GetComponent(type: Type): Component;

Parameters

type The type of Component to retrieve.

Description

Returns the component of Type type if the game object has one attached, null if it doesn't.

// Disable the spring on the HingeJoint component.

var hinge : HingeJoint; hinge = GetComponent.<HingeJoint>(); hinge.useSpring = false;

public function GetComponent(): T;

Description

Generic version. See the Generic Functions page for more details.


public function GetComponent(type: string): Component;

Parameters

Description

Returns the component with name type if the game object has one attached, null if it doesn't.

It is better to use GetComponent with a Type instead of a string for performance reasons. Sometimes you might not be able to get to the type however, for example when trying to access a C# script from Javascript. In that case you can simply access the component by name instead of type. Example:

// Disable the spring on the HingeJoint component.

var hinge : HingeJoint; hinge = GetComponent("HingeJoint"); hinge.useSpring = false;