id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_sr_bb80d74e0baa
unity_docs
rendering
What is `ShaderUtil.IsShaderPropertyNonModifiableTexureProperty` in Unity? Explain its purpose and usage.
ShaderUtil.IsShaderPropertyNonModifiableTexureProperty Declaration public static bool IsShaderPropertyNonModifiableTexureProperty ( Shader s , int propertyIdx ); Parameters Parameter Description s The shader to check against. propertyIdx The property index to use. Description Is the shader propery at i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0dd0a45eb236
unity_docs
rendering
What is `Lightmapping.BakeAsync` in Unity? Explain its purpose and usage.
Lightmapping.BakeAsync Declaration public static bool BakeAsync (); Returns bool Returns true if the bake was successfully started. Will return false and print a warning message if it's not possible to start the bake. Description Starts an asynchronous bake job. The progress can be monitored via isRunnin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9a62f19dcc5
unity_docs
editor
What is `SceneManagement.EditorSceneManager.OpenScene` in Unity? Explain its purpose and usage.
EditorSceneManager.OpenScene Declaration public static SceneManagement.Scene OpenScene (string scenePath , SceneManagement.OpenSceneMode mode = OpenSceneMode.Single); Parameters Parameter Description scenePath The path of the Scene. This should be relative to the Project folder; for example, "Assets/My...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46aed2934939
unity_docs
ui
What is `Experimental.GraphView.Node.extensionContainer` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node.extensionContainer public UIElements.VisualElement extensionContainer ; Description Empty container used to display custom elements. After adding elements, call RefreshExpandedState in order to toggle this container vi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3485f117ad40
unity_docs
rendering
Show me a Unity code example for 'Rendering Profiler module reference'.
# Availability in Players The Rendering module Profiler counters are also available in Players. Use the ProfilerRecorder API to access Render Profiler module information in Players. High level counters are also available in Release Player. The following example contains a simple script that collects SetPass Calls Coun...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_021f0496993b
unity_docs
rendering
Show me a Unity code example for 'Capturing frame rate'.
ued at precise regular intervals for the purposes of recording. The interval between frames is equal to 1 / Time.captureFramerate , so if you set the value to 5.0 then updates occur every fifth of a second. With the demands on frame rate effectively reduced, you have time in the Update or LateUpdate functions to save s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b655df7b3d07
unity_docs
audio
Show me a Unity C# example demonstrating `AudioImporter.GetOverrideSampleSettings`.
ttings for the given platform. If there is no override for the passed platform, the default translated settings will be returned. The translated settings are the default settings to use for the given platform. For example on some platforms, the compressionFormat will be different to depending on different hardware d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_80d04b11ebb7
unity_docs
editor
In Unity's 'InspectorElement', what is 'Create an InspectorElement' and how does it work?
You can create an InspectorElement with UXML or C#. The following C# example creates an InspectorElement and binds it to a SerializedObject: ```csharp using UnityEditor.UIElements; ... var inspectorElement = new InspectorElement(); var serializedObject = new SerializedObject(myObject); inspectorElement.Bind(serializedO...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_40298ca9621b
unity_docs
editor
What is `Profiling.Sampler.GetRecorder` in Unity? Explain its purpose and usage.
Sampler.GetRecorder Declaration public Profiling.Recorder GetRecorder (); Returns Recorder Recorder object associated with the Sampler. Description Returns Recorder associated with the Sampler. Each Sampler has only one recorder. Multiple calls to GetRecorder return references that control the same ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_56553de6582d
unity_docs
ui
In Unity's 'Introduction to IL2CPP', what is 'Building a project with IL2CPP' and how does it work?
To build a project with IL2CPP, you must have Il2CPP installed as part of your Unity installation. You can select IL2CPP as an optional module when you first install a version of Unity, or add IL2CPP support to an existing installation through the Unity Hub. For more information, refer to Installing the Unity Hub and A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_faf39acdfa79
unity_docs
editor
Show me a Unity C# example demonstrating `PlayerSettings.Android.autoRotationBehavior`.
PlayerSettings.Android.autoRotationBehavior public static AndroidAutoRotationBehavior autoRotationBehavior ; Description Indicate whether your application window rotates based on device orientation settings (User) or device orientation sensor (Sensor), when default orientation is Auto Rotation. ```csharp usi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78bd34b39662
unity_docs
editor
What is `Rendering.BatchFilterSettings.sceneCullingMask` in Unity? Explain its purpose and usage.
BatchFilterSettings.sceneCullingMask public ulong sceneCullingMask ; Description Use this bit mask to discard the draw commands in a particular context. A draw command is not discarded if the expression (1 << layer) & sceneCullingMask is true. This field is typically used when rendering Editor previews.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac89136c232c
unity_docs
rendering
What is `Material.mainTexture` in Unity? Explain its purpose and usage.
Material.mainTexture public Texture mainTexture ; Description The main texture. By default, Unity considers a texture with the property name "_MainTex" to be the main texture. Use the [MainTexture] ShaderLab Properties attribute to make Unity consider a texture with a different property name to be the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c54babe3588a
unity_docs
scripting
Show me a Unity code example for 'Create a native plug-in for iOS'.
Create a native plug-in for iOS and import it into your Unity project. ## Define an extern method For each native function you want to call, define an extern method in the C# file as follows: ``` [DllImport ("__Internal")] private static extern float FooPluginFunction(); ``` ## Use C linkage to prevent name mangl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_319131e59c0a
unity_docs
math
Show me a Unity C# example demonstrating `SerializedProperty.isExpanded`.
nded public bool isExpanded ; Description Is this property expanded in the inspector? Serialized properties with child properties (e.g., arrays, custom serializable structs, or custom serializable classes) may be either expanded or folded up in the inspector to reveal or hide their children. The following examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a38d03723128
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture3D.GetPixels`.
etPixelData instead. A single call to GetPixels is usually faster than multiple calls to GetPixel , especially for large textures. If GetPixels fails, Unity throws an exception. GetPixels might fail if the array contains too much data. Use GetPixelData instead for very large textures. You can't use GetPixel ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3d034880566d
github
scripting
Write a Unity C# script called Queryable Base Behaviour
```csharp using UnityEngine; namespace CoreLibrary { /// <summary> /// Author: Cameron Reuschel <br/><br/> /// /// Inheriting from this class instead of <see cref="BaseBehaviour"/> /// causes a <see cref="Queryable"/> component to be added so that the /// inheriting class can be queri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fdd0ea7e12e1
unity_docs
physics
Show me a Unity C# example demonstrating `ArticulationBody.AddForceAtPosition`.
r more information on how ForceMode affects velocity, see Rigidbody.AddForce . Applying a force to an ArticulationBody wakes up that body. If the force size is zero then the ArticulationBody does not wake up. Unit of measurement - N (newtons). This method does not support ForceMode.Acceleration and ForceMode.Veloc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35a495d24b74
unity_docs
editor
What is `Search.QueryEngineParameterTransformerAttribute` in Unity? Explain its purpose and usage.
QueryEngineParameterTransformerAttribute class in UnityEditor.Search Description Base attribute class that defines a custom parameter transformer function. For a usage example, see QueryEngine.AddFiltersFromAttribute .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_73a4a6e1a5a8
unity_docs
scripting
Explain 'Using Terrain at runtime' in Unity.
The Terrain system uses dedicated Unity engine resources to function correctly. Unity includes these resources in your application at build time when you have at least one Terrain instance in a scene that’s part of your build profile . If your application only creates Terrain instances at runtime, make sure you include...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_784a8fdadf8b_doc_11
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The override URL pointing to a valid manifest with theme information, also a binary file. Signature: ```csharp public string ThemeManifestUrl; ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_b400ce4d14a4
unity_docs
scripting
What is `Unity.Android.Gradle.BaseBlock.AddElement` in Unity? Explain its purpose and usage.
BaseBlock.AddElement Declaration public void AddElement ( Unity.Android.Gradle.BaseElement element ); Parameters Parameter Description element Element to add as a child. Description Adds a new element as a child. Unity throws an exception if: The provided element already has a parent. A parent of this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_718944a7d1fa
unity_docs
scripting
Show me a Unity C# example demonstrating `Mesh.skinWeightBufferLayout`.
Mesh.skinWeightBufferLayout public SkinWeights skinWeightBufferLayout ; Description The dimension of data in the bone weight buffer. This value describes the layout of data in the mesh's bone weight buffer. It depends on how many bones that affect each vertex in the mesh. ```csharp using UnityEngine; public...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d2ecbc82e43
unity_docs
math
Show me a Unity C# example demonstrating `LightTransport.BufferSlice_1.SafeReinterpret`.
n Rules: The size of the target type must be a multiple of the size of the current type. The memory alignment requirements must be satisfied. The reinterpretation must not exceed buffer boundaries. This is useful for viewing the same data through different type lenses, such as treating a float buffer as a Vector3 b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb2f018c7b87
unity_docs
physics
What are the parameters of `Object.operator_eq` in Unity?
Description Compares two object references to see if they refer to the same object. When comparing with null , Unity's implementation of the equality operator can give different results than Object.ReferenceEquals or == in standard C#. In addition to checking if the managed object reference is null , the custom == oper...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6116755db381
github
scripting
Write a Unity C# XR/VR script for Animator State Machine Util
```csharp /** The MIT License (MIT) Copyright (c) 2014 Paul Hayes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_c2db0db3e8cc
unity_docs
scripting
Give me an overview of the `Progress` class in Unity.
Progress class in UnityEditor Description The Progress utility class reports the progress of asynchronous tasks to Unity. The Progress utility class can be used to report progress of asynchronous tasks in multiple ways. Here is an example of a task that runs on the EditorApplication.update loop and reports prog...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_99585a3494e1
unity_docs
editor
What is `RuntimeInitializeOnLoadMethodAttribute` in Unity? Explain its purpose and usage.
RuntimeInitializeOnLoadMethodAttribute class in UnityEngine / Inherits from: Scripting.PreserveAttribute / Implemented in: UnityEngine.CoreModule Description Use this attribute to get a callback when the runtime is starting up and loading the first scene. Use the various options for RuntimeInitializeLoadType...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3300450c2acb_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Base script template object Signature: ```csharp public abstract class BaseScriptTemplate : ScriptableObject ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_6ae041fc274d
unity_docs
editor
What are the parameters of `Search.SearchIndexer.GetMetaInfo` in Unity?
Returns string Metadata of the document. Description Get metadata of a specific document. ```csharp using System.IO; using UnityEditor; using UnityEditor.Search; using UnityEngine; /// <summary> /// Use GetMetaInfo to store some additional data about a specific document within the index db /// that you can retrieve la...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0a9ddab4182
unity_docs
xr
What is `Caching.GetCachedVersions` in Unity? Explain its purpose and usage.
Caching.GetCachedVersions Declaration public static void GetCachedVersions (string assetBundleName , List<Hash128> outCachedVersions ); Parameters Parameter Description assetBundleName The AssetBundle name. outCachedVersions List of all the cached version. Description Returns all cached versions of the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_998e39957ae7
unity_docs
physics
Give me an overview of the `SpringJoint` class in Unity.
SpringJoint class in UnityEngine / Inherits from: Joint / Implemented in: UnityEngine.PhysicsModule Description The spring joint ties together 2 rigid bodies, spring forces will be automatically applied to keep the object at the given distance. The Spring attempts to maintain the distance it has when it star...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0501a1cf881b
unity_docs
scripting
In Unity's 'Create a native plug-in for iOS', what is 'Use C linkage to prevent name mangling' and how does it work?
If using C++ (.cpp) or Objective-C++ (.mm) to implement your plug-in, declare functions with C linkage to avoid issues with name mangling: ``` extern "C" { float FooPluginFunction(); } ``` Plug-ins written in C or Objective-C don’t need this, because these languages don’t use name mangling.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22131015b4db
unity_docs
scripting
What is `Unity.Profiling.Memory.CaptureFlags.NativeStackTraces` in Unity? Explain its purpose and usage.
CaptureFlags.NativeStackTraces Description Specifies that Call-Stack Symbols for the Native Call-stack of each Allocation should be collected. Native Call stacks can only be collected from a build that supports the collection of Native Call-stack information, which currently requires Source Code access. To be able...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c351a47af442
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.SetTeamId` in Unity?
Description Sets the Team ID of an Xcode project. Use the Apple developer site to find your Team ID. ```csharp using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;public class Sample_SetTeamId { [PostProcessBuild] public static void OnPostprocessBuild(BuildTarget build...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_07926897b1a5
unity_docs
scripting
What is `iOS.Xcode.XcScheme.WriteToString` in Unity? Explain its purpose and usage.
XcScheme.WriteToString Declaration public string WriteToString (); Returns string The scheme contents as a plist-formatted string. Description Writes the contents of the scheme to a string.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_674cd5ad0460
unity_docs
animation
What is `StateMachineBehaviour.OnStateMachineExit` in Unity? Explain its purpose and usage.
StateMachineBehaviour.OnStateMachineExit Declaration public void OnStateMachineExit ( Animator animator , int stateMachinePathHash ); Parameters Parameter Description animator The Animator evaluating the state machine. stateMachinePathHash The hash of the full path to the state machine. Description Inv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca9e21436b21
unity_docs
math
What are the parameters of `TestTools.Coverage.GetSequencePointsFor` in Unity?
Returns CoveredSequencePoint[] Array of sequence points. Description Returns the coverage sequence points for the method you specify. See CoveredSequencePoint for more information about the coverage data this method returns. ```csharp using UnityEngine; using UnityEngine.TestTools; using System.Reflection;public class ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b74e3c673dd3
unity_docs
scripting
What is `Experimental.GraphView.GraphViewBlackboardWindow.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphViewBlackboardWindow Constructor Declaration public GraphViewBlackboardWindow (); Description Constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3b50c548d90
unity_docs
input
What is `Experimental.GraphView.EdgeDragHelper_1.HandleMouseUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeDragHelper<T0>.HandleMouseUp Declaration public void HandleMouseUp ( UIElements.MouseUpEvent evt ); Parameters Parameter Description evt The event. Description Handle mouse up event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d183f3ca1cea
unity_docs
editor
Show me a Unity code example for 'Create a command file to set environment variables and open applications'.
command file (Windows) These instructions create an executable file named launchUnityHub.cmd . Close the Unity Hub, if it’s running. Open a text editor such as Notepad. Enter the following text, adjusting as necessary: Include only the required environment variables, and set their values properly. Refer to Before you ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5c037406893
unity_docs
rendering
What is `MovieTexture` in Unity? Explain its purpose and usage.
Removed MovieTexture class in UnityEngine / Inherits from: Texture / Implemented in: UnityEngine.AudioModule Obsolete MovieTexture is removed. Use VideoPlayer instead. Description MovieTexture has been removed. Use VideoPlayer instead. Inherited Members Static Properties Property Description allowThr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_33c2e1f3983d
unity_docs
xr
What is `LightTransport.IProbeIntegrator.SetProgressReporter` in Unity? Explain its purpose and usage.
IProbeIntegrator.SetProgressReporter Declaration public void SetProgressReporter ( LightTransport.BakeProgressState progress ); Parameters Parameter Description progress Progress state object that will receive updates during integration. Description Configures progress tracking for integration operations....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b523bd97ab16
unity_docs
rendering
Show me a Unity C# example demonstrating `MonoBehaviour.OnBecameVisible`.
a in the Unity Editor is treated like a regular camera for visibility checks, so OnBecameVisible can be called when objects are visible in the Scene view, even if the application isn't running. Scripts that execute in Edit mode can check Application.isPlaying before running important logic in OnBecameVisible to a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efb27f065595
unity_docs
scripting
What is `Video.VideoPlayer.width` in Unity? Explain its purpose and usage.
VideoPlayer.width public uint width ; Description The width of the images in the VideoClip , or URL, in pixels. (Read Only) For URL sources, this will only be set once the source preparation is completed. See VideoPlayer.Prepare .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f5ca0e3d6b3
unity_docs
rendering
Give me an overview of the `Graphics` class in Unity.
Graphics class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Raw interface to Unity's drawing functions. This is the high-level shortcut into the optimized mesh drawing functionality of Unity. Static Properties Property Description activeColorBuffer Currently active color buffer (Read ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ab5c6957e8cc
unity_docs
rendering
In Unity's 'Introduction to writing shaders in code', what is 'Languages' and how does it work?
When you write shaders for Unity, you use the following languages: A programming language called HLSL. Use this to write the shader programs themselves. For more information on HLSL, see HLSL in Unity . A Unity-specific language called ShaderLab. Use this to define a Shader object , which acts as a container for your s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_650807adf726
unity_docs
rendering
What is `Canvas.pixelRect` in Unity? Explain its purpose and usage.
Canvas.pixelRect public Rect pixelRect ; Description Get the render rect for the Canvas . If in overlay mode this will be the screen dimensions. If in world mode this will be the camera screen viewport rect.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_784959a18276
unity_docs
scripting
What is `GUILayoutOption` in Unity? Explain its purpose and usage.
GUILayoutOption class in UnityEngine / Implemented in: UnityEngine.IMGUIModule Description Class internally used to pass layout options into GUILayout functions. You don't use these directly, but construct them with the layouting functions in the GUILayout class. Additional resources: GUILayout.Width , GU...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf49b98a023d
unity_docs
editor
What is `Device.SystemInfo.supportsAccelerometer` in Unity? Explain its purpose and usage.
SystemInfo.supportsAccelerometer public static bool supportsAccelerometer ; Description This has the same functionality as SystemInfo.supportsAccelerometer and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f8e7d134dcd
unity_docs
performance
Show me a Unity C# example demonstrating `Unity.IO.LowLevel.Unsafe.AsyncReadManager.ReadDeferred`.
ead operation has started. Doing so could lead to buffer overruns and race conditions. (If you change the number of commands, remember to update the ReadCommandArray.CommandCount field, too.) Note: WebGL builds do not support using AsyncReadManager to open files from a remote web server; for example, from the path...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56f6e1ae0254
unity_docs
scripting
What is `ParticleSystem.ForceOverLifetimeModule.zMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.ForceOverLifetimeModule.zMultiplier public float zMultiplier ; Description Defines the z-axis multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall z-axis multiplier. ```csharp using UnityEngine; using System.Collections;[Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8429ec7d301
unity_docs
rendering
What is `MaterialProperty.type` in Unity? Explain its purpose and usage.
MaterialProperty.type public MaterialProperty.PropType type ; Description Type of the property (Read Only). Material properties can be textures, colors, floats and so on. Depending on the type, you should use textureValue , colorValue , vectorValue or floatValue to access the property value.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7faba256ab5
unity_docs
scripting
What is `Media.MediaTime.operator_double` in Unity? Explain its purpose and usage.
MediaTime.double Parameters Parameter Description t Time to convert. Description Returns the time value expressed as a floating point number of seconds. A loss of precision may result when performing the conversion. Converting invalid time values (see isValid ) returns 0.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc73f2de0475
unity_docs
scripting
What is `ParticleSystemForceField.rotationRandomness` in Unity? Explain its purpose and usage.
ParticleSystemForceField.rotationRandomness public Vector2 rotationRandomness ; Description Apply randomness to the Force Field axis that particles will travel around. When applying rotational forces to particles, the particles will spin around the Z axis of the Force Field's Transform component by default. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4c10530ed37
unity_docs
scripting
What are the parameters of `Random.InitState` in Unity?
Description Initializes the random number generator state with a seed. The random number generator is not truly random, but produces numbers in a preset sequence (the values in the sequence "jump" around the range in such a way that they appear random for most purposes). The point in the sequence where a particular run...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e534a05c09d2
unity_docs
math
What is `SerializedProperty.quaternionValue` in Unity? Explain its purpose and usage.
SerializedProperty.quaternionValue public Quaternion quaternionValue ; Description Value of a quaternion property. Additional resources: propertyType , SerializedPropertyType.Quaternion , Quaternion .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d92d8077052
unity_docs
scripting
What is `Playables.PlayableExtensions.GetLeadTime` in Unity? Explain its purpose and usage.
PlayableExtensions.GetLeadTime Declaration public static float GetLeadTime (U playable ); Parameters Parameter Description playable The Playable used by this operation. Description Returns the Playable lead time in seconds. PrepareData() is called when the lead time is greater than the Playable del...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79e112231f84
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R32_SInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R32_SInt Description A one-component, 32-bit signed integer format that has a single 32-bit R component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d7db6bceefba
unity_docs
scripting
In Unity's 'Box', what is 'Inherited UXML attributes' and how does it work?
This element inherits the following attributes from its base class: Name Type Description focusable boolean If false, this prevents the element from being focused. The element can only be focused if its canGrabFocus property is true. tabindex int An integer used to sort focusable elements in the focus ring. Must be gre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f37aa38df415
unity_docs
rendering
Give me an overview of the `TextureImporterSettings` class in Unity.
TextureImporterSettings class in UnityEditor Description Stores settings of a TextureImporter . Additional resources: TextureImporter . Properties Property Description alphaIsTransparency If the alpha channel of your texture represents transparency, enable this property to dilate the color channels of visib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7317fe3dbf4f
unity_docs
rendering
In Unity's 'How Unity compiles branching shaders', what is 'Choosing a shader variant type' and how does it work?
If you only need a shader to branch based on material properties, use shader_feature . Unity compiles shader variants for keyword combinations that materials in your build use, and removes other shader variants. This keeps build times low and file sizes small. Note: At runtime, if you use a keyword combination you didn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7dfc629cfe17
unity_docs
scripting
Show me a Unity C# example demonstrating `Random.value`.
turns a random float within [0.0..1.0] (range is inclusive) (Read Only). Important : Both the lower and upper bounds are inclusive . Any given float value between 0.0 and 1.0, including both 0.0 and 1.0 , will appear on average approximately once every ten million random samples. See Random for more examples of ho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9199c1529118
unity_docs
physics
What is `ArticulationBody.collisionDetectionMode` in Unity? Explain its purpose and usage.
ArticulationBody.collisionDetectionMode public CollisionDetectionMode collisionDetectionMode ; Description The ArticulationBody's collision detection mode. Use this property to set up an ArticulationBody for continuous collision detection, in order to prevent fast moving objects from passing through other ob...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4c9fc2e165c5_doc_1
github
scripting
What does `Init` do in this Unity script? Explain its purpose and signature.
The method initializes current state of the observerA reference to a world context from which the entity will be retrievedAn identifier of an entity Signature: ```csharp public void Init(IWorldContext worldContext, EntityId entityId) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_867d76f191ec
unity_docs
scripting
What is `ParticleSystem.lifetimeByEmitterSpeed` in Unity? Explain its purpose and usage.
ParticleSystem.lifetimeByEmitterSpeed public ParticleSystem.LifetimeByEmitterSpeedModule lifetimeByEmitterSpeed ; Description Script interface for the Particle System Lifetime By Emitter Speed module. This module controls the initial lifetime of each particle based on the speed of the emitter when the partic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2319c7275146
unity_docs
physics
What is `MPE.RoleProviderAttribute.ctor` in Unity? Explain its purpose and usage.
RoleProviderAttribute Constructor Declaration public RoleProviderAttribute (string name , MPE.ProcessEvent eventType ); Declaration public RoleProviderAttribute ( MPE.ProcessLevel level , MPE.ProcessEvent eventType ); Parameters Parameter Description name The name of the RoleProvider. For example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f7da9511e87
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.Find`.
in. The more GameObjects you have and the more frequently you call GameObject.Find , the greater the impact on your application's performance. Instead, cache the result in a member variable at startup, or use GameObject.FindWithTag . To find a child GameObject, it's often preferable to use Transform.Find , which onl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_491c27615a90
unity_docs
rendering
Explain 'Shader block in ShaderLab reference' in Unity.
A Shader object is a Unity-specific concept; it is a wrapper for shader programs and other information. It lets you define multiple shader programs in the same file, and tell Unity how to use them. A Shader object has a nested structure; it organizes information into structures called SubShaders and Passes. Inside the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_40f32250437b
unity_docs
ui
Show me a Unity code example for 'Extending the device simulator'.
ide the title property to return a non-empty string. Override the OnCreateUI method to return a VisualElement that contains the UI. If your plugin doesn’t meet these conditions, the Device Simulator instantiates the plugin but doesn’t display its UI in the Simulator view. The following example demonstrates how to creat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_65ecbd05231f
unity_docs
xr
In Unity's 'Git dependencies', what is 'Git URLs' and how does it work?
The Package Manager supports all Git protocols , with the exception of local file paths. To specify a Git URL as a dependency, add the name of the package to add with a Git URL instead of the version number or local file path to the project manifest . For example, this demonstrates how to specify a remote Git using dif...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a4913ed4362
unity_docs
scripting
Show me a Unity C# example demonstrating `Gizmos.DrawWireCube`.
Gizmos.DrawWireCube Declaration public static void DrawWireCube ( Vector3 center , Vector3 size ); Description Draw a wireframe box with center and size . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void OnDrawGizmosSelected() { // Draw a yellow c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbdc6d3d507e
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GetMarkerId`.
when traversing Profiler data. The Profiler uses a unique identifier for each marker it creates during a profiling session. The markers can generate many samples which HierarchyFrameDataView and RawFrameDataView can access. All samples that the same marker generates have the same integer marker identifier and the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c551694c3e06
unity_docs
rendering
In Unity's 'Optimize distribution size', what is 'Split APKs by target architecture' and how does it work?
If your output application uses APK format, the Split APKs by target architecture Player Setting optimizes the application download and installation size. Instead of producing one APK that contains binaries for every target CPU architecture selected in the Target Architectures Player Setting, Unity creates a separate A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90e6bd338c17
unity_docs
scripting
What is `Tilemaps.ITilemap.ctor` in Unity? Explain its purpose and usage.
ITilemap Constructor Declaration public ITilemap ( Tilemaps.Tilemap tilemap ); Parameters Parameter Description tilemap The Tilemap to wrap. Description Initializes and returns an instance of ITilemap . This will wrap the Tilemap parameter and is passed onto Tile s when information is queried from ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e5b085b4dcf
unity_docs
rendering
What is `TextureImporter.compressionQuality` in Unity? Explain its purpose and usage.
TextureImporter.compressionQuality public int compressionQuality ; Description The quality of the texture after Crunch compresses it. The range is 0 through 100. A higher value means a larger, better-quality texture, but a longer compression time because Crunch needs more time to try different texture encodings...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_85beb4e7d4bc
unity_docs
animation
In Unity's 'Playables Examples', what is 'Play a single animation clip on a GameObject' and how does it work?
This example demonstrates a simple PlayableGraph with a single playable output that is linked to a single playable node. The playable node plays a single animation clip (clip). An AnimationClipPlayable must wrap the animation clip to make it compatible with the Playables API. ```csharp using UnityEngine; using UnityEng...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1333eccb7c53
unity_docs
scripting
What is `Rendering.VertexAttributeFormat.SNorm16` in Unity? Explain its purpose and usage.
VertexAttributeFormat.SNorm16 Description 16-bit signed normalized number. This format stores uniformly quantized numbers in [-1..1] range, with 16 bits of precision (65536 possible different values). Additional resources: Mesh class, VertexAttribute enum, Mesh.GetVertexAttributeFormat .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_770d1ca4bb49
unity_docs
scripting
Explain 'Test and debug an iOS application' in Unity.
Refer to the following sections to understand how to test and debug your Unity iOS project, and troubleshoot common crashes: Topic Description Device Simulator for iOS Simulate how your application will appear and behave on an iOS device. Collecting performance data on an iOS device Connect an iOS device to Unity and p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09247259f84e
unity_docs
animation
What is `Animations.AnimatorStateMachine.AddStateMachine` in Unity? Explain its purpose and usage.
AnimatorStateMachine.AddStateMachine Declaration public Animations.AnimatorStateMachine AddStateMachine (string name ); Declaration public Animations.AnimatorStateMachine AddStateMachine (string name , Vector3 position ); Parameters Parameter Description name The name of the new state machine. p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_807954272bf0
unity_docs
scripting
Show me a Unity C# example demonstrating `ILogHandler`.
ILogHandler interface in UnityEngine Description Interface for custom log handler implementation. ILogHandler interface to ease unit-testing and mocking of loggers. ```csharp using UnityEngine; using System.Collections; using System.IO; using System;public class MyFileLogHandler : ILogHandler { private FileStre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d0b7bdb2799
unity_docs
scripting
What is `Rendering.CommandBuffer.RequestAsyncReadbackIntoNativeSlice` in Unity? Explain its purpose and usage.
CommandBuffer.RequestAsyncReadbackIntoNativeSlice Declaration public void RequestAsyncReadbackIntoNativeSlice (ref NativeSlice<T> output , Texture src , Action<AsyncGPUReadbackRequest> callback ); Declaration public void RequestAsyncReadbackIntoNativeSlice (ref NativeSlice<T> output , Texture src , int ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f685c0655eb
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.NoiseModule.remapZMultiplier`.
ParticleSystem.NoiseModule.remapZMultiplier public float remapZMultiplier ; Description z-axis remap multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall remap multiplier. Additional resources: ParticleSystem.NoiseModule.remapZ . ```csha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_619f8f02643a
unity_docs
rendering
In Unity's 'Control occlusion in areas with Occlusion Portals', what is 'Opening and closing an Occlusion Portal at runtime' and how does it work?
Use a script to set the Occlusion Portal’s open property to the desired state. ```csharp void OpenDoor() { // Toggle the Occlusion Portal's open state, so that Unity renders the GameObjects behind it myOcclusionPortal.open = true; // Call a function that plays a door opening animation, or otherwise hides the GameO...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f3fc1d4bbcc
unity_docs
scripting
What is `AI.NavMeshBuildSettings.voxelSize` in Unity? Explain its purpose and usage.
NavMeshBuildSettings.voxelSize public float voxelSize ; Description Sets the voxel size in world length units. The NavMesh is built by first voxelizing the Scene, and then figuring out walkable spaces from the voxelized representation of the Scene. The voxel size controls how closely the NavMesh fits the geomet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5ed5b094b1f
unity_docs
math
What is `FindObjectsInactive` in Unity? Explain its purpose and usage.
FindObjectsInactive enumeration Description Options to control whether object find functions return inactive objects. The Object.FindObjectsByType(), Object.FindFirstObjectByType() and Object.FindAnyObjectByType() functions can take a parameter of this type to indicate whether they should include inactive objects ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b336073faf57
unity_docs
scripting
What is `EditorTools.GameObjectToolContext` in Unity? Explain its purpose and usage.
GameObjectToolContext class in UnityEditor.EditorTools / Inherits from: EditorTools.EditorToolContext Description This class represents the default context for manipulation tools. When GameObjectToolContext is active, manipulation tools affect the transform property of GameObjects in the SceneView Selection...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_267c8d93e6a2
unity_docs
xr
Explain 'Details panel reference (feature sets)' in Unity.
In the Package Manager window, when you select a feature set from the list panel, the details panel on the right displays details for the selected feature set. The details panel presents the contents of the feature set as a kind of miniature Package Manager window: (A) When you select a feature set from the list panel ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c822b60109ab
unity_docs
rendering
Explain 'Add ambient occlusion in the Built-In Render Pipeline' in Unity.
Ambient occlusion (AO) is a feature that simulates the soft shadows that occur in creases, holes, and surfaces that are close to each another. These areas occlude (block out) ambient light , so they appear darker. It works by approximating how much ambient light can hit a point on a surface. It then darkens creases, ho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7de703dd7b6
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector2.MoveTowards`.
Towards Declaration public static Vector2 MoveTowards ( Vector2 current , Vector2 target , float maxDistanceDelta ); Description Moves a point current towards target . This is essentially the same as Vector2.Lerp but instead the function will ensure that the distance never exceeds maxDistanceDelta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a439ac8de523
github
scripting
Write a Unity Editor script for Interface Selector Drawer
```csharp // Copyright (c) Mixed Reality Toolkit Contributors // Licensed under the BSD 3-Clause using System; using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEngine; namespace MixedReality.Toolkit.Editor { /// <summary> /// A custom property drawer for fields decorated with...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c1af5810fcb
unity_docs
math
Show me a Unity C# example demonstrating `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.MemCpyStride`.
ures with padding or interleaved data. It allows efficient data transfer when direct element alignment is not feasible. Ensure that both source and destination pointers are valid and that their memory regions do not incorrectly overlap, which would lead to undefined behavior. This method does not perform bounds checkin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c846be2bc09
unity_docs
rendering
What is `ImageConversion.EncodeToJPG` in Unity? Explain its purpose and usage.
ImageConversion.EncodeToJPG Declaration public static byte[] EncodeToJPG ( Texture2D tex , int quality ); Declaration public static byte[] EncodeToJPG ( Texture2D tex ); Parameters Parameter Description tex Text texture to convert. quality JPG quality to encode with. The range is 1 through 100. 1 i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6e527b857d9
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.parent`.
Transform.parent public Transform parent ; Description The parent of the transform. Changing the parent will modify the parent-relative position, scale and rotation but keep the world space position, rotation and scale the same. Additional resources: SetParent . ```csharp using UnityEngine; using System.Co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5da50fd982bf
unity_docs
scripting
What is `Search.QueryListBlock.Apply` in Unity? Explain its purpose and usage.
QueryListBlock.Apply Declaration public void Apply (InAttribute) searchProposition ); Parameters Parameter Description searchProposition Selected proposition to be applied to the source. Description Apply proposition to the block.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_651075792db5
unity_docs
ui
In Unity's 'ToolbarSearchField', what is 'Inherited UXML attributes' and how does it work?
This element inherits the following attributes from its base class: Name Type Description focusable boolean If false, this prevents the element from being focused. The element can only be focused if its canGrabFocus property is true. placeholder-text string A short hint to help users understand what to enter in the fie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_08f687f84fd5
unity_docs
rendering
Explain 'Control when a Custom Render Texture updates' in Unity.
## Update Zones When Unity updates a Custom Render Texture , it uses the Material to update the whole texture at once by default. The Custom Render Texture allows you to define zones of partial update. You can use this to define as many zones as you want and the order in which the zones are processed. You can use upda...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a74a5367d1a
unity_docs
physics
What are the parameters of `Rigidbody2D.AddTorque` in Unity?
Description Apply a torque at the rigidbody's centre of mass. Applying torque to the Rigidbody2D changes the angularVelocity only. This change is scaled (divided) by the rotational inertia . Therefore, a larger inertia results in smaller changes to angularVelocity , and a smaller inertia results in larger changes to an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_86589fea9116
unity_docs
animation
Explain '2D Blending' in Unity.
The first option in the Inspector of a Blend Node is the Blend Type . This drop-down is used to select one of the different blend types that can blend according to one or two parameters. The 2D blending types blends the child motions according to two parameters. The different 2D Blend Types have different uses that the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27fa0788d4d1
unity_docs
rendering
What is `MaterialEditor.TexturePropertyWithHDRColor` in Unity? Explain its purpose and usage.
MaterialEditor.TexturePropertyWithHDRColor Declaration public Rect TexturePropertyWithHDRColor ( GUIContent label , MaterialProperty textureProp , MaterialProperty colorProperty , bool showAlpha ); Obsolete Use TexturePropertyWithHDRColor(GUIContent label, MaterialProperty textureProp, MaterialProper...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.