UnityEngine

Structure describing acceleration status of the device.

Value of acceleration.

Amount of time passed since last accelerometer measurement.

A class containing methods to assist with accessibility for users with different vision capabilities.

Gets a palette of colors that should be distinguishable for normal vision, deuteranopia, protanopia, and tritanopia.

An array of colors to populate with a palette. Minimum allowable perceived luminance from 0 to 1. A value of 0.2 or greater is recommended for dark backgrounds. Maximum allowable perceived luminance from 0 to 1. A value of 0.8 or less is recommended for light backgrounds. The number of unambiguous colors in the palette.

Enum mask of possible shader channel properties that can also be included when the Canvas mesh is created.

No additional shader parameters are needed.

Include the normals on the mesh vertices.

Include the Tangent on the mesh vertices.

Include UV1 on the mesh vertices.

Include UV2 on the mesh vertices.

Include UV3 on the mesh vertices.

Singleton class to access the baked NavMesh.

Describes how far in the future the agents predict collisions for avoidance.

Set a function to be called before the NavMesh is updated during the frame update execution.

The maximum amount of nodes processed each frame in the asynchronous pathfinding process.

Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct.

Describing the properties of the link. Representing the added link.

Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct.

Describing the properties of the link. Translate the link to this position. Rotate the link to this orientation. Representing the added link.

Adds the specified NavMeshData to the game.

Contains the data for the navmesh. Representing the added navmesh.

Adds the specified NavMeshData to the game.

Contains the data for the navmesh. Translate the navmesh to this position. Rotate the navmesh to this orientation. Representing the added navmesh.

Area mask constant that includes all NavMesh areas.

Calculate a path between two points and store the resulting path.

The initial position of the path requested. The final position of the path requested. A bitfield mask specifying which NavMesh areas can be passed when calculating a path. The resulting path. True if a either a complete or partial path is found and false otherwise.

Calculates a path between two positions mapped to the NavMesh, subject to the constraints and costs defined by the filter argument.

The initial position of the path requested. The final position of the path requested. A filter specifying the cost of NavMesh areas that can be passed when calculating a path. The resulting path. True if a either a complete or partial path is found and false otherwise.

Calculates triangulation of the current navmesh.

Creates and returns a new entry of NavMesh build settings available for runtime NavMesh building.

The created settings.

Locate the closest NavMesh edge from a point on the NavMesh.

The origin of the distance query. Holds the properties of the resulting location. A bitfield mask specifying which NavMesh areas can be passed when finding the nearest edge. True if a nearest edge is found.

Locate the closest NavMesh edge from a point on the NavMesh, subject to the constraints of the filter argument.

The origin of the distance query. Holds the properties of the resulting location. A filter specifying which NavMesh areas can be passed when finding the nearest edge. True if a nearest edge is found.

Gets the cost for path finding over geometry of the area type.

Index of the area to get.

Returns the area index for a named NavMesh area type.

Name of the area to look up. Index if the specified are, or -1 if no area found.

Gets the cost for traversing over geometry of the layer type on all agents.

Returns the layer index for a named layer.

Returns an existing entry of NavMesh build settings.

The ID to look for. The settings found.

Returns an existing entry of NavMesh build settings by its ordered index.

The index to retrieve from. The found settings.

Returns the number of registered NavMesh build settings.

The number of registered entries.

Returns the name associated with the NavMesh build settings matching the provided agent type ID.

The ID to look for. The name associated with the ID found.

A delegate which can be used to register callback methods to be invoked before the NavMesh system updates.

Trace a line between two points on the NavMesh.

The origin of the ray. The end of the ray. Holds the properties of the ray cast resulting location. A bitfield mask specifying which NavMesh areas can be passed when tracing the ray. True if the ray is terminated before reaching target position. Otherwise returns false.

Traces a line between two positions on the NavMesh, subject to the constraints defined by the filter argument.

The origin of the ray. The end of the ray. Holds the properties of the ray cast resulting location. A filter specifying which NavMesh areas can be passed when tracing the ray. True if the ray is terminated before reaching target position. Otherwise returns false.

Removes a link from the NavMesh.

The instance of a link to remove.

Removes the specified NavMeshDataInstance from the game, making it unavailable for agents and queries.

The instance of a NavMesh to remove.

Removes the build settings matching the agent type ID.

The ID of the entry to remove.

Finds the closest point on NavMesh within specified range.

The origin of the sample query. Holds the properties of the resulting location. Sample within this distance from sourcePosition. A mask specifying which NavMesh areas are allowed when finding the nearest point. True if a nearest point is found.

Samples the position closest to sourcePosition - on any NavMesh built for the agent type specified by the filter.

The origin of the sample query. Holds the properties of the resulting location. Sample within this distance from sourcePosition. A filter specifying which NavMesh areas are allowed when finding the nearest point. True if a nearest point is found.

Sets the cost for finding path over geometry of the area type on all agents.

Index of the area to set. New cost.

Sets the cost for traversing over geometry of the layer type on all agents.

Navigation mesh agent.

The maximum acceleration of an agent as it follows a path, given in units / sec^2.

The type ID for the agent.

Maximum turning speed in (deg/s) while following a path.

Specifies which NavMesh areas are passable. Changing areaMask will make the path stale (see isPathStale).

Should the agent brake automatically to avoid overshooting the destination point?

Should the agent attempt to acquire a new path if the existing path becomes invalid?

Should the agent move across OffMeshLinks automatically?

The avoidance priority level.

The relative vertical displacement of the owning GameObject.

The current OffMeshLinkData.

The desired velocity of the agent including any potential contribution from avoidance. (Read Only)

Gets or attempts to set the destination of the agent in world-space units.

Does the agent currently have a path? (Read Only)

The height of the agent for purposes of passing under obstacles, etc.

Is the agent currently bound to the navmesh? (Read Only)

Is the agent currently positioned on an OffMeshLink? (Read Only)

Is the current path stale. (Read Only)

This property holds the stop or resume condition of the NavMesh agent.

Returns the owning object of the NavMesh the agent is currently placed on (Read Only).

The next OffMeshLinkData on the current path.

Gets or sets the simulation position of the navmesh agent.

The level of quality of avoidance.

Property to get and set the current path.

Is a path in the process of being computed but not yet ready? (Read Only)

The status of the current path (complete, partial or invalid).

The avoidance radius for the agent.

The distance between the agent's position and the destination on the current path. (Read Only)

Maximum movement speed when following a path.

Get the current steering target along the path. (Read Only)

Stop within this distance from the target position.

Gets or sets whether the transform position is synchronized with the simulated agent position. The default value is true.

Should the agent update the transform orientation?

Allows you to specify whether the agent should be aligned to the up-axis of the NavMesh or link that it is placed on.

Access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually.

Specifies which NavMesh layers are passable (bitfield). Changing walkableMask will make the path stale (see isPathStale).

Enables or disables the current off-mesh link.

Is the link activated?

Calculate a path to a specified point and store the resulting path.

The final position of the path requested. The resulting path. True if a path is found.

Completes the movement on the current OffMeshLink.

Locate the closest NavMesh edge.

Holds the properties of the resulting location. True if a nearest edge is found.

Gets the cost for path calculation when crossing area of a particular type.

Area Index. Current cost for specified area index.

Gets the cost for crossing ground of a particular type.

Layer index. Current cost of specified layer.

Apply relative movement to current position.

The relative movement vector.

Trace a straight path towards a target postion in the NavMesh without moving the agent.

The desired end position of movement. Properties of the obstacle detected by the ray (if any). True if there is an obstacle between the agent and the target position, otherwise false.

Clears the current path.

Resumes the movement along the current path after a pause.

Sample a position along the current path.

A bitfield mask specifying which NavMesh areas can be passed when tracing the path. Terminate scanning the path at this distance. Holds the properties of the resulting location. True if terminated before reaching the position at maxDistance, false otherwise.

Sets the cost for traversing over areas of the area type.

Area cost. New cost for the specified area index.

Sets or updates the destination thus triggering the calculation for a new path.

The target point to navigate to. True if the destination was requested successfully, otherwise false.

Sets the cost for traversing over geometry of the layer type.

Layer index. New cost for the specified layer.

Assign a new path to this agent.

New path to follow. True if the path is succesfully assigned.

Stop movement of this agent along its current path.

Warps agent to the provided position.

New position to warp the agent to. True if agent is successfully warped, otherwise false.

Bitmask used for operating with debug data from the NavMesh build process.

All debug data from the NavMesh build process is taken into consideration.

The triangles of all the geometry that is used as a base for computing the new NavMesh.

No debug data from the NavMesh build process is taken into consideration.

Meshes of convex polygons constructed within the unified contours of adjacent regions.

The triangulated meshes with height details that better approximate the source geometry.

The contours that follow precisely the edges of each surface region.

The segmentation of the traversable surfaces into smaller areas necessary for producing simple polygons.

Contours bounding each of the surface regions, described through fewer vertices and straighter edges compared to RawContours.

The voxels produced by rasterizing the source geometry into walkable and unwalkable areas.

Specify which of the temporary data generated while building the NavMesh should be retained in memory after the process has completed.

Specify which types of debug data to collect when building the NavMesh.

Navigation mesh builder interface.

Builds a NavMesh data object from the provided input sources.

Settings for the bake process, see NavMeshBuildSettings. List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid. Bounding box relative to position and rotation which describes the volume where the NavMesh should be built. Empty bounds is treated as no bounds, i.e. the NavMesh will cover all the inputs. Center of the NavMeshData. This specifies the origin for the NavMesh tiles (See Also: NavMeshBuildSettings.tileSize). Orientation of the NavMeshData, you can use this to generate NavMesh with an arbitrary up-vector – e.g. for walkable vertical surfaces. Returns a newly built NavMeshData, or null if the NavMeshData was empty or an error occurred. The newly built NavMeshData, or null if the NavMeshData was empty or an error occurred.

Cancels an asynchronous update of the specified NavMesh data. See Also: UpdateNavMeshDataAsync.

The data associated with asynchronous updating.

Collects renderers or physics colliders, and terrains within a volume.

The queried objects must overlap these bounds to be included in the results. Specifies which layers are included in the query. Which type of geometry to collect - e.g. physics colliders. Area type to assign to results, unless modified by NavMeshMarkup. List of markups which allows finer control over how objects are collected. List where results are stored, the list is cleared at the beginning of the call.

Collects renderers or physics colliders, and terrains within a transform hierarchy.

If not null, consider only root and its children in the query; if null, includes everything loaded. Specifies which layers are included in the query. Which type of geometry to collect - e.g. physics colliders. Area type to assign to results, unless modified by NavMeshMarkup. List of markups which allows finer control over how objects are collected. List where results are stored, the list is cleared at the beginning of the call.

Incrementally updates the NavMeshData based on the sources.

The NavMeshData to update. The build settings which is used to update the NavMeshData. The build settings is also hashed along with the data, so changing settings will cause a full rebuild. List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid. Bounding box relative to position and rotation which describes the volume where the NavMesh should be built. Empty bounds is treated as no-bounds, that is, the NavMesh will cover all the inputs. Returns true if the update was successful.

Asynchronously and incrementally updates the NavMeshData based on the sources.

The NavMeshData to update. The build settings which is used to update the NavMeshData. The build settings is also hashed along with the data, so changing settings will likely to cause full rebuild. List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid. Bounding box relative to position and rotation which describes to volume where the NavMesh should be built. Empty bounds is treated as no-bounds, that is, the NavMesh will cover all the inputs. Can be used to check the progress of the update.

The NavMesh build markup allows you to control how certain objects are treated during the NavMesh build process, specifically when collecting sources for building.

The area type to use when override area is enabled.

Use this to specify whether the GameObject and its children should be ignored.

Use this to specify whether the area type of the GameObject and its children should be overridden by the area type specified in this struct.

Use this to specify which GameObject (including the GameObject’s children) the markup should be applied to.

The NavMeshBuildSettings struct allows you to specify a collection of settings which describe the dimensions and limitations of a particular agent type.

The maximum vertical step size an agent can take.

The height of the agent for baking in world units.

The radius of the agent for baking in world units.

The maximum slope angle which is walkable (angle in degrees).

The agent type ID the NavMesh will be baked for.

Options for collecting debug data during the build process.

The approximate minimum area of individual NavMesh regions.

Enables overriding the default tile size. See Also: tileSize.

Enables overriding the default voxel size. See Also: voxelSize.

Sets the tile size in voxel units.

Sets the voxel size in world length units.

Validates the properties of NavMeshBuildSettings.

Describes the volume to build NavMesh for. The list of violated constraints.

The input to the NavMesh builder is a list of NavMesh build sources.

Describes the area type of the NavMesh surface for this object.

Points to the owning component - if available, otherwise null.

The type of the shape this source describes. See Also: NavMeshBuildSourceShape.

Describes the dimensions of the shape.

Describes the object referenced for Mesh and Terrain types of input sources.

Describes the local to world transformation matrix of the build source. That is, position and orientation and scale of the shape.

Used with NavMeshBuildSource to define the shape for building NavMesh.

Describes a box primitive for use with NavMeshBuildSource.

Describes a capsule primitive for use with NavMeshBuildSource.

Describes a Mesh source for use with NavMeshBuildSource.

Describes a ModifierBox source for use with NavMeshBuildSource.

Describes a sphere primitive for use with NavMeshBuildSource.

Describes a TerrainData source for use with NavMeshBuildSource.

Used for specifying the type of geometry to collect. Used with NavMeshBuilder.CollectSources.

Collect geometry from the 3D physics collision representation.

Collect meshes form the rendered geometry.

Contains and represents NavMesh data.

Gets or sets the world space position of the NavMesh data.

Gets or sets the orientation of the NavMesh data.

Returns the bounding volume of the input geometry used to build this NavMesh (Read Only).

Constructs a new object for representing a NavMesh for the default agent type.

Constructs a new object representing a NavMesh for the specified agent type.

The agent type ID to create a NavMesh for.

The instance is returned when adding NavMesh data.

Get or set the owning Object.

True if the NavMesh data is added to the navigation system - otherwise false (Read Only).

Removes this instance from the NavMesh system.

Result information for NavMesh queries.

Distance to the point of hit.

Flag set when hit.

Mask specifying NavMesh area at point of hit.

Normal at the point of hit.

Position of hit.

Used for runtime manipulation of links connecting polygons of the NavMesh.

Specifies which agent type this link is available for.

Area type of the link.

If true, the link can be traversed in both directions, otherwise only from start to end position.

If positive, overrides the pathfinder cost to traverse the link.

End position of the link.

Start position of the link.

If positive, the link will be rectangle aligned along the line from start to end.

An instance representing a link available for pathfinding.

Get or set the owning Object.

True if the NavMesh link is added to the navigation system - otherwise false (Read Only).

Removes this instance from the game.

An obstacle for NavMeshAgents to avoid.

Should this obstacle be carved when it is constantly moving?

Should this obstacle make a cut-out in the navmesh.

Threshold distance for updating a moving carved hole (when carving is enabled).

Time to wait until obstacle is treated as stationary (when carving and carveOnlyStationary are enabled).

The center of the obstacle, measured in the object's local space.

Height of the obstacle's cylinder shape.

Radius of the obstacle's capsule shape.

The shape of the obstacle.

The size of the obstacle, measured in the object's local space.

Velocity at which the obstacle moves around the NavMesh.

Shape of the obstacle.

Box shaped obstacle.

Capsule shaped obstacle.

A path as calculated by the navigation system.

Corner points of the path. (Read Only)

Status of the path. (Read Only)

Erase all corner points from path.

NavMeshPath constructor.

Calculate the corners for the path.

Array to store path corners. The number of corners along the path - including start and end points.

Status of path.

The path terminates at the destination.

The path is invalid.

The path cannot reach the destination.

Specifies which agent type and areas to consider when searching the NavMesh.

The agent type ID, specifying which navigation meshes to consider for the query functions.

A bitmask representing the traversable area types.

Returns the area cost multiplier for the given area type for this filter.

Index to retreive the cost for. The cost multiplier for the supplied area index.

Sets the pathfinding cost multiplier for this filter for a given area type.

The area index to set the cost for. The cost for the supplied area index.

Contains data describing a triangulation of a navmesh.

NavMesh area indices for the navmesh triangulation.

Triangle indices for the navmesh triangulation.

NavMeshLayer values for the navmesh triangulation.

Vertices for the navmesh triangulation.

Level of obstacle avoidance.

Good avoidance. High performance impact.

Enable highest precision. Highest performance impact.

Enable simple avoidance. Low performance impact.

Medium avoidance. Medium performance impact.

Disable avoidance.

Link allowing movement outside the planar navigation mesh.

Is link active.

NavMesh area index for this OffMeshLink component.

Automatically update endpoints.

Can link be traversed in both directions.

Modify pathfinding cost for the link.

The transform representing link end position.

NavMeshLayer for this OffMeshLink component.

Is link occupied. (Read Only)

The transform representing link start position.

Explicitly update the link endpoints.

State of OffMeshLink.

Is link active (Read Only).

Link end world position (Read Only).

Link type specifier (Read Only).

The OffMeshLink if the link type is a manually placed Offmeshlink (Read Only).

Link start world position (Read Only).

Is link valid (Read Only).

