Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine
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
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
A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state.
A canvas group can be used to modify the state of children elements.
An example of this would be a window which fades in over time, by modifying the alpha value of the group the children elements well be affected. The result alpha will be the multiplied result of any nested groups, multiplied with the canvas elements alpha.
Canvas Groups can also be configured to not block raycasts (anything on the group will not be considerered for graphic raycasting), and whether elements are interactable.
|alpha||Set the alpha of the group.|
|blocksRaycasts||Does this group block raycasting (allow collision).|
|ignoreParentGroups||Should the group ignore parent groups?|
|interactable||Is the group interactable (are the elements beneath the group enabled).|
|IsRaycastLocationValid||Returns true if the Group allows raycasts.|
|gameObject||The game object this component is attached to. A component is always attached to a game object.|
|tag||The tag of this game object.|
|transform||The Transform attached to this GameObject.|
|hideFlags||Should the object be hidden, saved with the scene or modifiable by the user?|
|name||The name of the 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||Returns the component of Type type in the GameObject or any of its parents.|
|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.|
|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.|
|GetInstanceID||Returns the instance id of the object.|
|ToString||Returns the name of the game object.|
|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.|