Link type specifier.

Vertical drop.

Horizontal jump.

Manually specified type of link.

Unity Analytics provides insight into your game users e.g. DAU, MAU.

Controls whether the sending of device stats at runtime is enabled.

Controls whether the Analytics service is enabled at runtime.

Controls whether to limit user tracking at runtime.

Custom Events (optional).

Name of custom event. Name cannot include the prefix "unity." - This is a reserved keyword. Additional parameters sent to Unity Analytics at the time the custom event was triggered. Dictionary key cannot include the prefix "unity." - This is a reserved keyword.

Custom Events (optional).

Attempts to flush immediately all queued analytics events to the network and filesystem cache if possible (optional).

User Demographics (optional).

Birth year of user. Must be 4-digit year format, only.

User Demographics (optional).

Gender of user can be "Female", "Male", or "Unknown".

User Demographics (optional).

User id.

Tracking Monetization (optional).

The id of the purchased item. The price of the item. Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. Set to true when using UnityIAP.

Tracking Monetization (optional).

Analytics API result.

Analytics API result: Analytics is disabled.

Analytics API result: Invalid argument value.

Analytics API result: Analytics not initialized.

Analytics API result: Success.

Analytics API result: Argument size limit.

Analytics API result: Too many parameters.

Analytics API result: Too many requests.

Analytics API result: This platform doesn't support Analytics.

Accesses for Analytics session information (common for all game instances).

Session time since the begining of player game session.

Session id is used for tracking player game session.

Session state.

This event occurs when a Analytics session state changes.

UserId is random GUID to track a player and is persisted across game session.

This event occurs when a Analytics session state changes.

Current session state. Current session id. Game player current session time. Set to true when sessionId has changed.

Session tracking states.

Session tracking has paused.

Session tracking has resumed.

Session tracking has started.

Session tracking has stopped.

User Demographics: Gender of a user.

User Demographics: Female Gender of a user.

User Demographics: Male Gender of a user.

User Demographics: Unknown Gender of a user.

Unity Performace provides insight into your game performace.

Controls whether the Performance Reporting service is enabled at runtime.

ActivityIndicator Style (Android Specific).

Do not show ActivityIndicator.

Large Inversed (android.R.attr.progressBarStyleLargeInverse).

Small Inversed (android.R.attr.progressBarStyleSmallInverse).

Large (android.R.attr.progressBarStyleLarge).

Small (android.R.attr.progressBarStyleSmall).

AndroidInput provides support for off-screen touch input, such as a touchpad.

Property indicating whether the system provides secondary touch input.

Property indicating the height of the secondary touchpad.

Property indicating the width of the secondary touchpad.

Number of secondary touches. Guaranteed not to change throughout the frame. (Read Only).

Returns object representing status of a specific touch on a secondary touchpad (Does not allocate temporary variables).

AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class.

Construct an AndroidJavaClass from the class name.

Specifies the Java class name (e.g. <tt>java.lang.String</tt>).

AndroidJavaObject is the Unity representation of a generic instance of java.lang.Object.

Calls a Java method on an object (non-static).

Specifies which method to call. An array of parameters passed to the method.

Call a Java method on an object.

Specifies which method to call. An array of parameters passed to the method.

Call a static Java method on a class.

Specifies which method to call. An array of parameters passed to the method.

Call a static Java method on a class.

Specifies which method to call. An array of parameters passed to the method.

Construct an AndroidJavaObject based on the name of the class.

Specifies the Java class name (e.g. "<tt>java.lang.String<tt>" or "<tt>javalangString<tt>"). An array of parameters passed to the constructor.

IDisposable callback.

Get the value of a field in an object (non-static).

The name of the field (e.g. int counter; would have fieldName = "counter").

Retrieves the raw <tt>jclass</tt> pointer to the Java class. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Retrieves the raw <tt>jobject</tt> pointer to the Java object. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Get the value of a static field in an object type.

The name of the field (e.g. int counter; would have fieldName = "counter").

Set the value of a field in an object (non-static).

The name of the field (e.g. int counter; would have fieldName = "counter"). The value to assign to the field. It has to match the field type.

Set the value of a static field in an object type.

The name of the field (e.g. int counter; would have fieldName = "counter"). The value to assign to the field. It has to match the field type.

'Raw' JNI interface to Android Dalvik (Java) VM from Mono (CS/JS). Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Allocates a new Java object without invoking any of the constructors for the object.

Attaches the current thread to a Java (Dalvik) VM.

Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method.

Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method.

Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method.

Deletes the global reference pointed to by <tt>obj</tt>.

Deletes the local reference pointed to by <tt>obj</tt>.

Detaches the current thread from a Java (Dalvik) VM.

Ensures that at least a given number of local references can be created in the current thread.

Clears any exception that is currently being thrown.

Prints an exception and a backtrace of the stack to the <tt>logcat</tt>

Determines if an exception is being thrown.

Raises a fatal error and does not expect the VM to recover. This function does not return.

This function loads a locally-defined class.

Convert a Java array of <tt>boolean</tt> to a managed array of System.Boolean.

Convert a Java array of <tt>byte</tt> to a managed array of System.Byte.

Convert a Java array of <tt>char</tt> to a managed array of System.Char.

Convert a Java array of <tt>double</tt> to a managed array of System.Double.

Convert a Java array of <tt>float</tt> to a managed array of System.Single.

Convert a Java array of <tt>int</tt> to a managed array of System.Int32.

Convert a Java array of <tt>long</tt> to a managed array of System.Int64.

Convert a Java array of <tt>java.lang.Object</tt> to a managed array of System.IntPtr, representing Java objects.

Converts a <tt>java.lang.reflect.Field</tt> to a field ID.

Converts a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object to a method ID.

Convert a Java array of <tt>short</tt> to a managed array of System.Int16.

Returns the number of elements in the array.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the field ID for an instance (nonstatic) field of a class.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the method ID for an instance (nonstatic) method of a class or interface.

Returns an element of an <tt>Object</tt> array.

Returns the class of an object.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

This function returns the value of a static field of an object.

Returns the field ID for a static field of a class.

This function returns the value of a static field of an object.

Returns the method ID for a static method of a class.

This function returns the value of a static field of an object.

This function returns the value of an instance (nonstatic) field of an object.

Returns a managed string object representing the string in modified UTF-8 encoding.

Returns the length in bytes of the modified UTF-8 representation of a string.

If <tt>clazz<tt> represents any class other than the class <tt>Object<tt>, then this function returns the object that represents the superclass of the class specified by <tt>clazz</tt>.

Returns the version of the native method interface.

Determines whether an object of <tt>clazz1<tt> can be safely cast to <tt>clazz2<tt>.

Tests whether an object is an instance of a class.

Tests whether two references refer to the same Java object.

Construct a new primitive array object.

Creates a new global reference to the object referred to by the <tt>obj</tt> argument.

Construct a new primitive array object.

Creates a new local reference that refers to the same object as <tt>obj</tt>.

Construct a new primitive array object.

Constructs a new Java object. The method ID indicates which constructor method to invoke. This ID must be obtained by calling GetMethodID() with <init> as the method name and void (V) as the return type.

Constructs a new array holding objects in class <tt>clazz<tt>. All elements are initially set to <tt>obj<tt>.

Construct a new primitive array object.

Constructs a new <tt>java.lang.String</tt> object from an array of characters in modified UTF-8 encoding.

Pops off the current local reference frame, frees all the local references, and returns a local reference in the previous local reference frame for the given <tt>result</tt> object.

Creates a new local reference frame, in which at least a given number of local references can be created.

Sets the value of one element in a primitive array.

The array of native booleans. Index of the array element to set. The value to set - for 'true' use 1, for 'false' use 0.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets an element of an <tt>Object</tt> array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

This function ets the value of a static field of an object.

This function sets the value of an instance (nonstatic) field of an object.

Causes a <tt>java.lang.Throwable</tt> object to be thrown.

Constructs an exception object from the specified class with the <tt>message</tt> specified by message and causes that exception to be thrown.

Convert a managed array of System.Boolean to a Java array of <tt>boolean</tt>.

Convert a managed array of System.Byte to a Java array of <tt>byte</tt>.

Convert a managed array of System.Char to a Java array of <tt>char</tt>.

Convert a managed array of System.Double to a Java array of <tt>double</tt>.

Convert a managed array of System.Single to a Java array of <tt>float</tt>.

Convert a managed array of System.Int32 to a Java array of <tt>int</tt>.

Convert a managed array of System.Int64 to a Java array of <tt>long</tt>.

Convert a managed array of System.IntPtr, representing Java objects, to a Java array of <tt>java.lang.Object</tt>.

Converts a field ID derived from cls to a <tt>java.lang.reflect.Field</tt> object.

Converts a method ID derived from clazz to a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object.

Convert a managed array of System.Int16 to a Java array of <tt>short</tt>.

Helper interface for JNI interaction; signature creation and method lookups. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Set debug to true to log calls through the AndroidJNIHelper.

Creates a managed array from a Java array.

Java array object to be converted into a managed array.

Creates a Java array from a managed array.

Managed array to be converted into a Java array object.

Creates a java proxy object which connects to the supplied proxy implementation.

An implementatinon of a java interface in c#.

Creates a UnityJavaRunnable object (implements java.lang.Runnable).

A delegate representing the java.lang.Runnable.

Creates the parameter array to be used as argument list when invoking Java code through CallMethod() in AndroidJNI.

An array of objects that should be converted to Call parameters.

Deletes any local jni references previously allocated by CreateJNIArgArray().

The array of arguments used as a parameter to CreateJNIArgArray(). The array returned by CreateJNIArgArray().

Scans a particular Java class for a constructor method matching a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature).

Scans a particular Java class for a constructor method matching a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature).

Get a JNI method ID for a constructor based on calling arguments.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Array with parameters to be passed to the constructor when invoked.

Scans a particular Java class for a field matching a name and a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the field as declared in Java. Field signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields.

Scans a particular Java class for a field matching a name and a signature.

Get a JNI field ID based on type detection. Generic parameter represents the field type.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the field as declared in Java. Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields.

Scans a particular Java class for a method matching a name and a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the method as declared in Java. Method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods.

Scans a particular Java class for a method matching a name and a signature.

Get a JNI method ID based on calling arguments.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the method as declared in Java. Array with parameters to be passed to the method when invoked. Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods.

Get a JNI method ID based on calling arguments.

Creates the JNI signature string for particular object type.

Object for which a signature is to be produced.

Creates the JNI signature string for an object parameter list.

Array of object for which a signature is to be produced.

Creates the JNI signature string for an object parameter list.

Array of object for which a signature is to be produced.

The animation component is used to play back animations.

When turned on, Unity might stop animating if it thinks that the results of the animation won't be visible to the user.

When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies.

The default animation.

Controls culling of this Animation component.

Are we playing any animations?

AABB of this Animation animation component in local space.

Should the default animation clip (the Animation.clip property) automatically start playing on startup?

How should time beyond the playback range of the clip be treated?

Adds a clip to the animation with name newName.

Adds clip to the only play between firstFrame and lastFrame. The new clip will also be added to the animation with name newName.

Should an extra frame be inserted at the end that matches the first frame? Turn this on if you are making a looping animation.

Adds clip to the only play between firstFrame and lastFrame. The new clip will also be added to the animation with name newName.

Should an extra frame be inserted at the end that matches the first frame? Turn this on if you are making a looping animation.

Blends the animation named animation towards targetWeight over the next time seconds.

Fades the animation with name animation in over a period of time seconds and fades other animations out.

Cross fades an animation after previous animations has finished playing.

Get the number of clips currently assigned to this animation.

Is the animation named name playing?

Plays an animation without any blending.

Plays an animation after previous animations has finished playing.

Remove clip from the animation list.

Rewinds the animation named name.

Rewinds all animations.

Samples animations at the current state.

Stops all playing animations that were started with this Animation.

Stops an animation named name.

Returns the animation state named name.

Used by Animation.Play function.

Animations will be added.

Animations will be blended.

Stores keyframe based animations.

Returns true if the animation clip has no curves and no events.

Animation Events for this animation clip.

Frame rate at which keyframes are sampled. (Read Only)

Returns true if the animation contains curve that drives a humanoid rig.

Set to true if the AnimationClip will be used with the Legacy Animation component ( instead of the Animator ).

Animation length in seconds. (Read Only)

AABB of this Animation Clip in local space of Animation component that it is attached too.

Sets the default wrap mode used in the animation state.

Adds an animation event to the clip.

AnimationEvent to add.

Clears all curves from the clip.

Creates a new animation clip.

Realigns quaternion keys to ensure shortest interpolation paths.

Samples an animation at a given time for any animated properties.

The animated game object. The time to sample an animation.

Assigns the curve to animate a specific property.

Path to the game object this curve applies to. The relativePath is formatted similar to a pathname, e.g. "rootspineleftArm". If relativePath is empty it refers to the game object the animation clip is attached to. The class type of the component that is animated. The name or path to the property being animated. The animation curve.

This class defines a pair of clips used by AnimatorOverrideController.

The original clip from the controller.

The override animation clip.

This enum controlls culling of Animation component.

Animation culling is disabled - object is animated even when offscreen.

Animation is disabled when renderers are not visible.

Store a collection of Keyframes that can be evaluated over time.

All keys defined in the animation curve.

The number of keys in the curve. (Read Only)

The behaviour of the animation after the last keyframe.

The behaviour of the animation before the first keyframe.

Add a new key to the curve.

The time at which to add the key (horizontal axis in the curve graph). The value for the key (vertical axis in the curve graph). The index of the added key, or -1 if the key could not be added.

Add a new key to the curve.

The key to add to the curve. The index of the added key, or -1 if the key could not be added.

Creates a constant "curve" starting at timeStart, ending at timeEnd and with the value value.

The start time for the constant curve. The start time for the constant curve. The value for the constant curve. The constant curve created from the specified values.

Creates an animation curve from an arbitrary number of keyframes.

An array of Keyframes used to define the curve.

Creates an empty animation curve.

Creates an ease-in and out curve starting at timeStart, valueStart and ending at timeEnd, valueEnd.

The start time for the ease curve. The start value for the ease curve. The end time for the ease curve. The end value for the ease curve. The ease-in and out curve generated from the specified values.

Evaluate the curve at time.

The time within the curve you want to evaluate (the horizontal axis in the curve graph). The value of the curve, at the point in time specified.

A straight Line starting at timeStart, valueStart and ending at timeEnd, valueEnd.

The start time for the linear curve. The start value for the linear curve. The end time for the linear curve. The end value for the linear curve. The linear curve created from the specified values.

Removes the keyframe at index and inserts key.

The index of the key to move. The key (with its new time) to insert. The index of the keyframe after moving it.

Removes a key.

The index of the key to remove.

Smooth the in and out tangents of the keyframe at index.

The index of the keyframe to be smoothed. The smoothing weight to apply to the keyframe's tangents.

Retrieves the key at index. (Read Only)

AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation.

The animation state that fired this event (Read Only).

The animator clip info related to this event (Read Only).

The animator state info related to this event (Read Only).

Float parameter that is stored in the event and will be sent to the function.

The name of the function that will be called.

Int parameter that is stored in the event and will be sent to the function.

Returns true if this Animation event has been fired by an Animator component.

Returns true if this Animation event has been fired by an Animation component.

Function call options.

Object reference parameter that is stored in the event and will be sent to the function.

String parameter that is stored in the event and will be sent to the function.

The time at which the event will be fired off.

Creates a new animation event.

Information about what animation clips is played and its weight.

Animation clip that is played.

The weight of the animation clip.

A Playable that controls an AnimationClip.

Creates an AnimationClipPlayable in the PlayableGraph.

The PlayableGraph object that will own the AnimationClipPlayable. The AnimationClip that will be added in the PlayableGraph. A AnimationClipPlayable linked to the PlayableGraph.

Returns the AnimationClip stored in the AnimationClipPlayable.

Returns the state of the ApplyFootIK flag.

Sets the value of the ApplyFootIK flag.

The new value of the ApplyFootIK flag.

An implementation of IPlayable that controls an animation layer mixer.

Creates an AnimationLayerMixerPlayable in the PlayableGraph.

The PlayableGraph that will contain the new AnimationLayerMixerPlayable. The number of layers. A new AnimationLayerMixerPlayable linked to the PlayableGraph.

Returns true if the layer is additive, false otherwise.

The layer index. True if the layer is additive, false otherwise.

Returns an invalid AnimationLayerMixerPlayable.

Specifies whether a layer is additive or not. Additive layers blend with previous layers.

The layer index. Whether the layer is additive or not. Set to true for an additive blend, or false for a regular blend.

Sets the mask for the current layer.

The layer index. The AvatarMask used to create the new LayerMask.

An implementation of IPlayable that controls an animation mixer.

Creates an AnimationMixerPlayable in the PlayableGraph.

The PlayableGraph that will contain the new AnimationMixerPlayable. The number of inputs that the mixer will update. True to force a weight normalization of the inputs. A new AnimationMixerPlayable linked to the PlayableGraph.

A IPlayableOutput implementation that connects the PlayableGraph to an Animator in the scene.

Creates an AnimationPlayableOutput in the PlayableGraph.

The PlayableGraph that will contain the AnimationPlayableOutput. The name of the output. The Animator that will process the PlayableGraph. A new AnimationPlayableOutput attached to the PlayableGraph.

Returns the Animator that plays the animation graph.

The targeted Animator.

Sets the Animator that plays the animation graph.

The targeted Animator.

An implementation of IPlayable that controls an animation RuntimeAnimatorController.

Creates an AnimatorControllerPlayable in the PlayableGraph.

The PlayableGraph object that will own the AnimatorControllerPlayable. The RuntimeAnimatorController that will be added in the graph. A AnimatorControllerPlayable.

Returns an invalid AnimatorControllerPlayable.

The AnimationState gives full control over animation blending.

Which blend mode should be used?

The clip that is being played by this animation state.

Enables / disables the animation.

The length of the animation clip in seconds.

The name of the animation.

The normalized playback speed.

The normalized time of the animation.

The playback speed of the animation. 1 is normal playback speed.

The current time of the animation.

The weight of animation.

Wrapping mode of the animation.

Adds a transform which should be animated. This allows you to reduce the number of animations you have to create.

The transform to animate. Whether to also animate all children of the specified transform.

Adds a transform which should be animated. This allows you to reduce the number of animations you have to create.

The transform to animate. Whether to also animate all children of the specified transform.

Removes a transform which should be animated.

Interface to control the Mecanim animation system.

Gets the avatar angular velocity for the last evaluated frame.

When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies.

Should root motion be applied?

Gets/Sets the current Avatar.

The position of the body center of mass.

The rotation of the body center of mass.

Controls culling of this Animator component.

Gets the avatar delta position for the last evaluated frame.

Gets the avatar delta rotation for the last evaluated frame.

Blends pivot point between body center of mass and feet pivot. At 0%, the blending point is body center of mass. At 100%, the blending point is feet pivot.

The current gravity weight based on current animations that are played.

Returns true if Animator has any playables assigned to it.

Returns true if the current rig has root motion.

Returns true if the object has a transform hierarchy.

Returns the scale of the current Avatar for a humanoid rig, (1 by default if the rig is generic).

Returns true if the current rig is humanoid, false if it is generic.

Returns whether the animator is initialized successfully.

If automatic matching is active.

Returns true if the current rig is optimizable with AnimatorUtility.OptimizeTransformHierarchy.

See IAnimatorControllerPlayable.layerCount.

Additional layers affects the center of mass.

Get left foot bottom height.

When linearVelocityBlending is set to true, the root motion velocity and angular velocity will be blended linearly.

See IAnimatorControllerPlayable.parameterCount.

Read only acces to the AnimatorControllerParameters used by the animator.

Get the current position of the pivot.

Gets the pivot weight.

The PlayableGraph created by the Animator.

Sets the playback position in the recording buffer.

Gets the mode of the Animator recorder.

Start time of the first frame of the buffer relative to the frame at which StartRecording was called.

End time of the recorded clip relative to when StartRecording was called.

Get right foot bottom height.

The root position, the position of the game object.

The root rotation, the rotation of the game object.

The runtime representation of AnimatorController that controls the Animator.

The playback speed of the Animator. 1 is normal playback speed.

Automatic stabilization of feet during transition and blending.

Returns the position of the target specified by SetTarget(AvatarTarget targetIndex, float targetNormalizedTime)).

Returns the rotation of the target specified by SetTarget(AvatarTarget targetIndex, float targetNormalizedTime)).

Specifies the update mode of the Animator.

Gets the avatar velocity for the last evaluated frame.

Apply the default Root Motion.

Creates a crossfade from the current state to any other state using normalized times.

The name of the state. The hash name of the state. The duration of the transition (normalized). The layer where the crossfade occurs. The time of the state (normalized). The time of the transition (normalized).

Creates a crossfade from the current state to any other state using normalized times.

Creates a crossfade from the current state to any other state using times in seconds.

The name of the state. The hash name of the state. The duration of the transition (in seconds). The layer where the crossfade occurs. The time of the state (in seconds). The time of the transition (normalized).

Creates a crossfade from the current state to any other state using times in seconds.

See IAnimatorControllerPlayable.GetAnimatorTransitionInfo.

Return the first StateMachineBehaviour that match type T or derived from T. Return null if none are found.

Returns all StateMachineBehaviour that match type T or are derived from T. Returns null if none are found.

Returns transform mapped to this human bone id.

The human bone that is queried, see enum HumanBodyBones for a list of possible values.

See IAnimatorControllerPlayable.GetBool.

Gets the list of AnimatorClipInfo currently played by the current state.

The layer's index.

Access the current Animation clip’s information from the Animator.

Get a list of AnimatorClipInfo from the Animator.

See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfoCount.

See IAnimatorControllerPlayable.GetCurrentAnimatorStateInfo.

See IAnimatorControllerPlayable.GetFloat.

Gets the position of an IK hint.

The AvatarIKHint that is queried. Return the current position of this IK hint in world space.

Gets the translative weight of an IK Hint (0 = at the original animation before IK, 1 = at the hint).

The AvatarIKHint that is queried. Return translative weight.

Gets the position of an IK goal.

The AvatarIKGoal that is queried. Return the current position of this IK goal in world space.

Gets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the goal).

The AvatarIKGoal that is queried.

Gets the rotation of an IK goal.

The AvatarIKGoal that is is queried.

Gets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal).

The AvatarIKGoal that is queried.

See IAnimatorControllerPlayable.GetInteger.

See IAnimatorControllerPlayable.GetLayerIndex.

See IAnimatorControllerPlayable.GetLayerName.

See IAnimatorControllerPlayable.GetLayerWeight.

Gets the list of AnimatorClipInfo currently played by the next state.

The layer's index.

See IAnimatorControllerPlayable.GetNextAnimatorClipInfo.

See IAnimatorControllerPlayable.GetNextAnimatorClipInfoCount.

See IAnimatorControllerPlayable.GetNextAnimatorStateInfo.

See AnimatorController.GetParameter.

Gets the value of a quaternion parameter.

The name of the parameter.

Gets the value of a quaternion parameter.

The id of the parameter. The id is generated using Animator::StringToHash.

Gets the value of a vector parameter.

The name of the parameter.

Gets the value of a vector parameter.

The id of the parameter. The id is generated using Animator::StringToHash.

See IAnimatorControllerPlayable.HasState.

Interrupts the automatic target matching.

Returns true if the transform is controlled by the Animator\.

The transform that is queried.

See IAnimatorControllerPlayable.IsInTransition.

See IAnimatorControllerPlayable.IsParameterControlledByCurve.

Automatically adjust the gameobject position and rotation so that the AvatarTarget reaches the matchPosition when the current state is at the specified progress.

The position we want the body part to reach. The rotation in which we want the body part to be. The body part that is involved in the match. Structure that contains weights for matching position and rotation. Start time within the animation clip (0 - beginning of clip, 1 - end of clip). End time within the animation clip (0 - beginning of clip, 1 - end of clip), values greater than 1 can be set to trigger a match after a certain number of loops. Ex: 2.3 means at 30% of 2nd loop.

See IAnimatorControllerPlayable.Play.

See IAnimatorControllerPlayable.PlayInFixedTime.

Rebind all the animated properties and mesh data with the Animator.

See IAnimatorControllerPlayable.ResetTrigger.

Sets local rotation of a human bone during a IK pass.

The human bone Id. The local rotation.

Sets an Animator bool parameter.

Send float values to the Animator to affect transitions.

Sets the position of an IK hint.

The AvatarIKHint that is set. The position in world space.

Sets the translative weight of an IK hint (0 = at the original animation before IK, 1 = at the hint).

The AvatarIKHint that is set. The translative weight.

Sets the position of an IK goal.

The AvatarIKGoal that is set. The position in world space.

Sets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the goal).

The AvatarIKGoal that is set. The translative weight.

Sets the rotation of an IK goal.

The AvatarIKGoal that is set. The rotation in world space.

Sets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal).

The AvatarIKGoal that is set. The rotational weight.

See IAnimatorControllerPlayable.SetInteger.

See IAnimatorControllerPlayable.SetLayerWeight.

Sets the look at position.

The position to lookAt.

Set look at weights.

(0-1) the global weight of the LookAt, multiplier for other parameters. (0-1) determines how much the body is involved in the LookAt. (0-1) determines how much the head is involved in the LookAt. (0-1) determines how much the eyes are involved in the LookAt. (0-1) 0.0 means the character is completely unrestrained in motion, 1.0 means he's completely clamped (look at becomes impossible), and 0.5 means he'll be able to move on half of the possible range (180 degrees).

Set look at weights.

Sets the value of a quaternion parameter.

The name of the parameter. The new value for the parameter.

Sets the value of a quaternion parameter.

Of the parameter. The id is generated using Animator::StringToHash. The new value for the parameter.

Sets an AvatarTarget and a targetNormalizedTime for the current state.

The avatar body part that is queried. The current state Time that is queried.

See IAnimatorControllerPlayable.SetTrigger.

Sets the value of a vector parameter.

The name of the parameter. The new value for the parameter.

Sets the value of a vector parameter.

The id of the parameter. The id is generated using Animator::StringToHash. The new value for the parameter.

Sets the animator in playback mode.

Sets the animator in recording mode, and allocates a circular buffer of size frameCount.

The number of frames (updates) that will be recorded. If frameCount is 0, the recording will continue until the user calls StopRecording. The maximum value for frameCount is 10000.

Stops the animator playback mode. When playback stops, the avatar resumes getting control from game logic.

Stops animator record mode.

Generates an parameter id from a string.

The string to convert to Id.

Evaluates the animator based on deltaTime.

The time delta.

Information about clip being played and blended by the Animator.

Returns the animation clip played by the Animator.

Returns the blending weight used by the Animator to blend this clip.

Used to communicate between scripting and the controller. Some parameters can be set in scripting and used by the controller, while other parameters are based on Custom Curves in Animation Clips and can be sampled using the scripting API.

The default bool value for the parameter.

The default float value for the parameter.

The default int value for the parameter.

The name of the parameter.

Returns the hash of the parameter based on its name.

The type of the parameter.

Boolean type parameter.

Float type parameter.

Int type parameter.

Trigger type parameter.

Culling mode for the Animator.

Always animate the entire character. Object is animated even when offscreen.

Animation is completely disabled when renderers are not visible.

Retarget, IK and write of Transforms are disabled when renderers are not visible.

Interface to control Animator Override Controller.

Returns the list of orignal Animation Clip from the controller and their override Animation Clip.

Returns the count of overrides.

The Runtime Animator Controller that the Animator Override Controller overrides.

Applies the list of overrides on this Animator Override Controller.

Overrides list to apply.

Creates an empty Animator Override Controller.

Creates an Animator Override Controller that overrides controller.

Runtime Animator Controller to override.

Gets the list of Animation Clip overrides currently defined in this Animator Override Controller.

Array to receive results.

Returns either the overriding Animation Clip if set or the original Animation Clip named name.

The mode of the Animator's recorder.

The Animator recorder is offline.

The Animator recorder is in Playback.

The Animator recorder is in Record.

Information about the current or next state.

The full path hash for this state.

Current duration of the state.

Is the state looping.

The hashed name of the State.

Normalized time of the State.

The hash is generated using Animator::StringToHash. The string to pass doest not include the parent layer's name.

The playback speed of the animation. 1 is the normal playback speed.

The speed multiplier for this state.

The Tag of the State.

Does name match the name of the active state in the statemachine?

Does tag match the tag of the active state in the statemachine.

Information about the current transition.

Returns true if the transition is from an AnyState node, or from Animator.CrossFade().

Duration of the transition.

The unit of the transition duration.

The hash name of the Transition.

The simplified name of the Transition.

Normalized time of the Transition.

The user-specified name of the Transition.

Does name match the name of the active Transition.

Does userName match the name of the active Transition.

The update mode of the Animator.

Updates the animator during the physic loop in order to have the animation system synchronized with the physics engine.

Normal update of the animator.

Animator updates independently of Time.timeScale.

Various utilities for animator manipulation.

This function will recreate all transform hierarchy under GameObject.

GameObject to Deoptimize.

This function will remove all transform hierarchy under GameObject, the animator will write directly transform matrices into the skin mesh matrices saving alot of CPU cycles.

GameObject to Optimize. List of transform name to expose.

Access to application run-time data.

The URL of the document (what is shown in a browser's address bar) for WebGL (Read Only).

Priority of background loading thread.

Returns a GUID for this build (Read Only).

A unique cloud project identifier. It is unique for every project (Read Only).

Return application company name (Read Only).

Contains the path to the game data folder (Read Only).

Returns false if application is altered in any way after it was built.

Returns true if application integrity can be confirmed.

Returns application identifier at runtime. On Apple platforms this is the 'bundleIdentifier' saved in the info.plist file, on Android it's the 'package' from the AndroidManifest.xml.

Returns the name of the store or package that installed the application (Read Only).

Returns application install mode (Read Only).

Returns the type of Internet reachability currently possible on the device.

Is the current Runtime platform a known console platform.

Are we running inside the Unity editor? (Read Only)

Whether the player currently has focus. Read-only.

Is some level being loaded? (Read Only)

Is the current Runtime platform a known mobile platform.

Returns true when in any kind of player (Read Only).

Checks whether splash screen is being shown.

Are we running inside a web player? (Read Only)

The total number of levels available (Read Only).

The level index that was last loaded (Read Only).

The name of the level that was last loaded (Read Only).

Event that is fired if a log message is received.

This event occurs when an iOS, Android, or Tizen device notifies of low memory while the app is running in the foreground. You can release non-critical assets from memory (such as, textures or audio clips) in response to this in order to avoid the app being terminated. You can also load smaller versions of such assets. Furthermore, you should serialize any transient data to permanent storage to avoid data loss if the app is terminated. This event corresponds to the following callbacks on the different platforms: - iOS: [UIApplicationDelegate applicationDidReceiveMemoryWarning] - Android: onLowMemory() and onTrimMemory(level == TRIM_MEMORY_RUNNING_CRITICAL) - Tizen: ui_app_add_event_handler with type APP_EVENT_LOW_MEMORY Here is an example of handling the callback:

Delegate method used to register for "Just Before Render" input updates for VR devices.

Contains the path to a persistent data directory (Read Only).

Returns the platform the game is running on (Read Only).

Returns application product name (Read Only).

Should the player be running when the application is in the background?

Returns application running in sandbox (Read Only).

The path to the web player data file relative to the html file (Read Only).

Stack trace logging options. The default value is StackTraceLogType.ScriptOnly.

How many bytes have we downloaded from the main unity web stream (Read Only).

Contains the path to the StreamingAssets folder (Read Only).

The language the user's operating system is running in.

Instructs game to try to render at a specified frame rate.

Contains the path to a temporary data / cache directory (Read Only).

The version of the Unity runtime used to play the content.

Returns application version number (Read Only).

Indicates whether Unity's webplayer security model is enabled.

Delegate method for fetching advertising ID.

Advertising ID. Indicates whether user has chosen to limit ad tracking. Error message.

Cancels quitting the application. This is useful for showing a splash screen at the end of a game.

Can the streamed level be loaded?

Captures a screenshot at path filename as a PNG file.

Pathname to save the screenshot file to. Factor by which to increase resolution.

Captures a screenshot at path filename as a PNG file.

Pathname to save the screenshot file to. Factor by which to increase resolution.

Calls a function in the web page that contains the WebGL Player.

Name of the function to call. Array of arguments passed in the call.

Execution of a script function in the contained web page.

The Javascript function to call.

Returns an array of feature tags in use for this build.

Get stack trace logging options. The default value is StackTraceLogType.ScriptOnly.

How far has the download progressed? [0...1].

Is Unity activated with the Pro license?

Check if the user has authorized use of the webcam or microphone in the Web Player.

Loads the level by its name or index.

The level to load. The name of the level to load.

Loads the level by its name or index.

The level to load. The name of the level to load.

Loads a level additively.

Loads the level additively and asynchronously in the background.

Loads the level asynchronously in the background.

Use this delegate type with Application.logMessageReceived or Application.logMessageReceivedThreaded to monitor what gets logged.

This is the delegate function when a mobile device notifies of low memory.

Opens the url in a browser.

Quits the player application.

Request advertising ID for iOS, Android and Windows Store.

Delegate method. Returns true if successful, or false for platforms which do not support Advertising Identifiers. In this case, the delegate method is not invoked.

Request authorization to use the webcam or microphone in the Web Player.

Set an array of feature tags for this build.

Set stack trace logging options. The default value is StackTraceLogType.ScriptOnly.

Unloads the Unity runtime.

Unloads all GameObject associated with the given scene. Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets.

Index of the scene in the PlayerSettings to unload. Name of the scene to Unload. Return true if the scene is unloaded.

Unloads all GameObject associated with the given scene. Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets.

Index of the scene in the PlayerSettings to unload. Name of the scene to Unload. Return true if the scene is unloaded.

Application installation mode (Read Only).

Application installed via ad hoc distribution.

Application installed via developer build.

Application running in editor.

Application installed via enterprise distribution.

Application installed via online store.

Application install mode unknown.

Application sandbox type.

Application not running in a sandbox.

Application is running in broken sandbox.

Application is running in a sandbox.

Application sandbox type is unknown.

AssetBundles let you stream additional assets via the UnityWebRequest class and instantiate them at runtime. AssetBundles are created via BuildPipeline.BuildAssetBundle.

Return true if the AssetBundle is a streamed scene AssetBundle.

Main asset that was supplied when building the asset bundle (Read Only).

Check if an AssetBundle contains a specific object.

Loads an asset bundle from a disk.

Path of the file on disk See Also: UnityWebRequest.GetAssetBundle, DownloadHandlerAssetBundle.

Asynchronously create an AssetBundle from a memory region.

Synchronously create an AssetBundle from a memory region.

Array of bytes with the AssetBundle data.

Return all asset names in the AssetBundle.

To use when you need to get a list of all the currently loaded Asset Bundles.

Returns IEnumerable<AssetBundle> of all currently loaded Asset Bundles.

Return all the scene asset paths (paths to *.unity assets) in the AssetBundle.

Loads all assets contained in the asset bundle that inherit from type.

Loads all assets contained in the asset bundle.

Loads all assets contained in the asset bundle that inherit from type T.

Loads all assets contained in the asset bundle asynchronously.

Loads all assets contained in the asset bundle that inherit from T asynchronously.

Loads all assets contained in the asset bundle that inherit from type asynchronously.

Loads asset with name from the bundle.

Loads asset with name of a given type from the bundle.

Loads asset with name of type T from the bundle.

Asynchronously loads asset with name from the bundle.

Asynchronously loads asset with name of a given T from the bundle.

Asynchronously loads asset with name of a given type from the bundle.

Loads asset and sub assets with name from the bundle.

Loads asset and sub assets with name of a given type from the bundle.

Loads asset and sub assets with name of type T from the bundle.

Loads asset with sub assets with name from the bundle asynchronously.

Loads asset with sub assets with name of type T from the bundle asynchronously.

Loads asset with sub assets with name of a given type from the bundle asynchronously.

Synchronously loads an AssetBundle from a file on disk.

Path of the file on disk. An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. An optional byte offset. This value specifies where to start reading the AssetBundle from. Loaded AssetBundle object or null if failed.

Synchronously loads an AssetBundle from a file on disk.

Asynchronously loads an AssetBundle from a file on disk.

Synchronously create an AssetBundle from a memory region.

Array of bytes with the AssetBundle data. An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. Loaded AssetBundle object or null if failed.

Asynchronously create an AssetBundle from a memory region.

Synchronously loads an AssetBundle from a managed Stream.

The managed Stream object. Unity calls Read(), Seek() and the Length property on this object to load the AssetBundle data. An optional CRC-32 checksum of the uncompressed content. An optional overide for the size of the read buffer size used whilst loading data. The default size is 32KB. The loaded AssetBundle object or null when the object fails to load.

Asynchronously loads an AssetBundle from a managed Stream.

The managed Stream object. Unity calls Read(), Seek() and the Length property on this object to load the AssetBundle data. An optional CRC-32 checksum of the uncompressed content. An optional overide for the size of the read buffer size used whilst loading data. The default size is 32KB. Asynchronous create request for an AssetBundle. Use AssetBundleCreateRequest.assetBundle property to get an AssetBundle once it is loaded.

Unloads all assets in the bundle.

Unloads all currently loaded Asset Bundles.

Determines whether the current instances of objects loaded from Asset Bundles will also be unloaded.

Asynchronous create request for an AssetBundle.

Asset object being loaded (Read Only).

Manifest for all the AssetBundles in the build.

Get all the AssetBundles in the manifest.

An array of asset bundle names.

Get all the AssetBundles with variant in the manifest.

An array of asset bundle names.

Get all the dependent AssetBundles for the given AssetBundle.

Name of the asset bundle.

Get the hash for the given AssetBundle.

Name of the asset bundle. The 128-bit hash for the asset bundle.

Get the direct dependent AssetBundles for the given AssetBundle.

Name of the asset bundle. Array of asset bundle names this asset bundle depends on.

Asynchronous load request from an AssetBundle.

Asset objects with sub assets being loaded. (Read Only)

Asset object being loaded (Read Only).

Asynchronous operation coroutine.

Allow scenes to be activated as soon as it is ready.

Event that is invoked upon operation completion. An event handler that is registered in the same frame as the call that creates it will be invoked next frame, even if the operation is able to complete synchronously. If a handler is registered after the operation has completed and has already invoked the complete event, the handler will be called synchronously.

Action<AsyncOperation> handler - function signature for completion event handler.

Has the operation finished? (Read Only)

Priority lets you tweak in which order async operation calls will be performed.

What's the operation's progress. (Read Only)

An implementation of IPlayable that controls an AudioClip.

Creates an AudioClipPlayable in the PlayableGraph.

The PlayableGraph that will contain the new AnimationLayerMixerPlayable. The AudioClip that will be added in the PlayableGraph. True if the clip should loop, false otherwise. A AudioClipPlayable linked to the PlayableGraph.

A IPlayableOutput implementation that will be used to play audio.

Creates an AudioPlayableOutput in the PlayableGraph.

The PlayableGraph that will contain the AnimationPlayableOutput. The name of the output. The AudioSource that will play the AudioPlayableOutput source Playable. A new AudioPlayableOutput attached to the PlayableGraph.

Returns an invalid AudioPlayableOutput.

The Audio High Pass Filter passes high frequencies of an AudioSource, and cuts off signals with frequencies lower than the Cutoff Frequency.

Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0.

Determines how much the filter's self-resonance isdampened.

The Audio Low Pass Filter passes low frequencies of an AudioSource or all sounds reaching an AudioListener, while removing frequencies higher than the Cutoff Frequency.

Returns or sets the current custom frequency cutoff curve.

Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0.

Determines how much the filter's self-resonance is dampened.

The Audio Reverb Filter takes an Audio Clip and distorts it to create a custom reverb effect.

Decay HF Ratio : High-frequency to low-frequency decay time ratio. Ranges from 0.1 to 2.0. Default is 0.5.

Reverberation decay time at low-frequencies in seconds. Ranges from 0.1 to 20.0. Default is 1.0.

Reverberation density (modal density) in percent. Ranges from 0.0 to 100.0. Default is 100.0.

Reverberation diffusion (echo density) in percent. Ranges from 0.0 to 100.0. Default is 100.0.

Mix level of dry signal in output in mB. Ranges from -10000.0 to 0.0. Default is 0.

Reference high frequency in Hz. Ranges from 20.0 to 20000.0. Default is 5000.0.

Reference low-frequency in Hz. Ranges from 20.0 to 1000.0. Default is 250.0.

Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0.

Early reflections level relative to room effect in mB. Ranges from -10000.0 to 1000.0. Default is -10000.0.

Late reverberation delay time relative to first reflection in seconds. Ranges from 0.0 to 0.1. Default is 0.04.

Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0.

Set/Get reverb preset properties.

Room effect level at low frequencies in mB. Ranges from -10000.0 to 0.0. Default is 0.0.

Room effect high-frequency level re. low frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0.

Room effect low-frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0.

Controls the global audio settings from script.

Returns the speaker mode capability of the current audio driver. (Read Only)

Returns the current time of the audio system.

Get the mixer's current output rate.

Gets the current speaker mode. Default is 2 channel stereo.

A delegate called whenever the global audio settings are changed, either by AudioSettings.Reset or by an external device change such as the OS control panel changing the sample rate or because the default output device was changed, for example when plugging in an HDMI monitor or a USB headset.

True if the change was caused by an device change.

Returns the current configuration of the audio device and system. The values in the struct may then be modified and reapplied via AudioSettings.Reset.

The new configuration to be applied.

Get the mixer's buffer size in samples.

Is the length of each buffer in the ringbuffer. Is number of buffers.

Returns the name of the spatializer selected on the currently-running platform.

The spatializer plugin name.

Returns an array with the names of all the available spatializer plugins.

An array of spatializer names.

A delegate called whenever the global audio settings are changed, either by AudioSettings.Reset or by an external factor such as the OS control panel changing the sample rate or because the default output device was changed, for example when plugging in an HDMI monitor or a USB headset.

True if the change was caused by an device change.

Performs a change of the device configuration. In response to this the AudioSettings.OnAudioConfigurationChanged delegate is invoked with the argument deviceWasChanged=false. It cannot be guaranteed that the exact settings specified can be used, but the an attempt is made to use the closest match supported by the system.

The new configuration to be used. True if all settings could be successfully applied.

Sets the spatializer plugin for all platform groups. If a null or empty string is passed in, the existing spatializer plugin will be cleared.

The spatializer plugin name.

A representation of audio sources in 3D.

Bypass effects (Applied from filter components or global listener filters).

When set global effects on the AudioListener will not be applied to the audio signal generated by the AudioSource. Does not apply if the AudioSource is playing into a mixer group.

When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones.

The default AudioClip to play.

Sets the Doppler scale for this AudioSource.

Allows AudioSource to play even though AudioListener.pause is set to true. This is useful for the menu element sounds or background music in pause menus.

This makes the audio source not take into account the volume of the audio listener.

Is the clip playing right now (Read Only)?

True if all sounds played by the AudioSource (main sound started by Play() or playOnAwake as well as one-shots) are culled by the audio system.

Is the audio clip looping?

(Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at.

Within the Min distance the AudioSource will cease to grow louder in volume.

Un- / Mutes the AudioSource. Mute sets the volume=0, Un-Mute restore the original volume.

The target group to which the AudioSource should route its signal.

Pan has been deprecated. Use panStereo instead.

PanLevel has been deprecated. Use spatialBlend instead.

Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo.

The pitch of the audio source.

If set to true, the audio source will automatically start playing on awake.

Sets the priority of the AudioSource.

The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones.

Sets/Gets how the AudioSource attenuates over distance.

Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D.

Enables or disables spatialization.

Determines if the spatializer effect is inserted before or after the effect filters.

Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space.

Playback position in seconds.

Playback position in PCM samples.

Whether the Audio Source should be updated in the fixed or dynamic update.

The volume of the audio source (0.0 to 1.0).

Reads a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource.

Zero-based index of user-defined parameter to be read. Return value of the user-defined parameter that is read. True, if the parameter could be read.

Get the current custom curve for the given AudioSourceCurveType.

The curve type to get. The custom AnimationCurve corresponding to the given curve type.

Provides a block of the currently playing source's output data.

The array to populate with audio samples. Its length must be a power of 2. The channel to sample from.

Deprecated Version. Returns a block of the currently playing source's output data.

Reads a user-defined parameter of a custom spatializer effect that is attached to an AudioSource.

Zero-based index of user-defined parameter to be read. Return value of the user-defined parameter that is read. True, if the parameter could be read.

Provides a block of the currently playing audio source's spectrum data.

The array to populate with audio samples. Its length must be a power of 2. The channel to sample from. The FFTWindow type to use when sampling.

Deprecated Version. Returns a block of the currently playing source's spectrum data.

The number of samples to retrieve. Must be a power of 2. The channel to sample from. The FFTWindow type to use when sampling.

Pauses playing the clip.

Plays the clip with an optional certain delay.

Delay in number of samples, assuming a 44100Hz sample rate (meaning that Play(44100) will delay the playing by exactly 1 sec).

Plays the clip with an optional certain delay.

Delay in number of samples, assuming a 44100Hz sample rate (meaning that Play(44100) will delay the playing by exactly 1 sec).

Plays an AudioClip at a given position in world space.

Audio data to play. Position in world space from which sound originates. Playback volume.

Plays an AudioClip at a given position in world space.

Audio data to play. Position in world space from which sound originates. Playback volume.

Plays the clip with a delay specified in seconds. Users are advised to use this function instead of the old Play(delay) function that took a delay specified in samples relative to a reference rate of 44.1 kHz as an argument.

Delay time specified in seconds.

Plays an AudioClip, and scales the AudioSource volume by volumeScale.

The clip being played. The scale of the volume (0-1).

Plays an AudioClip, and scales the AudioSource volume by volumeScale.

The clip being played. The scale of the volume (0-1).

Plays the clip at a specific time on the absolute time-line that AudioSettings.dspTime reads from.

Time in seconds on the absolute time-line that AudioSettings.dspTime refers to for when the sound should start playing.

Sets a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource.

Zero-based index of user-defined parameter to be set. New value of the user-defined parameter. True, if the parameter could be set.

Set the custom curve for the given AudioSourceCurveType.

The curve type that should be set. The curve that should be applied to the given curve type.

Changes the time at which a sound that has already been scheduled to play will end. Notice that depending on the timing not all rescheduling requests can be fulfilled.

Time in seconds.

Changes the time at which a sound that has already been scheduled to play will start.

Time in seconds.

Sets a user-defined parameter of a custom spatializer effect that is attached to an AudioSource.

Zero-based index of user-defined parameter to be set. New value of the user-defined parameter. True, if the parameter could be set.

Stops playing the clip.

Unpause the paused playback of this AudioSource.

Type of the imported(native) data.

Acc - not supported.

Aiff.

iPhone hardware decoder, supports AAC, ALAC and MP3. Extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure.

Impulse tracker.

Protracker / Fasttracker MOD.

MP2/MP3 MPEG.

Ogg vorbis.

ScreamTracker 3.

3rd party / unknown plugin format.

VAG.

Microsoft WAV.

FastTracker 2 XM.

Xbox360 XMA.

Avatar definition.

Return true if this avatar is a valid human avatar.

Return true if this avatar is a valid mecanim avatar. It can be a generic avatar or a human avatar.

Class to build avatars from user scripts.

Create a new generic avatar.

Root object of your transform hierarchy. Transform name of the root motion transform. If empty no root motion is defined and you must take care of avatar movement yourself.

Create a humanoid avatar.

Root object of your transform hierachy. It must be the top most gameobject when you create the avatar. Humanoid description of the avatar. Returns the Avatar, you must always always check the avatar is valid before using it with Avatar.isValid.

IK Goal.

The left foot.

The left hand.

The right foot.

The right hand.

IK Hint.

The left elbow IK hint.

The left knee IK hint.

The right elbow IK hint.

The right knee IK hint.

AvatarMask are used to mask out humanoid body parts and transforms.

Number of transforms.

Adds a transform path into the AvatarMask.

The transform to add into the AvatarMask. Whether to also add all children of the specified transform.

Creates a new AvatarMask.

Returns true if the humanoid body part at the given index is active.

The index of the humanoid body part.

Returns true if the transform at the given index is active.

The index of the transform.

Returns the path of the transform at the given index.

The index of the transform.

Removes a transform path from the AvatarMask.

The Transform that should be removed from the AvatarMask. Whether to also remove all children of the specified transform.

Sets the humanoid body part at the given index to active or not.

The index of the humanoid body part. Active or not.

Sets the tranform at the given index to active or not.

The index of the transform. Active or not.

Sets the path of the transform at the given index.

The index of the transform. The path of the transform.

Avatar body part.

The Body.

The Head.

Total number of body parts.

The Left Arm.

Left Fingers.

Left Foot IK.

Left Hand IK.

The Left Leg.

The Right Arm.

Right Fingers.

Right Foot IK.

Right Hand IK.

The Right Leg.

The Root.

Target.

The body, center of mass.

The left foot.

The left hand.

The right foot.

The right hand.

The root, the position of the game object.

Behaviours are Components that can be enabled or disabled.

Enabled Behaviours are Updated, disabled Behaviours are not.

Has the Behaviour had enabled called.

BillboardAsset describes how a billboard is rendered.

Height of the billboard that is below ground.

Height of the billboard.

Number of pre-rendered images that can be switched when the billboard is viewed from different angles.

Number of indices in the billboard mesh.

The material used for rendering.

Number of vertices in the billboard mesh.

Width of the billboard.

Constructs a new BillboardAsset.

Get the array of billboard image texture coordinate data.

The list that receives the array.

Get the array of billboard image texture coordinate data.

The list that receives the array.

Get the indices of the billboard mesh.

The list that receives the array.

Get the indices of the billboard mesh.

The list that receives the array.

Get the vertices of the billboard mesh.

The list that receives the array.

Get the vertices of the billboard mesh.

The list that receives the array.

Set the array of billboard image texture coordinate data.

The array of data to set.

Set the array of billboard image texture coordinate data.

The array of data to set.

Set the indices of the billboard mesh.

The array of data to set.

Set the indices of the billboard mesh.

The array of data to set.

Set the vertices of the billboard mesh.

The array of data to set.

Set the vertices of the billboard mesh.

The array of data to set.

Renders a billboard from a BillboardAsset.

The BillboardAsset to render.

Constructor.

The BitStream class represents seralized variables, packed into a stream.

Is the BitStream currently being read? (Read Only)

Is the BitStream currently being written? (Read Only)

Serializes different types of variables.

Describes a single bounding sphere for use by a CullingGroup.

The position of the center of the BoundingSphere.

The radius of the BoundingSphere.

Initializes a BoundingSphere.

The center of the sphere. The radius of the sphere. A four-component vector containing the position (packed into the XYZ components) and radius (packed into the W component).

Initializes a BoundingSphere.

The center of the sphere. The radius of the sphere. A four-component vector containing the position (packed into the XYZ components) and radius (packed into the W component).

Represents an axis aligned bounding box.

The center of the bounding box.

The extents of the Bounding Box. This is always half of the size of the Bounds.

The maximal point of the box. This is always equal to center+extents.

The minimal point of the box. This is always equal to center-extents.

The total size of the box. This is always twice as large as the extents.

The closest point on the bounding box.

Arbitrary point. The point on the bounding box or inside the bounding box.

Is point contained in the bounding box?

Creates a new Bounds.

The location of the origin of the Bounds. The dimensions of the Bounds.

Grows the Bounds to include the point.

Grow the bounds to encapsulate the bounds.

Expand the bounds by increasing its size by amount along each side.

Does ray intersect this bounding box?

Does another bounding box intersect with this bounding box?

Sets the bounds to the min and max value of the box.

The smallest squared distance between the point and this bounding box.

Returns a nicely formatted string for the bounds.

A box-shaped primitive collider.

The center of the box, measured in the object's local space.

The size of the box, measured in the object's local space.

The Caching class lets you manage cached AssetBundles, downloaded using UnityWebRequest.GetAssetBundle().

Returns the cache count in the cache list.

Controls compression of cache data. Enabled by default.

Gets or sets the current cache in which AssetBundles should be cached.

Returns the default cache which is added by Unity internally.

Returns true if Caching system is ready for use.

Add a cache with the given path.

Path to the cache folder.

Removes all the cached versions of the given AssetBundle from the cache.

The AssetBundle name. Returns true when cache clearing succeeded.

Removes all AssetBundle and Procedural Material content that has been cached by the current application.

The number of seconds that AssetBundles may remain unused in the cache. True when cache clearing succeeded, false if cache was in use.

Removes all AssetBundle and Procedural Material content that has been cached by the current application.

The number of seconds that AssetBundles may remain unused in the cache. True when cache clearing succeeded, false if cache was in use.

Removes the given version of the AssetBundle.

The AssetBundle name. Version needs to be cleaned. Returns true when cache clearing succeeded. Can return false if any cached bundle is in use.

Removes all the cached versions of the AssetBundle from the cache, except for the specified version.

The AssetBundle name. Version needs to be kept. Returns true when cache clearing succeeded.

Returns all paths of the cache in the cache list.

List of all the cache paths.

Returns the Cache at the given position in the cache list.

Index of the cache to get. A reference to the Cache at the index specified.

Returns the Cache that has the given cache path.

The cache path. A reference to the Cache with the given path.

Returns all cached versions of the given AssetBundle.

The AssetBundle name. List of all the cached version.

Checks if an AssetBundle is cached.

Url The filename of the AssetBundle. Domain and path information are stripped from this string automatically. Version The version number of the AssetBundle to check for. Negative values are not allowed. True if an AssetBundle matching the url and version parameters has previously been loaded using UnityWebRequest.GetAssetBundle() and is currently stored in the cache. Returns false if the AssetBundle is not in cache, either because it has been flushed from the cache or was never loaded using the Caching API.

Bumps the timestamp of a cached file to be the current time.

Moves the source Cache after the destination Cache in the cache list.

The Cache to move. The Cache which should come before the source Cache in the cache list.

Moves the source Cache before the destination Cache in the cache list.

The Cache to move. The Cache which should come after the source Cache in the cache list.

Removes the Cache from cache list.

The Cache to be removed. Returns true if the Cache is removed.

A Camera is a device through which the player views the world.

Gets the temporary RenderTexture target for this Camera.

The rendering path that is currently being used (Read Only).

Returns all enabled cameras in the scene.

The number of cameras in the current scene.

Dynamic Resolution Scaling.

High dynamic range rendering.

MSAA rendering.

Determines whether the stereo view matrices are suitable to allow for a single pass cull.

The aspect ratio (width divided by height).

The color with which the screen will be cleared.

Matrix that transforms from camera space to world space (Read Only).

Identifies what kind of camera this is.

How the camera clears the background.

Should the camera clear the stencil buffer after the deferred light pass?

Number of command buffers set up on this camera (Read Only).

This is used to render parts of the scene selectively.

Sets a custom matrix for the camera to use for all culling queries.

The camera we are currently rendering with, for low-level render control only (Read Only).

Camera's depth in the camera rendering order.

How and if camera generates a depth texture.

Mask to select which layers can trigger events on the camera.

The far clipping plane distance.

The field of view of the camera in degrees.

Should camera rendering be forced into a RenderTexture.

High dynamic range rendering.

Per-layer culling distances.

How to perform per-layer culling for a Camera.

The first enabled camera tagged "MainCamera" (Read Only).

The near clipping plane distance.

Get or set the raw projection matrix with no camera offset (no jittering).

Event that is fired after any camera finishes rendering.

Event that is fired before any camera starts culling.

Event that is fired before any camera starts rendering.

Opaque object sorting mode.

Is the camera orthographic (true) or perspective (false)?

Camera's half-size when in orthographic mode.

How tall is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only).

Where on the screen is the camera rendered in pixel coordinates.

How wide is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only).

Get the view projection matrix used on the last frame.

Set a custom projection matrix.

Where on the screen is the camera rendered in normalized coordinates.

The rendering path that should be used, if possible.

How tall is the camera in pixels (accounting for dynamic resolution scaling) (Read Only).

How wide is the camera in pixels (accounting for dynamic resolution scaling) (Read Only).

If not null, the camera will only render the contents of the specified scene.

Returns the eye that is currently rendering. If called when stereo is not enabled it will return Camera.MonoOrStereoscopicEye.Mono. If called during a camera rendering callback such as OnRenderImage it will return the currently rendering eye. If called outside of a rendering callback and stereo is enabled, it will return the default eye which is Camera.MonoOrStereoscopicEye.Left.

Distance to a point where virtual eyes converge.

Stereoscopic rendering.

Render only once and use resulting image for both eyes.

The distance between the virtual eyes. Use this to query or set the current eye separation. Note that most VR devices provide this value, in which case setting the value will have no effect.

Defines which eye of a VR display the Camera renders into.

Set the target display for this Camera.

Destination render texture.

An axis that describes the direction along which the distances of objects are measured for the purpose of sorting.

Transparent object sorting mode.

Should the jittered matrix be used for transparency rendering?

Whether or not the Camera will use occlusion culling during rendering.

Get the world-space speed of the camera (Read Only).

Matrix that transforms from world to camera space.

Add a command buffer to be executed at a specified place.

When to execute the command buffer during rendering. The buffer to execute.

Given viewport coordinates, calculates the view space vectors pointing to the four frustum corners at the specified camera depth.

Normalized viewport coordinates to use for the frustum calculation. Z-depth from the camera origin at which the corners will be calculated. Camera eye projection matrix to use. Output array for the frustum corner vectors. Cannot be null and length must be >= 4.

Calculates and returns oblique near-plane projection matrix.

Vector4 that describes a clip plane. Oblique near-plane projection matrix.

Delegate type for camera callbacks.

Makes this camera's settings match other camera.

Sets the non-jittered projection matrix, sourced from the VR SDK.

Specifies the stereoscopic eye whose non-jittered projection matrix will be sourced from the VR SDK.

Fills an array of Camera with the current cameras in the scene, without allocating a new array.

An array to be filled up with cameras currently in the scene.

Get command buffers to be executed at a specified place.

When to execute the command buffer during rendering. Array of command buffers.

Gets the non-jittered projection matrix of a specific left or right stereoscopic eye.

Specifies the stereoscopic eye whose non-jittered projection matrix needs to be returned. The non-jittered projection matrix of the specified stereoscopic eye.

Gets the projection matrix of a specific left or right stereoscopic eye.

Specifies the stereoscopic eye whose projection matrix needs to be returned. The projection matrix of the specified stereoscopic eye.

Gets the left or right view matrix of a specific stereoscopic eye.

Specifies the stereoscopic eye whose view matrix needs to be returned. The view matrix of the specified stereoscopic eye.

A Camera eye corresponding to the left or right human eye for stereoscopic rendering, or neither for non-stereoscopic rendering. A single Camera can render both left and right views in a single frame. Therefore, this enum describes which eye the Camera is currently rendering when returned by Camera.stereoActiveEye during a rendering callback (such as Camera.OnRenderImage), or which eye to act on when passed into a function. The default value is Camera.MonoOrStereoscopicEye.Left, so Camera.MonoOrStereoscopicEye.Left may be returned by some methods or properties when called outside of rendering if stereoscopic rendering is enabled.

Camera eye corresponding to stereoscopic rendering of the left eye.

Camera eye corresponding to non-stereoscopic rendering.

Camera eye corresponding to stereoscopic rendering of the right eye.

Remove all command buffers set on this camera.

Remove command buffer from execution at a specified place.

When to execute the command buffer during rendering. The buffer to execute.

Remove command buffers from execution at a specified place.

When to execute the command buffer during rendering.

Render the camera manually.

Render into a static cubemap from this camera.

The cube map to render to. A bitmask which determines which of the six faces are rendered to. False is rendering fails, else true.

Render into a cubemap from this camera.

A bitfield indicating which cubemap faces should be rendered into. The texture to render to. False is rendering fails, else true.

Render the camera with shader replacement.

Revert the aspect ratio to the screen's aspect ratio.

Make culling queries reflect the camera's built in parameters.

Reset to the default field of view.

Make the projection reflect normal camera's parameters.

Remove shader replacement from camera.

Reset the camera to using the Unity computed projection matrices for all stereoscopic eyes.

Reset the camera to using the Unity computed view matrices for all stereoscopic eyes.

Resets this Camera's transparency sort settings to the default. Default transparency settings are taken from GraphicsSettings instead of directly from this Camera.

Make the rendering position reflect the camera's position in the scene.

Returns a ray going from camera through a screen point.

Transforms position from screen space into viewport space.

Transforms position from screen space into world space.

Make the camera render with shader replacement.

Sets custom projection matrices for both the left and right stereoscopic eyes.

Projection matrix for the stereoscopic left eye. Projection matrix for the stereoscopic right eye.

Sets a custom projection matrix for a specific stereoscopic eye.

Specifies the stereoscopic eye whose projection matrix needs to be set. The matrix to be set.

Set custom view matrices for both eyes.

View matrix for the stereo left eye. View matrix for the stereo right eye.

Sets a custom view matrix for a specific stereoscopic eye.

Specifies the stereoscopic view matrix to set. The matrix to be set.

Sets the Camera to render to the chosen buffers of one or more RenderTextures.

The RenderBuffer(s) to which color information will be rendered. The RenderBuffer to which depth information will be rendered.

Sets the Camera to render to the chosen buffers of one or more RenderTextures.

The RenderBuffer(s) to which color information will be rendered. The RenderBuffer to which depth information will be rendered.

Enum used to specify either the left or the right eye of a stereoscopic camera.

Specifies the target to be the left eye.

Specifies the target to be the right eye.

Returns a ray going from camera through a viewport point.

Transforms position from viewport space into screen space.

Transforms position from viewport space into world space.

The 3d vector in Viewport space. The 3d vector in World space.

Transforms position from world space into screen space.

Transforms position from world space into viewport space.

Element that can be used for screen rendering.

Get or set the mask of additional shader channels to be used when creating the Canvas mesh.

Cached calculated value based upon SortingLayerID.

Is this the root Canvas?

The normalized grid size that the canvas will split the renderable area into.

Allows for nested canvases to override pixelPerfect settings inherited from parent canvases.

Override the sorting of canvas.

Force elements in the canvas to be aligned with pixels. Only applies with renderMode is Screen Space.

Get the render rect for the Canvas.

How far away from the camera is the Canvas generated.

The number of pixels per unit that is considered the default.

Is the Canvas in World or Overlay mode?

The render order in which the canvas is being emitted to the scene.

Returns the Canvas closest to root, by checking through each parent and returning the last canvas found. If no other canvas is found then the canvas will return itself.

Used to scale the entire canvas, while still making it fit the screen. Only applies with renderMode is Screen Space.

The normalized grid size that the canvas will split the renderable area into.

Unique ID of the Canvas' sorting layer.

Name of the Canvas' sorting layer.

Canvas' order within a sorting layer.

For Overlay mode, display index on which the UI canvas will appear.

Event that is called just before Canvas rendering happens.

Camera used for sizing the Canvas when in Screen Space - Camera. Also used as the Camera that events will be sent through for a World Space [[Canvas].

Force all canvases to update their content.

Returns the default material that can be used for rendering normal elements on the Canvas.

Returns the default material that can be used for rendering text elements on the Canvas.

Gets or generates the ETC1 Material.

The generated ETC1 Material from the Canvas.

A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state.

Set the alpha of the group.

Does this group block raycasting (allow collision).

Should the group ignore parent groups?

Is the group interactable (are the elements beneath the group enabled).

Returns true if the Group allows raycasts.

A component that will render to the screen after all normal rendering has completed when attached to a Canvas. Designed for GUI application.

Depth of the renderer relative to the root canvas.

Indicates whether geometry emitted by this renderer is ignored.

True if any change has occured that would invalidate the positions of generated geometry.

Enable 'render stack' pop draw call.

True if rect clipping has been enabled on this renderer. See Also: CanvasRenderer.EnableRectClipping, CanvasRenderer.DisableRectClipping.

Is the UIRenderer a mask component.

The number of materials usable by this renderer.

(Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt.

The number of materials usable by this renderer. Used internally for masking.

Depth of the renderer realative to the parent canvas.

Take the Vertex steam and split it corrisponding arrays (positions, colors, uv0s, uv1s, normals and tangents).

The UIVertex list to split. The destination list for the verts positions. The destination list for the verts colors. The destination list for the verts uv0s. The destination list for the verts uv1s. The destination list for the verts normals. The destination list for the verts tangents.

Remove all cached vertices.

Convert a set of vertex components into a stream of UIVertex.

Disables rectangle clipping for this CanvasRenderer.

Enables rect clipping on the CanvasRendered. Geometry outside of the specified rect will be clipped (not rendered).

Get the current alpha of the renderer.

Get the current color of the renderer.

Gets the current Material assigned to the CanvasRenderer.

The material index to retrieve (0 if this parameter is omitted). Result.

Gets the current Material assigned to the CanvasRenderer.

The material index to retrieve (0 if this parameter is omitted). Result.

Gets the current Material assigned to the CanvasRenderer. Used internally for masking.

Set the alpha of the renderer. Will be multiplied with the UIVertex alpha and the Canvas alpha.

Alpha.

The Alpha Texture that will be passed to the Shader under the _AlphaTex property.

The Texture to be passed.

Set the color of the renderer. Will be multiplied with the UIVertex color and the Canvas color.

Renderer multiply color.

Set the material for the canvas renderer. If a texture is specified then it will be used as the 'MainTex' instead of the material's 'MainTex'. See Also: CanvasRenderer.SetMaterialCount, CanvasRenderer.SetTexture.

Material for rendering. Material texture overide. Material index.

Sets the Mesh used by this renderer.

Set the material for the canvas renderer. Used internally for masking.

Sets the texture used by this renderer's material.

Set the vertices for the UIRenderer.

Array of vertices to set. Number of vertices to set.

Set the vertices for the UIRenderer.

Array of vertices to set. Number of vertices to set.

Given a list of UIVertex, split the stream into it's component types.

A capsule-shaped primitive collider.

The center of the capsule, measured in the object's local space.

The direction of the capsule.

The height of the capsule meased in the object's local space.

The radius of the sphere, measured in the object's local space.

A CharacterController allows you to easily do movement constrained by collisions without having to deal with a rigidbody.

The center of the character's capsule relative to the transform's position.

What part of the capsule collided with the environment during the last CharacterController.Move call.

Determines whether other rigidbodies or character controllers collide with this character controller (by default this is always enabled).

Enables or disables overlap recovery. Enables or disables overlap recovery. Used to depenetrate character controllers from static objects when an overlap is detected.

The height of the character's capsule.

Was the CharacterController touching the ground during the last move?

Gets or sets the minimum move distance of the character controller.

The radius of the character's capsule.

The character's collision skin width.

The character controllers slope limit in degrees.

The character controllers step offset in meters.

The current relative velocity of the Character (see notes).

A more complex move function taking absolute movement deltas.

Moves the character with speed.

Specification for how to render a character from the font texture. See Font.characterInfo.

The horizontal distance from the origin of this character to the origin of the next character.

The horizontal distance from the origin of this glyph to the begining of the glyph image.

Is the character flipped?

The height of the glyph image.

The width of the glyph image.

Unicode value of the character.

The maximum extend of the glyph image in the x-axis.

The maximum extend of the glyph image in the y-axis.

The minium extend of the glyph image in the x-axis.

The minimum extend of the glyph image in the y-axis.

The size of the character or 0 if it is the default font size.

The style of the character.

UV coordinates for the character in the texture.

The uv coordinate matching the bottom left of the glyph image in the font texture.

The uv coordinate matching the bottom right of the glyph image in the font texture.

The uv coordinate matching the top left of the glyph image in the font texture.

The uv coordinate matching the top right of the glyph image in the font texture.

Screen coordinates for the character in generated text meshes.

How far to advance between the beginning of this charcater and the next.

Character Joints are mainly used for Ragdoll effects.

Brings violated constraints back into alignment even when the solver fails.

The upper limit around the primary axis of the character joint.

The lower limit around the primary axis of the character joint.

Set the angular tolerance threshold (in degrees) for projection.

Set the linear tolerance threshold for projection.

The angular limit of rotation (in degrees) around the primary axis of the character joint.

The secondary axis around which the joint can rotate.

The configuration of the spring attached to the swing limits of the joint.

The configuration of the spring attached to the twist limits of the joint.

The Cloth class provides an interface to cloth simulation physics.

Bending stiffness of the cloth.

An array of CapsuleColliders which this Cloth instance should collide with.

Number of cloth solver iterations per second.

The cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh.

How much to increase mass of colliding particles.

Damp cloth motion.

Enable continuous collision to improve collision stability.

Is this cloth enabled?

A constant, external acceleration applied to the cloth.

The friction of the cloth when colliding with the character.

The current normals of the cloth object.

A random, external acceleration applied to the cloth.

Minimum distance at which two cloth particles repel each other (default: 0.0).

Self-collision stiffness defines how strong the separating impulse should be for colliding particles.

Cloth's sleep threshold.

An array of ClothSphereColliderPairs which this Cloth instance should collide with.

Sets the stiffness frequency parameter.

Stretching stiffness of the cloth.

Should gravity affect the cloth simulation?

Use Tether Anchors.

Add one virtual particle per triangle to improve collision stability.

The current vertex positions of the cloth object.

How much world-space acceleration of the character will affect cloth vertices.

How much world-space movement of the character will affect cloth vertices.

Clear the pending transform changes from affecting the cloth simulation.

Get list of particles to be used for self and inter collision.

List to be populated with cloth particle indices that are used for self and/or inter collision.

Get list of indices to be used when generating virtual particles.

List to be populated with virtual particle indices.

Get weights to be used when generating virtual particles for cloth.

List to populate with virtual particle weights.

Fade the cloth simulation in or out.

Fading enabled or not.

This allows you to set the cloth indices used for self and inter collision.

List of cloth particles indices to use for cloth self and/or inter collision.

Set indices to use when generating virtual particles.

List of cloth particle indices to use when generating virtual particles.

Sets weights to be used when generating virtual particles for cloth.

List of weights to be used when setting virutal particles for cloth.

The ClothSkinningCoefficient struct is used to set up how a Cloth component is allowed to move with respect to the SkinnedMeshRenderer it is attached to.

Definition of a sphere a vertex is not allowed to enter. This allows collision against the animated cloth.

Distance a vertex is allowed to travel from the skinned mesh vertex position.

A pair of SphereColliders used to define shapes for Cloth objects to collide against.

The first SphereCollider of a ClothSphereColliderPair.

The second SphereCollider of a ClothSphereColliderPair.

Creates a ClothSphereColliderPair. If only one SphereCollider is given, the ClothSphereColliderPair will define a simple sphere. If two SphereColliders are given, the ClothSphereColliderPair defines a conic capsule shape, composed of the two spheres and the cone connecting the two.

The first SphereCollider of a ClothSphereColliderPair. The second SphereCollider of a ClothSphereColliderPair.

Interface for reading and writing inputs in a Unity Cluster.

Add a new VRPN input entry.

Name of the input entry. This has to be unique. Device name registered to VRPN server. URL to the vrpn server. Index of the Input entry, refer to vrpn.cfg if unsure. Type of the input. True if the operation succeed.

Check the connection status of the device to the VRPN server it connected to.

Name of the input entry.

Edit an input entry which added via ClusterInput.AddInput.

Name of the input entry. This has to be unique. Device name registered to VRPN server. URL to the vrpn server. Index of the Input entry, refer to vrpn.cfg if unsure. Type of the ClusterInputType as follow.

Returns the axis value as a continous float.

Name of input to poll.c.

Returns the binary value of a button.

Name of input to poll.

Return the position of a tracker as a Vector3.

Name of input to poll.

Returns the rotation of a tracker as a Quaternion.

Name of input to poll.

Sets the axis value for this input. Only works for input typed Custom.

Name of input to modify. Value to set.

Sets the button value for this input. Only works for input typed Custom.

Name of input to modify. Value to set.

Sets the tracker position for this input. Only works for input typed Custom.

Name of input to modify. Value to set.

Sets the tracker rotation for this input. Only works for input typed Custom.

Name of input to modify. Value to set.

Values to determine the type of input value to be expect from one entry of ClusterInput.

Device is an analog axis that provides continuous value represented by a float.

Device that return a binary result of pressed or not pressed.

A user customized input.

Device that provide position and orientation values.

A helper class that contains static method to inquire status of Unity Cluster.

Check whether the current instance is disconnected from the cluster network.

Check whether the current instance is a master node in the cluster network.

To acquire or set the node index of the current machine from the cluster network.

A base class of all colliders.

The rigidbody the collider is attached to.

The world space bounding volume of the collider.

Contact offset value of this collider.

Enabled Colliders will collide with other Colliders, disabled Colliders won't.

Is the collider a trigger?

The material used by the collider.

The shared physic material of this collider.

Returns a point on the collider that is closest to a given location.

Location you want to find the closest point to. The point on the collider that is closest to the specified location.

The closest point to the bounding box of the attached collider.

Casts a Ray that ignores all Colliders except this one.

The starting point and direction of the ray. If true is returned, hitInfo will contain more information about where the collider was hit (See Also: RaycastHit). The max length of the ray. True when the ray intersects any collider, otherwise false.

Describes a collision.

The Collider we hit (Read Only).

The contact points generated by the physics engine.

The GameObject whose collider you are colliding with. (Read Only).

The total impulse applied to this contact pair to resolve the collision.

The relative linear velocity of the two colliding objects (Read Only).

The Rigidbody we hit (Read Only). This is null if the object we hit is a collider with no rigidbody attached.

The Transform of the object we hit (Read Only).

The collision detection mode constants used for Rigidbody.collisionDetectionMode.

Continuous collision detection is on for colliding with static mesh geometry.

Continuous collision detection is on for colliding with static and dynamic geometry.

Continuous collision detection is off for this Rigidbody.

CollisionFlags is a bitmask returned by CharacterController.Move.

A collection of common color functions.

Returns the color as a hexadecimal string in the format "RRGGBB".

The color to be converted. Hexadecimal string representing the color.

Returns the color as a hexadecimal string in the format "RRGGBBAA".

The color to be converted. Hexadecimal string representing the color.

Attempts to convert a html color string.

Case insensitive html string to be converted into a color. The converted color. True if the string was successfully converted else false.

Interface into compass functionality.

Used to enable or disable compass. Note, that if you want Input.compass.trueHeading property to contain a valid value, you must also enable location updates by calling Input.location.Start().

Accuracy of heading reading in degrees.

The heading in degrees relative to the magnetic North Pole. (Read Only)

The raw geomagnetic data measured in microteslas. (Read Only)

Timestamp (in seconds since 1970) when the heading was last time updated. (Read Only)

The heading in degrees relative to the geographic North Pole. (Read Only)

Base class for everything attached to GameObjects.

The Animation attached to this GameObject. (Null if there is none attached).

The AudioSource attached to this GameObject. (Null if there is none attached).

The Camera attached to this GameObject. (Null if there is none attached).

The Collider attached to this GameObject. (Null if there is none attached).

The Collider2D component attached to the object.

The ConstantForce attached to this GameObject. (Null if there is none attached).

The game object this component is attached to. A component is always attached to a game object.

The GUIText attached to this GameObject. (Null if there is none attached).

The GUITexture attached to this GameObject (Read Only). (null if there is none attached).

The HingeJoint attached to this GameObject. (Null if there is none attached).

The Light attached to this GameObject. (Null if there is none attached).

The NetworkView attached to this GameObject (Read Only). (null if there is none attached).

The ParticleEmitter attached to this GameObject. (Null if there is none attached).

The ParticleSystem attached to this GameObject. (Null if there is none attached).

The Renderer attached to this GameObject. (Null if there is none attached).

The Rigidbody attached to this GameObject. (Null if there is none attached).

The Rigidbody2D that is attached to the Component's GameObject.

The tag of this game object.

The Transform attached to this GameObject.

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Is this game object tagged with tag ?

The tag to compare.

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

The type of Component to retrieve.

Generic version. See the page for more details.

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

Returns the component of Type type in the GameObject or any of its children using depth first search.

The type of Component to retrieve. A component of the matching type, if found.

Generic version. See the page for more details.

A component of the matching type, if found.

Returns the component of Type type in the GameObject or any of its parents.

The type of Component to retrieve. A component of the matching type, if found.

Generic version. See the page for more details.

A component of the matching type, if found.

Returns all components of Type type in the GameObject.

The type of Component to retrieve.

Generic version. See the page for more details.

Returns all components of Type type in the GameObject or any of its children.

The type of Component to retrieve. Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless.

Returns all components of Type type in the GameObject or any of its children.

Generic version. See the page for more details.

Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless. A list of all found components matching the specified type.

Generic version. See the page for more details.

A list of all found components matching the specified type.

Returns all components of Type type in the GameObject or any of its parents.

The type of Component to retrieve. Should inactive Components be included in the found set?

Generic version. See the page for more details.

Should inactive Components be included in the found set?

Generic version. See the page for more details.

Should inactive Components be included in the found set?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

GPU data buffer, mostly for use with compute shaders.

Number of elements in the buffer (Read Only).

Size of one element in the buffer (Read Only).

Copy counter value of append/consume buffer into another buffer.

Append/consume buffer to copy the counter from. A buffer to copy the counter to. Target byte offset in dst.

Create a Compute Buffer.

Number of elements in the buffer. Size of one element in the buffer. Has to match size of buffer type in the shader. See for cross-platform compatibility information. Type of the buffer, default is ComputeBufferType.Default (structured buffer).

Create a Compute Buffer.

Read data values from the buffer into an array.

An array to receive the data.

Partial read of data values from the buffer into an array.

An array to receive the data. The first element index in data where retrieved elements are copied. The first element index of the compute buffer from which elements are read. The number of elements to retrieve.

Retrieve a native (underlying graphics API) pointer to the buffer.

Pointer to the underlying graphics API buffer.

Release a Compute Buffer.

Sets counter value of append/consume buffer.

Value of the append/consume counter.

Set the buffer with values from an array.

Array of values to fill the buffer.

Partial copy of data values from an array into the buffer.

Array of values to fill the buffer. The first element index in data to copy to the compute buffer. The first element index in compute buffer to receive the data. The number of elements to copy.

Compute Shader asset.

Execute a compute shader.

Which kernel to execute. A single compute shader asset can have multiple kernel entry points. Number of work groups in the X dimension. Number of work groups in the Y dimension. Number of work groups in the Z dimension.

Execute a compute shader.

Which kernel to execute. A single compute shader asset can have multiple kernel entry points. Buffer with dispatch arguments. The byte offset into the buffer, where the draw arguments start.

Find ComputeShader kernel index.

Name of kernel function. The Kernel index, or logs a "FindKernel failed" error message if the kernel is not found.

Get kernel thread group sizes.

Which kernel to query. A single compute shader asset can have multiple kernel entry points. Thread group size in the X dimension. Thread group size in the Y dimension. Thread group size in the Z dimension.

Checks whether a shader contains a given kernel.

The name of the kernel to look for. True if the kernel is found, false otherwise.

Set a bool parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a bool parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Sets an input or output compute buffer.

For which kernel the buffer is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Buffer to set.

Sets an input or output compute buffer.

For which kernel the buffer is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Buffer to set.

Set a float parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a float parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set multiple consecutive float parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set multiple consecutive float parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set an integer parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set an integer parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set multiple consecutive integer parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set multiple consecutive integer parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set a Matrix parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a Matrix parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a Matrix array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a Matrix array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a texture parameter.

For which kernel the texture is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Texture to set.

Set a texture parameter.

For which kernel the texture is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Texture to set.

Set a texture parameter from a global texture property.

For which kernel the texture is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Global texture property to assign to shader. Property name ID, use Shader.PropertyToID to get it.

Set a texture parameter from a global texture property.

Set a vector parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a vector parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a vector array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a vector array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

The configurable joint is an extremely flexible joint giving you complete control over rotation and linear motion.

Definition of how the joint's rotation will behave around its local X axis. Only used if Rotation Drive Mode is Swing & Twist.

The configuration of the spring attached to the angular X limit of the joint.

Allow rotation around the X axis to be Free, completely Locked, or Limited according to Low and High Angular XLimit.

Boundary defining rotation restriction, based on delta from original rotation.

Allow rotation around the Y axis to be Free, completely Locked, or Limited according to Angular YLimit.

Definition of how the joint's rotation will behave around its local Y and Z axes. Only used if Rotation Drive Mode is Swing & Twist.

The configuration of the spring attached to the angular Y and angular Z limits of the joint.

Boundary defining rotation restriction, based on delta from original rotation.

Allow rotation around the Z axis to be Free, completely Locked, or Limited according to Angular ZLimit.

If enabled, all Target values will be calculated in world space instead of the object's local space.

Boundary defining upper rotation restriction, based on delta from original rotation.

Boundary defining movement restriction, based on distance from the joint's origin.

The configuration of the spring attached to the linear limit of the joint.

Boundary defining lower rotation restriction, based on delta from original rotation.

Set the angular tolerance threshold (in degrees) for projection. If the joint deviates by more than this angle around its locked angular degrees of freedom, the solver will move the bodies to close the angle. Setting a very small tolerance may result in simulation jitter or other artifacts. Sometimes it is not possible to project (for example when the joints form a cycle).

Set the linear tolerance threshold for projection. If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance. Setting a very small tolerance may result in simulation jitter or other artifacts. Sometimes it is not possible to project (for example when the joints form a cycle).

Brings violated constraints back into alignment even when the solver fails. Projection is not a physical process and does not preserve momentum or respect collision geometry. It is best avoided if practical, but can be useful in improving simulation quality where joint separation results in unacceptable artifacts.

Control the object's rotation with either X & YZ or Slerp Drive by itself.

The joint's secondary axis.

Definition of how the joint's rotation will behave around all local axes. Only used if Rotation Drive Mode is Slerp Only.

If enabled, the two connected rigidbodies will be swapped, as if the joint was attached to the other body.

This is a Vector3. It defines the desired angular velocity that the joint should rotate into.

The desired position that the joint should move into.

This is a Quaternion. It defines the desired rotation that the joint should rotate into.

The desired velocity that the joint should move along.

Definition of how the joint's movement will behave along its local X axis.

Allow movement along the X axis to be Free, completely Locked, or Limited according to Linear Limit.

Definition of how the joint's movement will behave along its local Y axis.

Allow movement along the Y axis to be Free, completely Locked, or Limited according to Linear Limit.

Definition of how the joint's movement will behave along its local Z axis.

Allow movement along the Z axis to be Free, completely Locked, or Limited according to Linear Limit.

Constrains movement for a ConfigurableJoint along the 6 axes.

Motion along the axis will be completely free and completely unconstrained.

Motion along the axis will be limited by the respective limit.

Motion along the axis will be locked.

The various test results the connection tester may return with.

Some unknown error occurred.

Port-restricted NAT type, can do NAT punchthrough to everyone except symmetric.

Symmetric NAT type, cannot do NAT punchthrough to other symmetric types nor port restricted type.

Address-restricted cone type, NAT punchthrough fully supported.

Full cone type, NAT punchthrough fully supported.

Public IP address detected and game listen port is accessible to the internet.

Public IP address detected but server is not initialized and no port is listening.

Public IP address detected but the port is not connectable from the internet.

Test result undetermined, still in progress.

A force applied constantly.

The force applied to the rigidbody every frame.

The force - relative to the rigid bodies coordinate system - applied every frame.

The torque - relative to the rigid bodies coordinate system - applied every frame.

The torque applied to the rigidbody every frame.

Describes a contact point where the collision occurs.

Normal of the contact point.

The other collider in contact at the point.

The point of contact.

The distance between the colliders at the contact point.

The first collider in contact at the point.

ControllerColliderHit is used by CharacterController.OnControllerColliderHit to give detailed information about the collision and how to deal with it.

The collider that was hit by the controller.

The controller that hit the collider.

The game object that was hit by the controller.

The direction the CharacterController was moving in when the collision occured.

How far the character has travelled until it hit the collider.

The normal of the surface we collided with in world space.

The impact point in world space.

The rigidbody that was hit by the controller.

The transform that was hit by the controller.

MonoBehaviour.StartCoroutine returns a Coroutine. Instances of this class are only used to reference these coroutines and do not hold any exposed properties or functions.

Holds data for a single application crash event and provides access to all gathered crash reports.

Returns last crash report, or null if no reports are available.

Returns all currently available reports in a new array.

Crash report data as formatted text.

Time, when the crash occured.

Remove report from available reports list.

Remove all reports from available reports list.

Class for handling cube maps, Use this to create or modify existing.

The format of the pixel data in the texture (Read Only).

How many mipmap levels are in this texture (Read Only).

Actually apply all previous SetPixel and SetPixels changes.

When set to true, mipmap levels are recalculated. When set to true, system memory copy of a texture is released.

Creates a Unity cubemap out of externally created native cubemap object.

The width and height of each face of the cubemap should be the same. Format of underlying cubemap object. Does the cubemap have mipmaps? Native cubemap texture object.

Create a new empty cubemap texture.

Width/height of a cube face in pixels. Pixel data format to be used for the Cubemap. Should mipmaps be created?

Returns pixel color at coordinates (face, x, y).

Returns pixel colors of a cubemap face.

The face from which pixel data is taken. Mipmap level for the chosen face.

Sets pixel color at coordinates (face, x, y).

Sets pixel colors of a cubemap face.

Pixel data for the Cubemap face. The face to which the new data should be applied. The mipmap level for the face.

Performs smoothing of near edge regions.

Pixel distance at edges over which to apply smoothing.

Class for handling Cubemap arrays.

Number of cubemaps in the array (Read Only).

Texture format (Read Only).

Actually apply all previous SetPixels changes.

When set to true, mipmap levels are recalculated. When set to true, system memory copy of a texture is released.

Create a new cubemap array.

Cubemap face size in pixels. Number of elements in the cubemap array. Format of the pixel data. Should mipmaps be created? Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false.

Create a new cubemap array.

Returns pixel colors of a single array slice/face.

Cubemap face to read pixels from. Array slice to read pixels from. Mipmap level to read pixels from. Array of pixel colors.

Returns pixel colors of a single array slice/face.

Cubemap face to read pixels from. Array slice to read pixels from. Mipmap level to read pixels from. Array of pixel colors in low precision (8 bits/channel) format.

Set pixel colors for a single array slice/face.

An array of pixel colors. Cubemap face to set pixels for. Array element index to set pixels for. Mipmap level to set pixels for.

Set pixel colors for a single array slice/face.

An array of pixel colors in low precision (8 bits/channel) format. Cubemap face to set pixels for. Array element index to set pixels for. Mipmap level to set pixels for.

Describes a set of bounding spheres that should have their visibility and distances maintained.

Pauses culling group execution.

Sets the callback that will be called when a sphere's visibility and/or distance state has changed.

Locks the CullingGroup to a specific camera.

Create a CullingGroup.

Clean up all memory used by the CullingGroup immediately.

Erase a given bounding sphere by moving the final sphere on top of it.

The index of the entry to erase.

Erase a given entry in an arbitrary array by copying the final entry on top of it, then decrementing the number of entries used by one.

The index of the entry to erase. An array of entries. The number of entries in the array that are actually used.

Get the current distance band index of a given sphere.

The index of the sphere. The sphere's current distance band index.

Returns true if the bounding sphere at index is currently visible from any of the contributing cameras.

The index of the bounding sphere. True if the sphere is visible; false if it is invisible.

Retrieve the indices of spheres that have particular visibility and/or distance states.

True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved. The distance band that retrieved spheres must be in. An array that will be filled with the retrieved sphere indices. The index of the sphere to begin searching at. The number of sphere indices found and written into the result array.

Retrieve the indices of spheres that have particular visibility and/or distance states.

Set bounding distances for 'distance bands' the group should compute, as well as options for how spheres falling into each distance band should be treated.

An array of bounding distances. The distances should be sorted in increasing order. An array of CullingDistanceBehaviour settings. The array should be the same length as the array provided to the distances parameter. It can also be omitted or passed as null, in which case all distances will be given CullingDistanceBehaviour.Normal behaviour.

Sets the number of bounding spheres in the bounding spheres array that are actually being used.

The number of bounding spheres being used.

Sets the array of bounding sphere definitions that the CullingGroup should compute culling for.

The BoundingSpheres to cull.

Set the reference point from which distance bands are measured.

A fixed point to measure the distance from. A transform to measure the distance from. The transform's position will be automatically tracked.

Set the reference point from which distance bands are measured.

A fixed point to measure the distance from. A transform to measure the distance from. The transform's position will be automatically tracked.

This delegate is used for recieving a callback when a sphere's distance or visibility state has changed.

A CullingGroupEvent that provides information about the sphere that has changed.

Provides information about the current and previous states of one sphere in a CullingGroup.

The current distance band index of the sphere, after the most recent culling pass.

Did this sphere change from being visible to being invisible in the most recent culling pass?

Did this sphere change from being invisible to being visible in the most recent culling pass?

The index of the sphere that has changed.

Was the sphere considered visible by the most recent culling pass?

The distance band index of the sphere before the most recent culling pass.

Was the sphere visible before the most recent culling pass?

Cursor API for setting the cursor (mouse pointer).

Determines whether the hardware pointer is locked to the center of the view, constrained to the window, or not constrained at all.

Determines whether the hardware pointer is visible or not.

Sets the mouse cursor to the given texture.

Specify a custom cursor that you wish to use as a cursor.

The texture to use for the cursor or null to set the default cursor. Note that a texture needs to be imported with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults), in order to be used as a cursor. The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). Allow this cursor to render as a hardware cursor on supported platforms, or force software cursor.

How the cursor should behave.

Confine cursor to the game window.

Lock cursor to the center of the game window.

Cursor behavior is unmodified.

Determines whether the mouse cursor is rendered using software rendering or, on supported platforms, hardware rendering.

Use hardware cursors on supported platforms.

Force the use of software cursors.

Custom Render Textures are an extension to Render Textures, enabling you to render directly to the Texture using a Shader.

Bitfield that allows to enable or disable update on each of the cubemap faces. Order from least significant bit is +X, -X, +Y, -Y, +Z, -Z.

If true, the Custom Render Texture is double buffered so that you can access it during its own update. otherwise the Custom Render Texture will be not be double buffered.

Color with which the Custom Render Texture is initialized. This parameter will be ignored if an initializationMaterial is set.

Material with which the Custom Render Texture is initialized. Initialization texture and color are ignored if this parameter is set.

Specify how the texture should be initialized.

Specify if the texture should be initialized with a Texture and a Color or a Material.

Texture with which the Custom Render Texture is initialized (multiplied by the initialization color). This parameter will be ignored if an initializationMaterial is set.

Material with which the content of the Custom Render Texture is updated.

Shader Pass used to update the Custom Render Texture.

Specify how the texture should be updated.

Space in which the update zones are expressed (Normalized or Pixel space).

If true, Update zones will wrap around the border of the Custom Render Texture. Otherwise, Update zones will be clamped at the border of the Custom Render Texture.

Clear all Update Zones.

Create a new Custom Render Texture.

Returns the list of Update Zones.

Output list of Update Zones.

Triggers an initialization of the Custom Render Texture.

Setup the list of Update Zones for the Custom Render Texture.

Triggers the update of the Custom Render Texture.

Number of upate pass to perform.

Structure describing an Update Zone.

If true, and if the texture is double buffered, a request is made to swap the buffers before the next update. Otherwise, the buffers will not be swapped.

Shader Pass used to update the Custom Render Texture for this Update Zone.

Rotation of the Update Zone.

Position of the center of the Update Zone within the Custom Render Texture.

Size of the Update Zone.

Base class for custom yield instructions to suspend coroutines.

Indicates if coroutine should be kept suspended.

Class containing methods to ease debugging while developing a game.

Reports whether the development console is visible. The development console cannot be made to appear using:

In the Build Settings dialog there is a check box called "Development Build".

Get default debug logger.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs a formatted error message to the Unity console on failure.

Condition you expect to be true. A composite format string. Format arguments. Object to which the message applies.

Assert a condition and logs a formatted error message to the Unity console on failure.

Condition you expect to be true. A composite format string. Format arguments. Object to which the message applies.

Pauses the editor.

Clears errors from the developer console.

Draws a line between specified start and end points.

Point in world space where the line should start. Point in world space where the line should end. Color of the line. How long the line should be visible for. Should the line be obscured by objects closer to the camera?

Draws a line between specified start and end points.

Draws a line from start to start + dir in world coordinates.

Point in world space where the ray should start. Direction and length of the ray. Color of the drawn line. How long the line will be visible for (in seconds). Should the line be obscured by other objects closer to the camera?

Draws a line from start to start + dir in world coordinates.

Logs message to the Unity Console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs message to the Unity Console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs an assertion message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs an assertion message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs a formatted assertion message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted assertion message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

A variant of Debug.Log that logs an error message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs an error message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs a formatted error message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted error message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

A variant of Debug.Log that logs an error message to the console.

Object to which the message applies. Runtime Exception.

A variant of Debug.Log that logs an error message to the console.

Object to which the message applies. Runtime Exception.

Logs a formatted message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

A variant of Debug.Log that logs a warning message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs a warning message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs a formatted warning message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted warning message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

Describes physical orientation of the device as determined by the OS.

The device is held parallel to the ground with the screen facing downwards.

The device is held parallel to the ground with the screen facing upwards.

The device is in landscape mode, with the device held upright and the home button on the right side.

The device is in landscape mode, with the device held upright and the home button on the left side.

The device is in portrait mode, with the device held upright and the home button at the bottom.

The device is in portrait mode but upside down, with the device held upright and the home button at the top.

The orientation of the device cannot be determined.

Provides access to a display / screen for rendering operations.

Gets the state of the display and returns true if the display is active and false if otherwise.

Color RenderBuffer.

Depth RenderBuffer.

The list of currently connected Displays. Contains at least one (main) display.

Main Display.

Vertical resolution that the display is rendering at.

Horizontal resolution that the display is rendering at.

Vertical native display resolution.

Horizontal native display resolution.

Activate an external display. Eg. Secondary Monitors connected to the System.

This overloaded function available for Windows allows specifying desired Window Width, Height and Refresh Rate.

Desired Width of the Window (for Windows only. On Linux and Mac uses Screen Width). Desired Height of the Window (for Windows only. On Linux and Mac uses Screen Height). Desired Refresh Rate.

Query relative mouse coordinates.

Mouse Input Position as Coordinates.

Set rendering size and position on screen (Windows only).

Change Window Width (Windows Only). Change Window Height (Windows Only). Change Window Position X (Windows Only). Change Window Position Y (Windows Only).

Sets rendering resolution for the display.

Rendering width in pixels. Rendering height in pixels.

A component can be designed to drive a RectTransform. The DrivenRectTransformTracker struct is used to specify which RectTransforms it is driving.

Add a RectTransform to be driven.

The object to drive properties. The RectTransform to be driven. The properties to be driven.

Clear the list of RectTransforms being driven.

An enumeration of transform properties that can be driven on a RectTransform by an object.

Selects all driven properties.

Selects driven property RectTransform.anchoredPosition.

Selects driven property RectTransform.anchoredPosition3D.

Selects driven property RectTransform.anchoredPosition.x.

Selects driven property RectTransform.anchoredPosition.y.

Selects driven property RectTransform.anchoredPosition3D.z.

Selects driven property combining AnchorMaxX and AnchorMaxY.

Selects driven property RectTransform.anchorMax.x.

Selects driven property RectTransform.anchorMax.y.

Selects driven property combining AnchorMinX and AnchorMinY.

Selects driven property RectTransform.anchorMin.x.

Selects driven property RectTransform.anchorMin.y.

Selects driven property combining AnchorMinX, AnchorMinY, AnchorMaxX and AnchorMaxY.

Deselects all driven properties.

Selects driven property combining PivotX and PivotY.

Selects driven property RectTransform.pivot.x.

Selects driven property RectTransform.pivot.y.

Selects driven property Transform.localRotation.

Selects driven property combining ScaleX, ScaleY && ScaleZ.

Selects driven property Transform.localScale.x.

Selects driven property Transform.localScale.y.

Selects driven property Transform.localScale.z.

Selects driven property combining SizeDeltaX and SizeDeltaY.

Selects driven property RectTransform.sizeDelta.x.

Selects driven property RectTransform.sizeDelta.y.

Describe the unit of a duration.

A fixed duration is a duration expressed in seconds.

A normalized duration is a duration expressed in percentage.

Allows to control the dynamic Global Illumination.

Allows for scaling the contribution coming from realtime & static lightmaps.

Is precomputed realtime Global Illumination output converged?

When enabled, new dynamic Global Illumination output is shown in each frame.

Threshold for limiting updates of realtime GI. The unit of measurement is "percentage intensity change".

Allows to set an emissive color for a given renderer quickly, without the need to render the emissive input for the entire system.

The Renderer that should get a new color. The emissive Color.

Allows overriding the distant environment lighting for Realtime GI, without changing the Skybox Material.

Array of float values to be used for Realtime GI environment lighting.

Schedules an update of the environment texture.

Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain.

The Renderer to use when searching for a system to update. The Terrain to use when searching for systems to update.

Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain.

The Renderer to use when searching for a system to update. The Terrain to use when searching for systems to update.

Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain.

The Renderer to use when searching for a system to update. The Terrain to use when searching for systems to update.

A UnityGUI event.

Is Alt/Option key held down? (Read Only)

Which mouse button was pressed.

Is Caps Lock on? (Read Only)

The character typed.

How many consecutive mouse clicks have we received.

Is Command/Windows key held down? (Read Only)

The name of an ExecuteCommand or ValidateCommand Event.

Is Control key held down? (Read Only)

The current event that's being processed right now.

The relative movement of the mouse compared to last event.

Index of display that the event belongs to.

Is the current keypress a function key? (Read Only)

Is this event a keyboard event? (Read Only)

Is this event a mouse event? (Read Only)

The raw key code for keyboard events.

Which modifier keys are held down.

The mouse position.

Is the current keypress on the numeric keyboard? (Read Only)

Is Shift held down? (Read Only)

The type of event.

Returns the current number of events that are stored in the event queue.

Current number of events currently in the event queue.

Get a filtered event type for a given control ID.

The ID of the control you are querying from.

Create a keyboard event.

Get the next queued [Event] from the event system.

Next Event.

Use this event.

Types of modifier key that can be active during a keystroke event.

Alt key.

Caps lock key.

Command key (Mac).

Control key.

Function key.

No modifier key pressed during a keystroke event.

Num lock key.

Shift key.

Types of UnityGUI input and processing events.

User has right-clicked (or control-clicked on the mac).

Editor only: drag & drop operation exited.

Editor only: drag & drop operation performed.

Editor only: drag & drop operation updated.

Execute a special command (eg. copy & paste).

Event should be ignored.

A keyboard key was pressed.

A keyboard key was released.

A layout event.

Mouse button was pressed.

Mouse was dragged.

Mouse entered a window (Editor views only).

Mouse left a window (Editor views only).

Mouse was moved (Editor views only).

Mouse button was released.

A repaint event. One is sent every frame.

The scroll wheel was moved.

Already processed event.

Validates a special command (e.g. copy & paste).

Culling results (visible objects, lights, reflection probes).

Array of visible lights.

Off screen lights that still effect visible scene vertices.

Array of visible reflection probes.

Visible renderers.

Calculates the view and projection matrices and shadow split data for a directional light.

The index into the active light array. The cascade index. The number of cascades. The cascade ratios. The resolution of the shadowmap. The near plane offset for the light. The computed view matrix. The computed projection matrix. The computed cascade data. If false, the shadow map for this cascade does not need to be rendered this frame.

Calculates the view and projection matrices and shadow split data for a point light.

The index into the active light array. The cubemap face to be rendered. The amount by which to increase the camera FOV above 90 degrees. The computed view matrix. The computed projection matrix. The computed split data. If false, the shadow map for this light and cubemap face does not need to be rendered this frame.

Calculates the view and projection matrices and shadow split data for a spot light.

The index into the active light array. The computed view matrix. The computed projection matrix. The computed split data. If false, the shadow map for this light does not need to be rendered this frame.

Perform culling for a Camera.

Camera to cull for. Render loop the culling results will be used with. Culling results. Flag indicating whether culling succeeded.

Perform culling with custom CullingParameters.

Parameters for culling. Render loop the culling results will be used with. Culling results.

Fills a compute buffer with per-object light indices.

The compute buffer object to fill.

Get culling parameters for a camera.

Camera to get parameters for. Resultant culling parameters. Generate single-pass stereo aware culling parameters. Flag indicating whether culling parameters are valid.

Get culling parameters for a camera.

Camera to get parameters for. Resultant culling parameters. Generate single-pass stereo aware culling parameters. Flag indicating whether culling parameters are valid.

If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists.

Array of indices that map from VisibleLight indices to internal per-object light list indices.

Gets the number of per-object light indices.

The number of per-object light indices.

Returns the bounding box that encapsulates the visible shadow casters. Can be used to, for instance, dynamically adjust cascade ranges.

The index of the shadow-casting light. The bounds to be computed. True if the light affects at least one shadow casting object in the scene.

If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists. If an element of the array is set to -1, the light corresponding to that element will be disabled.

Array with light indices that map from VisibleLight to internal per-object light lists.

Settings for ScriptableRenderContext.DrawRenderers.

Other flags controlling object rendering.

The maxiumum number of passes that can be rendered in 1 DrawRenderers call.

What kind of per-object data to setup during rendering.

How to sort objects during rendering.

Create a draw settings struct.

Camera to use. Camera's transparency sort mode is used to determine whether to use orthographic or distance based sorting. Shader pass to use.

Set the Material to use for all drawers that would render in this group.

Override material. Pass to use in the material.

Set the shader passes that this draw call can render.

Index of the shader pass to use. Name of the shader pass.

Defines state and drawing commands used in a custom render pipelines.

Draw subset of visible objects.

Specifies parts of the render state to override. Specifies parts of the render state to override for specific render types. Specifies which set of visible objects to draw. Specifies how to draw the objects. Specifies how the renderers should be further filtered.

Draw subset of visible objects.

Draw shadow casters for a single light.

Specifies which set of shadow casters to draw, and how to draw them.

Draw skybox.

Camera to draw the skybox for.

Emit UI geimetry into the scene view for rendering.

Camera to emit the geometry for.

Execute a custom graphics command buffer.

Command buffer to execute.

Executes a command buffer on an async compute queue with the queue selected based on the ComputeQueueType parameter passed. It is required that all of the commands within the command buffer be of a type suitable for execution on the async compute queues. If the buffer contains any commands that are not appropriate then an error will be logged and displayed in the editor window. Specifically the following commands are permitted in a CommandBuffer intended for async execution: CommandBuffer.BeginSample CommandBuffer.CopyCounterValue CommandBuffer.CopyTexture CommandBuffer.CreateGPUFence CommandBuffer.DispatchCompute CommandBuffer.EndSample CommandBuffer.IssuePluginEvent CommandBuffer.SetComputeBufferParam CommandBuffer.SetComputeFloatParam CommandBuffer.SetComputeFloatParams CommandBuffer.SetComputeTextureParam CommandBuffer.SetComputeVectorParam CommandBuffer.WaitOnGPUFence All of the commands within the buffer are guaranteed to be executed on the same queue. If the target platform does not support async compute queues then the work is dispatched on the graphics queue.

The CommandBuffer to be executed. Describes the desired async compute queue the supplied CommandBuffer should be executed on.

Setup camera specific global shader variables.

Camera to setup shader variables for. Set up the stereo shader variables and state.

Setup camera specific global shader variables.

Camera to setup shader variables for. Set up the stereo shader variables and state.

Fine-grain control to begin stereo rendering on the scriptable render context.

Camera to enable stereo rendering on.

Indicate completion of stereo rendering on a single frame.

Camera to indicate completion of stereo rendering.

Stop stereo rendering on the scriptable render context.

Camera to disable stereo rendering on.

Submit rendering loop for execution.

Shader pass name identifier.

Create shader pass name identifier.

Pass name.

Holds data of a visible light.

Light color multiplied by intensity.

Light flags, see VisibleLightFlags.

Accessor to Light component.

Light type.

Light transformation matrix.

Light range.

Light's influence rectangle on screen.

Spot light angle.

Holds data of a visible reflection probe.

Probe blending distance.

Probe bounding box.

Should probe use box projection.

Probe projection center.

Shader data for probe HDR texture decoding.

Probe importance.

Probe transformation matrix.

Accessor to ReflectionProbe component.

Probe texture.

Event sent after an element is added to an element that is a descendent of a panel.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Event sent immediately after an element has lost focus. Capturable, does not bubbles, non-cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Interface for classes capable of having callbacks to handle events.

Handle an event, most often by executing the callbacks associated with the event.

The event to handle.

Return true if event handlers for the event propagation bubble up phase have been attached on this object.

True if object has event handlers for the bubble up phase.

Return true if event handlers for the event propagation capture phase have been attached on this object.

True if object has event handlers for the capture phase.

Called when the element loses the capture. Will be removed in a future version.

Add an event handler on the instance. If the handler has already been registered on the same phase (capture or bubbling), this will have no effect.

The event handler to add. By default the callback will be called during the bubbling phase. Pass Capture.Capture to have the callback called during the capture phase instead. Data to pass to the callback.

Add an event handler on the instance. If the handler has already been registered on the same phase (capture or bubbling), this will have no effect.

Remove callback from the instance.

The callback to remove. Select wether the callback should be removed from the capture or the bubbling phase.

Remove callback from the instance.

The callback to remove. Select wether the callback should be removed from the capture or the bubbling phase.

Used to specify the phases where an event handler should be executed.

The event handler should be executed during the capture and the target phases.

The event handler should be executed during the target and bubble up phases.

Enum which describes the various types of changes that can occur on a VisualElement.

All change types have been flagged.

Persistence key or parent has changed on the current VisualElement.

Persistence key or parent has changed on some child of the current VisualElement.

This class is used during UXML template instantiation.

Event sent just before an element is detach from its parent, if the parent is the descendant of a panel.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

The base class for all UIElements events.

Returns whether this event type bubbles up in the event propagation path.

Return whether this event is sent down the event propagation path during the capture phase.

The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.

Return whether the event is currently being dispatched to visual element. An event can not be redispatched while being dispatched. If you need to recursively redispatch an event, you should use a copy.

The IMGUIEvent at the source of this event. This can be null as not all events are generated by IMGUI.

Return true if the default actions should not be executed for this event.

Return true if StopImmediatePropagation() has been called for this event.

Return true if StopPropagation() has been called for this event.

The current propagation phase.

The target for this event. The is the visual element that received the event. Unlike currentTarget, target does not change when the event is sent to elements along the propagation path.

The time at which the event was created.

Flags to describe the characteristics of an event.

Event will bubble up the propagation path (i.e. from the target parent up to the visual tree root).

Execution of default behavior for this event can be cancelled.

Event will be sent down the propagation path during the capture phase (i.e. from the visual tree root down to the target parent).

Empty value.

Get the type id for this event instance.

The type ID.

Reset the event members to their initial value.

Call this function to prevent the execution of the default actions for this event.

The type ID.

Immediately stop the propagation of this event. The event will not be sent to any further event handlers on the current target or on any other element in the propagation path.

Stop the propagation of this event. The event will not be sent to any further element in the propagation path. Further event handlers on the current target will be executed.

Generic base class for events, implementing event pooling and automatic registration to the event type system.

Get the type id for this event instance.

The type ID.

Get an event from the event pool. Use this function instead of newing events. Events obtained from this function should be released back to the pool using ReleaseEvent().

An event.

Release an event obtained from GetPooled().

The event to release.

Get the type id for this event instance.

The event instance type id.

Base class for objects that can get the focus.

Return true if the element can be focused.

Return the focus controller for this element.

An integer used to sort focusables in the focus ring. A negative value means that the element can not be focused.

Tell the element to release the focus.

Attempt to give the focus to this element.

Base class for defining in which direction the focus moves in a focus ring.

Last value for the direction defined by this class.

The null direction. This is usually used when the focus stays on the same element.

Focus came from an unspecified direction, for example after a mouse down.

The underlying integer value for this direction.

Class in charge of managing the focus inside a Panel.

The currently focused element.

Constructor.

Ask the controller to change the focus according to the event. The focus controller will use its focus ring to choose the next element to be focused.

Event sent immediately after an element has gained focus. Capturable, does not bubbles, non-cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Base class for focus related events.

Direction of the focus change.

For FocusOut and Blur events, the element gaining the focus. For FocusIn and Focus events, the element losing the focus.

Get an event from the event pool and initialize it with the given values. Use this function instead of newing events. Events obtained from this function should be released back to the pool using ReleaseEvent().

The event target. The related target. The direction of the focus change. An event.

Reset the event members to their initial value.

Event sent immediately before an element gains focus. Capturable, bubbles, non-cancellable.

Constructor.

Reset the event members to their initial value.

Event sent immediately before an element loses focus. Capturable, bubbles, non-cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Reset the event members to their initial value.

Interface for event dispatchers.

The element capturing the mouse, if any.

Dispatch an event to the panel.

The event to dispatch. The panel where the event will be dispatched.

Release the capture.

Release capture and notify capturing element.

Take the capture.

The element that takes the capture.

Interface for class capable of handling events.

Handle an event.

The event to handle.

Return true if event handlers for the event propagation bubble up phase have been attached on this object.

True if object has event handlers for the bubble up phase.

Return true if event handlers for the event propagation capture phase have been attached on this object.

True if object has event handlers for the capture phase.

Callback executed when the event handler loses the capture.

Interface for focus events.

Direction of the focus change.

Related target. See implementation for specific meaning.

Interface for classes implementing focus rings.

Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right.

Get the next element in the given direction.

Interface for keyboard events.

Return true if the Alt key is pressed.

The character.

Return true if the Windows/Command key is pressed.

Return true if the Control key is pressed.

The key code.

Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command).

Return true if the Shift key is pressed.

Class used to dispatch IMGUI event types that have no equivalent in UIElements events.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

The IMGUI event used to initialize the event. An event.

Reset the event members to their initial value.

Interface for mouse events.

Return true if the Alt key is pressed.

Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center.

Number of clicks.

Return true if the Windows/Command key is pressed.

Return true if the Control key is pressed.

The mouse position in the current target coordinate system.

Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command).

Mouse position difference between the last mouse event and this one.

The mouse position in the panel coordinate system.

Return true if the Shift key is pressed.

Interface for classes implementing UI panels.

Return the focus controller for this panel.

A reference to a scheduled action.

A scheduler allows you to register actions to be executed at a later point.

Add this item to the list of scheduled tasks.

The item to register.

Schedule this action to be executed later. The item will be automatically unscheduled after it has ran for the amount of time specified with the durationMs parameter.

Action to be executed. The minimum delay in milliseconds before executing the action. The minimum interval in milliseconds between each execution. The total duration in milliseconds where this item will be active. Internal reference to the scheduled action.

Schedule this action to be executed later. After the execution, the item will be automatically unscheduled.

Action to be executed. The minimum delay in milliseconds before executing the action. Internal reference to the scheduled action.

Schedule this action to be executed later. Item will be unscheduled when condition is met.

Action to be executed. The minimum delay in milliseconds before executing the action. The minimum interval in milliseconds bettwen each execution. When condition returns true, the item will be unscheduled. Internal reference to the scheduled action.

Manually unschedules a previously scheduled action.

The item to be removed from this scheduler.

This interface provides access to a VisualElement style data.

Alignment of the whole area of children on the cross axis if they span over multiple lines in this container.

Alignment of children on the cross axis of this container.

Similar to align-items, but only for this specific element.

Background color to paint in the element's box.

Background image to paint in the element's box.

Background image scaling in the element's box.

Space reserved for the bottom edge of the border during the layout phase.

This is the radius of the bottom-left corner when a rounded rectangle is drawn in the element's box.

This is the radius of the bottom-right corner when a rounded rectangle is drawn in the element's box.

Space reserved for the bottom edge of the border during the layout phase.

Color of the border to paint inside the element's box.

Space reserved for the left edge of the border during the layout phase.

This is the radius of every corner when a rounded rectangle is drawn in the element's box.

Space reserved for the right edge of the border during the layout phase.

Space reserved for the top edge of the border during the layout phase.

This is the radius of the top-left corner when a rounded rectangle is drawn in the element's box.

This is the radius of the top-right corner when a rounded rectangle is drawn in the element's box.

Space reserved for the top edge of the border during the layout phase.

Ration of this element in its parent during the layout phase.

Direction of the main axis to layout children in a container.

Placement of children over multiple lines if not enough space is available in this container.

Font to draw the element's text.

Font size to draw the element's text.

Font style to draw the element's text.

Fixed height of an element for the layout.

Justification of children on the main axis of this container.

Space reserved for the bottom edge of the margin during the layout phase.

Space reserved for the left edge of the margin during the layout phase.

Space reserved for the right edge of the margin during the layout phase.

Space reserved for the top edge of the margin during the layout phase.

Maximum height for an element, when it is flexible or measures its own size.

Maximum width for an element, when it is flexible or measures its own size.

Minimum height for an element, when it is flexible or measures its own size.

Space reserved for the bottom edge of the padding during the layout phase.

Space reserved for the left edge of the padding during the layout phase.

Space reserved for the right edge of the padding during the layout phase.

Space reserved for the top edge of the padding during the layout phase.

Bottom distance from the element's box during layout.

Left distance from the element's box during layout.

Right distance from the element's box during layout.

Top distance from the element's box during layout.

Element's positioning in its parent container.

Size of the 9-slice's bottom edge when painting an element's background image.

Size of the 9-slice's left edge when painting an element's background image.

Size of the 9-slice's right edge when painting an element's background image.

Size of the 9-slice's top edge when painting an element's background image.

Text alignment in the element's box.

Clipping if the text does not fit in the element's box.

Color to use when drawing the text of an element.

Fixed width of an element for the layout.

Word wrapping over multiple lines if not enough space is available to draw the text of an element.

This interface provides access to a VisualElement transform data.

Transformation matrix calculated from the position, rotation and scale of the transform (Read Only).

The position of the VisualElement's transform.

The rotation of the VisualElement's transform stored as a Quaternion.

The scale of the VisualElement's transform.

Interface allowing access to this elements datawatch.

Starts watching an object. When watched, all changes on an object will trigger the callback to be invoked.

The object to watch. Callback. A reference to this datawatch request. Disposing it will ensure any native resources will also be released.

Unregisters a previously watched request.

The registered request.

An internal reference to a data watch request.

This type allows UXML attribute value retrieval during the VisualElement instantiation. An instance will be provided to the factory method - see UXMLFactoryAttribute.

Attribute name. Default value if the property is not found. The attribute value or the default value if not found.

Attribute name. The raw value or null if not found.

Represents a scheduled task created with a VisualElement's schedule interface.

Returns the VisualElement this object is associated with.

Will be true when this item is scheduled. Note that an item's callback will only be executed when it's VisualElement is attached to a panel.

Repeats this action after a specified time.

Minimum amount of time in milliseconds between each action execution. This ScheduledItem.

Cancels any previously scheduled execution of this item and re-schedules the item.

Minimum time in milliseconds before this item will be executed.

After specified duration, the item will be automatically unscheduled.

The total duration in milliseconds where this item will be active. This ScheduledItem.

Removes this item from its VisualElement's scheduler.

If not already active, will schedule this item on its VisualElement's scheduler.

Adds a delay to the first invokation.

The minimum number of milliseconds after activation where this item's action will be executed. This ScheduledItem.

Item will be unscheduled automatically when specified condition is met.

When condition returns true, the item will be unscheduled. This ScheduledItem.

A scheduler allows you to register actions to be executed at a later point.

Schedule this action to be executed later.

The action to be executed. The action to be executed. Reference to the scheduled action.

Schedule this action to be executed later.

The action to be executed. The action to be executed. Reference to the scheduled action.

Base class for keyboard events.

Return true if the Alt key is pressed.

The character.

Return true if the Windows/Command key is pressed.

Return true if the Control key is pressed.

The key code.

Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command).

Return true if the Shift key is pressed.

The character for this event. The keyCode for this event. Event modifier keys that are active for this event. A keyboard IMGUI event. A keyboard event.

Reset the event members to their initial value.

Event sent when a key is pressed on the keyboard. Capturable, bubbles, cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Event sent when a key is released on the keyboard. Capturable, bubbles, cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Mouse down event.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Event sent when the mouse pointer enters an element or one of its descendent elements. Capturable, does not bubbles, non-cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Reset the event members to their initial value.

The base class for mouse events.

Return true if the Alt key is pressed.

Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center.

Number of clicks.

Return true if the Windows/Command key is pressed.

Return true if the Control key is pressed.

The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.

The mouse position in the current target coordinate system.

Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command).

Mouse position difference between the last mouse event and this one.

The mouse position in the screen coordinate system.

Return true if the Shift key is pressed.

A mouse IMGUI event. A mouse event that is the cause of this new event. A mouse event.

Reset the event members to their initial value.

Event sent when the mouse pointer exits an element and all its descendent elements. Capturable, does not bubbles, non-cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Reset the event members to their initial value.

Mouse move event.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Event sent when the mouse pointer exits an element. Capturable, bubbles, cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Event sent when the mouse pointer enters an element. Capturable, bubbles, cancellable.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Mouse up event.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Event sent after the layout is done in a tree. Non-capturable, does not bubble, non-cancellable.

True if the layout of the element has changed.

Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events.

Whether the target layout changed. An event.

Reset the event members to their initial value.

The propagation phases of an event.

The event is being sent to the event target.

The event is being sent to the event target parent element up to the root element.

The event is being sent to the root element down to the event target parent element.

The event is being sent to the target element for it to execute its default actions for this event. Event handlers do not get the events in this phase. Instead, ExecuteDefaultAction is called on the target.

The event is not being propagated.

Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented).

This enumeration contains values to control how an element is aligned in its parent during the layout phase.

Default value (currently FlexStart).

Items are centered on the cross axis.

Items are aligned at the end on the cross axis.

Items are aligned at the beginning on the cross axis.

Stretches items on the cross axis.

This enumeration defines values used to control in which direction a container will place its children during layout.

Vertical layout.

Vertical layout in reverse order.

Horizontal layout.

Horizontal layout in reverse order.

This enumeration contains values to control how children are justified during layout.

Items are centered.

Items are justified towards the end of the layout direction.

Items are justified towards the beginning of the main axis.

Items are evenly distributed in the line with extra space on each end of the line.

Items are evenly distributed in the line; first item is at the beginning of the line, last item is at the end.

This enumeration contains values to control how an element is positioned in its parent container.

The element is positioned in relation to its parent box and does not contribute to the layout anymore.

The element is positioned in relation to its default box as calculated by layout.

This enumeration contains values to control how elements are placed in a container if not enough space is available.

All elements are placed on the same line.

Elements are placed over multiple lines.

This interface exposes methods to read custom style properties applied from USS files to visual elements.

Read a style property value into the specified StyleValue<T>.

Name of the property in USS. Target StyleValue<T> field or variable to write to.