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_a78d06af95b1
unity_docs
rendering
What is `Rendering.CommandBuffer.Blit` in Unity? Explain its purpose and usage.
CommandBuffer.Blit Declaration public void Blit ( Texture source , Rendering.RenderTargetIdentifier dest ); Declaration public void Blit ( Texture source , Rendering.RenderTargetIdentifier dest , Material mat ); Declaration public void Blit ( Texture source , Rendering.RenderTargetIdentifier ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f71e249b7c1c
unity_docs
rendering
What is `Texture2D.GetPixels` in Unity? Explain its purpose and usage.
Texture2D.GetPixels Declaration public Color[] GetPixels (int miplevel = 0); Parameters Parameter Description miplevel The mipmap level to get. The range is 0 through the texture's Texture.mipmapCount . The default value is 0 . Returns Color[] An array that contains the pixel colors. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_854b35ca8602
unity_docs
editor
What is `Search.ISearchQuery` in Unity? Explain its purpose and usage.
ISearchQuery interface in UnityEditor.Search Description This search query interface is used when handling search query objects. These can be either assets saved in the user project or saved in the user preferences. Properties Property Description creationTime Indicates the binary long time of when the search ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_815a963f180c
unity_docs
physics
What is `ParticleSystem.ExternalForcesModule.IsAffectedBy` in Unity? Explain its purpose and usage.
ParticleSystem.ExternalForcesModule.IsAffectedBy Declaration public bool IsAffectedBy ( ParticleSystemForceField field ); Parameters Parameter Description field The Force Field to test. Returns bool Whether the Force Field affects the Particle System. Description Determines whether any particles ar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a82424b04054
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.CullingResults`.
e the same CullingResults struct multiple times within the same render loop, and you can share a CullingResults struct between multiple Cameras if you know that they can see the same objects. This can save on wasted CPU operations, and therefore improve performance. This example demonstrates how to obtain a Cull...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed44acf711c6
unity_docs
audio
What is `AudioImporter.defaultSampleSettings` in Unity? Explain its purpose and usage.
AudioImporter.defaultSampleSettings public AudioImporterSampleSettings defaultSampleSettings ; Description The default sample settings for the AudioClip importer. These are the default settings for the AudioClip. If there are no overrides defined for a given build target, these settings will be used as the ba...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b8b3f645e203
unity_docs
rendering
Explain 'Terrain Layers' in Unity.
A Terrain Layer is an Asset that defines a Terrain ’s surface qualities. A Terrain Layer holds Textures and other properties that the Terrain’s Material uses to render the Terrain surfaces. Because Terrain Layers are Assets, you can reuse them on multiple Terrain tiles. You can add Textures to the surface of a Terrain ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d3ae21befdf
unity_docs
rendering
What is `ParticleSystem.LightsModule.intensity` in Unity? Explain its purpose and usage.
ParticleSystem.LightsModule.intensity public ParticleSystem.MinMaxCurve intensity ; Description Define a curve to apply custom intensity scaling to particle Lights. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;// For best results, use Deferred Rendering (see Cam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ac69116fee0
unity_docs
xr
What is `PlayerSettings.WSATargetFamily` in Unity? Explain its purpose and usage.
WSATargetFamily enumeration Description Options for the set of Universal Windows Platform device families your application can directly support. A device family identifies the APIs, system characteristics, and behaviors across a class of devices. It also determines the set of devices on which users can install yo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3a5c0e67bc7
unity_docs
scripting
What is `UIElements.BaseTreeView.SetSelectionById` in Unity? Explain its purpose and usage.
BaseTreeView.SetSelectionById Declaration public void SetSelectionById (int id ); Parameters Parameter Description id The item id. Description Sets the currently selected item by id. This will also expand the selected item if not expanded already. Declaration public void SetSelectionById (IEnumera...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98452718733e
unity_docs
networking
What is `Networking.IMultipartFormSection.sectionName` in Unity? Explain its purpose and usage.
IMultipartFormSection.sectionName public string sectionName ; Returns string The section's name, or null . Description Returns the name of this section, if any. Returns the name of this section; this is equivalent to the name of the form field which this section represents. In HTML terms, it is the name ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8b8e48b01a3
unity_docs
performance
What is `Unity.Jobs.LowLevel.Unsafe.BatchQueryJob_2.ctor` in Unity? Explain its purpose and usage.
BatchQueryJob<T0,T1>.BatchQueryJob(NativeArray<CommandT> commands, NativeArray<ResultT> results) Parameters Parameter Description commands A NativeArray<T0> that contains the commands to execute during a batch. The job that executes the query only reads from this native array, and doesn't write to it. results ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dec3e40f73cd
unity_docs
editor
What are the parameters of `Handles.DrawTexture3DVolume` in Unity?
Description Draws a 3D texture using Volume rendering mode in 3D space. Teapot volume rendered with a gradient that has a transparent black outline. Noise volume with fire gradient applied. ```csharp using UnityEditor; using UnityEngine;[ExecuteInEditMode] public class Reference : MonoBehaviour { public Texture3D t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_736922bda1b5
unity_docs
networking
Explain 'Unity Accelerator requirements' in Unity.
You can install Unity Accelerator in the following ways: Through the Accelerator Installer Through Docker Hub After you install Unity Accelerator, you must configure it in the Unity Editor . ## Operating system The local host must run one of the following operating systems: Linux (Fedora 35, RedHat/CentOS 9, Ubuntu 2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7861e79689c0
unity_docs
scripting
Give me an overview of the `PlayerSettings` class in Unity.
PlayerSettings class in UnityEditor / Inherits from: Object Description Use Player settings to define how Unity builds and displays your final application. Static Properties Property Description accelerometerFrequency Accelerometer update frequency. actionOnDotNetUnhandledException Sets the crash behavior ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24d150920b68
unity_docs
rendering
What is `Rendering.VertexAttribute.TexCoord3` in Unity? Explain its purpose and usage.
VertexAttribute.TexCoord3 Description Additional texture coordinate. UVs usually use Vector2 format. Vector2 uses two 32-bit floats; 8 bytes in total. This vertex attribute maps to the TEXCOORD3 semantic in HLSL. This UV channel is also commonly called "UV3". It corresponds to Mesh.uv4 . Additional resources: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fd6384bd2804
unity_docs
rendering
Explain 'Standard Shader in the Built-In Render Pipeline' in Unity.
Resources for using the Standard Shader to render real-world objects such as stone, wood, glass, plastic and metal, use the Standard Shader. Page Description Introduction to the Standard Shader Understand how the Standard Shader uses an advanced lighting model called physically-based shading (PBR). Changing material pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2b4ea4fb3a0
unity_docs
performance
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderDescription.UnitType` in Unity? Explain its purpose and usage.
ProfilerRecorderDescription.UnitType public Unity.Profiling.ProfilerMarkerDataUnit UnitType ; Description Gets the data unit type of the Profiler metric. Use to determine the unit type of the metric, for example, nanoseconds, bytes or count.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26c62550c39a
unity_docs
input
What is `tvOS.Remote.reportAbsoluteDpadValues` in Unity? Explain its purpose and usage.
Remote.reportAbsoluteDpadValues public static bool reportAbsoluteDpadValues ; Description Configures how touches are mapped to analog joystick axes in relative or absolute values. When set to true, touching the far right of the remote touch area will return +1 on the horizontal axis and touching the far left w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8e5cde6f992
unity_docs
math
What is `CullingGroup.SetBoundingSphereCount` in Unity? Explain its purpose and usage.
CullingGroup.SetBoundingSphereCount Declaration public void SetBoundingSphereCount (int count ); Parameters Parameter Description count The number of bounding spheres being used. Description Sets the number of bounding spheres in the bounding spheres array that are actually being used. For performance rea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55be37dad6cb
unity_docs
rendering
What is `SystemInfo.supportsSetConstantBuffer` in Unity? Explain its purpose and usage.
SystemInfo.supportsSetConstantBuffer public static bool supportsSetConstantBuffer ; Description Does the current renderer support binding constant buffers directly? (Read Only) Methods such as Shader.SetConstantBuffer and Material.SetConstantBuffer allow overriding all shader parameters that reside in a given...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e68aaa7addc
unity_docs
scripting
What is `UIElements.CustomBinding.Update` in Unity? Explain its purpose and usage.
CustomBinding.Update(BindingContext) Parameters Parameter Description context Context object containing the necessary information to resolve a binding. Returns void A BindingResult indicating if the binding update succeeded or not. Description Called when the binding system updates the binding.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6ba81baca446
unity_docs
rendering
Explain 'Differences between linear and gamma color space' in Unity.
When using linear rendering, input values to the lighting equations are different to those in gamma space. This means differing results depending on the color space. For example, light striking surfaces has differing response curves, and Image Effects behave differently. ## Light fall-off The fall-off from distance a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8d0cbd0b0b3
unity_docs
rendering
What is `Rendering.CullingOptions.NeedsLighting` in Unity? Explain its purpose and usage.
CullingOptions.NeedsLighting Description When this flag is set, Unity culls Lights as part of the culling operation. Default value: set. Additional resources: ScriptableCullingParameters.cullingOptions , ScriptableRenderContext.Cull , CullingResults .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5658772f5c19
unity_docs
scripting
What is `AI.NavMeshBuildSettings.agentTypeID` in Unity? Explain its purpose and usage.
NavMeshBuildSettings.agentTypeID public int agentTypeID ; Description The agent type ID the NavMesh will be baked for. Each NavMeshAgent or NavMeshQueryFilter can only use a NavMesh which is built for its agent type; it is the ID that is matched.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_842c0dc8c2df
unity_docs
editor
What is `BuildPipeline.BuildCanBeAppended` in Unity? Explain its purpose and usage.
BuildPipeline.BuildCanBeAppended Declaration public static CanAppendBuild BuildCanBeAppended ( BuildTarget target , string location ); Parameters Parameter Description target The BuildTarget to build. location The path where Unity builds the application. Returns CanAppendBuild Returns a UnityEdit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38fc7a55c875
unity_docs
scripting
What is `Color32.ctor` in Unity? Explain its purpose and usage.
Color32 Constructor Declaration public Color32 (byte r , byte g , byte b , byte a ); Description Constructs a new Color32 with given r, g, b, a components. ```csharp using UnityEngine;public class Example : MonoBehaviour { Color32 color = new Color32(64, 128, 192, 255); } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7db4359d7309
unity_docs
physics
What are the parameters of `AI.NavMeshEditorHelpers.CollectSourcesInStage` in Unity?
Description Collects renderers or physics colliders, and terrains within a volume. Declaration public static void CollectSourcesInStage ( Bounds includedWorldBounds , int includedLayerMask , AI.NavMeshCollectGeometry geometry , int defaultArea , bool generateLinksByDefault , List<NavMeshBuildMarkup> markups , bool incl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46c77240dec5
unity_docs
scripting
What is `Animations.GenericBindingUtility.CreateGenericBinding` in Unity? Explain its purpose and usage.
GenericBindingUtility.CreateGenericBinding Declaration public static bool CreateGenericBinding ( Object targetObject , string property , GameObject root , bool isObjectReference , out Animations.GenericBinding genericBinding ); Parameters Parameter Description targetObject The target GameObject to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e3d8ed6aa5b
unity_docs
editor
What is `EditorApplication.hierarchyChanged` in Unity? Explain its purpose and usage.
EditorApplication.hierarchyChanged Description Event that is raised when an object or group of objects in the hierarchy changes. Actions that trigger this event include creating, renaming, reparenting, or destroying objects in the current hierarchy, as well as loading, unloading, renaming, or reordering loaded Scen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ee31c9b8d55
unity_docs
rendering
What is `TextureFormat.DXT5Crunched` in Unity? Explain its purpose and usage.
TextureFormat.DXT5Crunched Description Compressed color with alpha channel texture format with Crunch compression for smaller storage sizes. The DXT5Crunched format is similar to the DXT5 format but with additional JPEG-like lossy compression for storage size reduction. Textures are transcoded into the DXT5 forma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7487e8e4df3
unity_docs
scripting
What is `HandleUtility.PickRectObjects` in Unity? Explain its purpose and usage.
HandleUtility.PickRectObjects Declaration public static GameObject[] PickRectObjects ( Rect rect ); Parameters Parameter Description rect A screen rectangle specified with pixel coordinates. Description Pick GameObjects that lie within a specified screen rectangle. This is useful for implementing multi-s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_78c6fc86121a
unity_docs
input
Explain 'Manipulators' in Unity.
To separate your event logic from your UI code, use a manipulator to handle events. Manipulators are state machines that handle user interaction with UI elements. They store, register, and unregister event callbacks. A manipulator streamlines setting up that user interaction, so you don’t have to handle each callback o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_363606abdfb9
github
scripting
Write a Unity C# UI script for Loop Count Presenter
```csharp using UnityEngine; using UnityEngine.UI; namespace UnityPlayerLooperSamples { public class LoopCountPresenter : MonoBehaviour { [SerializeField] Text _countViewA; [SerializeField] Text _countViewB; private LoopCounterA _counterA; private LoopCounterB _counterB; ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_104de2c7bdb1
unity_docs
physics
Explain 'Rigidbody physics' in Unity.
In physics simulation, rigid bodies enable physics-based behaviour such as movement, gravity, and collision . In Unity, you can configure rigid bodies with the Rigidbody class, or the corresponding Rigidbody component. Topic Description Introduction to Rigidbody physics Overview of the concepts and fundamental behaviou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f60de1fbb09
unity_docs
physics
What is `CompositeCollider2D.GenerateGeometry` in Unity? Explain its purpose and usage.
CompositeCollider2D.GenerateGeometry Declaration public void GenerateGeometry (); Description Regenerates the Composite Collider geometry. Call this function when you use CompositeCollider2D.GenerationType.Manual .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_48832d76d2eb
unity_docs
scripting
In Unity's 'Preserving code using annotations', what is 'Annotate roots using the Preserve attribute' and how does it work?
Use the [Preserve] attribute to individually exclude specific sections of your code from the Unity linker’s static analysis. To annotate a piece of code with this attribute, add [Preserve] immediately before the first part of the code you want to preserve. The following list describes what entities the Unity linker pre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9130695687b4
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.right`.
) of the transform in world space. Unlike Vector3.right , Transform.right moves the GameObject while also considering its rotation. When a GameObject is rotated, the red arrow representing the X axis of the GameObject also changes direction. Transform.right moves the GameObject in the red arrow’s axis (X). For mov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1e3e7ae00019_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The View handles user interface and user input Signature: ```csharp public class UIView: MonoBehaviour, IView ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_3afcd5ed63cd
unity_docs
scripting
What is `Experimental.ArtifactKey.isValid` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ArtifactKey.isValid public bool isValid ; Description Returns true is the hash value is valid. (Read Only) An ArtifactKey without a valid GUID is considered invalid.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ae2dac75988
unity_docs
physics
What is `CapsulecastCommand.ctor` in Unity? Explain its purpose and usage.
CapsulecastCommand Constructor Declaration public CapsulecastCommand ( Vector3 p1 , Vector3 p2 , float radius , Vector3 direction , QueryParameters queryParameters , float distance ); Parameters Parameter Description p1 The center of the sphere at the start of the capsule. p2 The center of th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2181a7ec4ee
unity_docs
scripting
What is `Unity.Android.Gradle.Packaging` in Unity? Explain its purpose and usage.
Packaging class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the packaging element in a gradle file. For more information about the file, see Android's documentation: Packaging Properties Property Description JniLibs Packaging options for native...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3894bc6671ff
unity_docs
scripting
What is `Behaviour` in Unity? Explain its purpose and usage.
Behaviour class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.CoreModule Description Behaviours are Components that can be enabled or disabled. Additional resources: MonoBehaviour and Component . Properties Property Description enabled Enabled Behaviours are Updated, disabled ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a1da34bce6b
unity_docs
scripting
What is `PlayerSettings.iOS.locationUsageDescription` in Unity? Explain its purpose and usage.
PlayerSettings.iOS.locationUsageDescription public static string locationUsageDescription ; Description Describes the reason for access to the user's location data. When the OS prompts the user to allow access to the location data, this text is displayed as part of the dialog box.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9e399b86d63
unity_docs
editor
What is `iOS.Xcode.PBXProject.ReadFromString` in Unity? Explain its purpose and usage.
PBXProject.ReadFromString Declaration public void ReadFromString (string src ); Parameters Parameter Description src The project contents. Description Reads the project from the given string. Current contents of the project are discarded. ```csharp using UnityEditor; using System.IO; using UnityEditor.Ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4ab432f485e
unity_docs
scripting
Give me an overview of the `CompressionType` class in Unity.
CompressionType enumeration Description Compression Method for Asset Bundles. When building or recompressing Asset Bundles, these are the available compression methods. Some of these are only available for building and cannot be used for recompression. Additional resources: AssetBundles compression , AssetBund...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4734d279e69
unity_docs
rendering
What is `GUI.Toolbar` in Unity? Explain its purpose and usage.
GUI.Toolbar Declaration public static int Toolbar ( Rect position , int selected , string[] texts ); Declaration public static int Toolbar ( Rect position , int selected , Texture[] images ); Declaration public static int Toolbar ( Rect position , int selected , GUIContent[] contents ); Declar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_28
github
scripting
What does `GetCellIndexWrapAround` do in this Unity script? Explain its purpose and signature.
Gets the index to the GameObjectBrush::ref::BrushCell based on the position of the BrushCell. Wraps each coordinate if it is larger than the size of the GameObjectBrush.X Position of the BrushCell.Y Position of the BrushCell.Z Position of the BrushCell.Index to the BrushCell. Signature: ```csharp public int GetCellInd...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_115342f6b914
unity_docs
editor
In Unity's 'Manage search indices', what is 'Index results' and how does it work?
The following tabs contain information about the index: Assets: Displays the files indexed. Objects: (Prefab and Scene indexes only) Displays the object identifiers. Keywords: Displays the available searchable Properties or filters you can use to further narrow your search results.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5621636d99e4
unity_docs
scripting
What is `Debug.LogWarning` in Unity? Explain its purpose and usage.
Debug.LogWarning Declaration public static void LogWarning (object message ); Declaration public static void LogWarning (object message , Object context ); Parameters Parameter Description message String or object to be converted to string representation for display. context Object to which the me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2fa53a9dd462
unity_docs
ui
In Unity's 'Collect revenue from Asset Store package sales', what is 'Check Asset Store package sales' and how does it work?
The Sales tab displays the sales data on each of your paid packages. It also displays the Gross and Net amounts for the last month. To show the sales figures for different months, select the calendar icon and select a month. Note: Free packages don’t appear in the Sales tab. Column: Description: Package The name of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0301448cc879
unity_docs
scripting
Give me an overview of the `AssetBundleRecompressOperation` class in Unity.
AssetBundleRecompressOperation class in UnityEngine / Inherits from: AsyncOperation / Implemented in: UnityEngine.AssetBundleModule Description Asynchronous AssetBundle recompression from one compression method and level to another. Additional resources: AssetBundle.RecompressAssetBundleAsync , AsyncOpera...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46b26f81ab3d
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.CreateAsset`.
cts to an asset, the order doesn't matter. No object serves as a root asset. Don't use this method to create assets during import, for example from within a ScriptedImporter or Postprocessor. Doing so can prevent the import process from producing consistent (deterministic) results, and reports a warning in the console....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64bca3cc114e
unity_docs
rendering
What is `ModelImporter.useSRGBMaterialColor` in Unity? Explain its purpose and usage.
ModelImporter.useSRGBMaterialColor public bool useSRGBMaterialColor ; Description When disabled, imported material albedo colors are converted to gamma space. This property should be disabled when using linear color space in Player rendering settings. The default value is true.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ad9a755a80a
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddShellScriptBuildPhase` in Unity? Explain its purpose and usage.
PBXProject.AddShellScriptBuildPhase Declaration public string AddShellScriptBuildPhase (string targetGuid , string name , string shellPath , string shellScript ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by TargetGuidByName . name The name of the phas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_88357b5117e5_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Links one event from broadcaster GameObject to one method from listener GameObject's MoonoBehaviour. Signature: ```csharp public class EventLink<T1> : EventLinkBase ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_b024c19c30c1
unity_docs
scripting
What is `Progress.Item.Report` in Unity? Explain its purpose and usage.
Progress.Item.Report Declaration public void Report (float newProgress ); Declaration public void Report (float newProgress , string newDescription ); Declaration public void Report (int newCurrentStep , int newTotalSteps ); Declaration public void Report (int newCurrentStep , int newTotalSteps , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52660c36c7b3
unity_docs
rendering
Give me an overview of the `iOSStatusBarStyle` class in Unity.
iOSStatusBarStyle enumeration Description iOS status bar style. Properties Property Description Default Default. LightContent A light status bar, intended for use on dark backgrounds. DarkContent A dark status bar, intended for use on light backgrounds.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1e5782092e3c
unity_docs
ui
In Unity's 'Customize the GUI for your audio plug-in', what is '2. Add more complex user interaction to your GUI' and how does it work?
The example audio plug-in SDK has a few examples of different ways you can present your parameters, including filter curves. You can use any of these examples in your project. In your custom GUI class, create variables that you want to control via user interaction. For example: ``` private float masterGain; private flo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60b85615d835
unity_docs
scripting
Show me a Unity C# example demonstrating `Unity.Profiling.Memory.MemoryProfiler.CreatingMetadata`.
MemoryProfiler.CreatingMetadata Description A metadata event that collection methods can subscribe to. This event is fired when you capture a memory snapshot. Use it to provide meta data to the snapshot file, for example information related to the context, such as the level, in which it was taken. ```csharp using ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87b53841fb68
unity_docs
animation
What are the parameters of `Animator.SetTrigger` in Unity?
Description Sets the value of the given trigger parameter. This method allows you to set (i.e. activate) an animation trigger, to cause a change in flow in the state machine of an animator controller. The Animation Parameters page describes the purpose of the Animator Controller Parameters window. Trigger is one of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_556bdae5601b
unity_docs
rendering
In Unity's 'Optimize distribution size', what is 'Split the application binary' and how does it work?
You can split your output application to make the initial install size smaller. The device can install a lighter version of your application and then download assets separately. If your output application uses APK format, Unity can split the application into a main APK and an expansion file (OBB). For more information ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf559ffa37c4
unity_docs
scripting
What is `ObjectChangeEventStream.Builder.PushCreateGameObjectHierarchyEvent` in Unity? Explain its purpose and usage.
ObjectChangeEventStream.Builder.PushCreateGameObjectHierarchyEvent Declaration public void PushCreateGameObjectHierarchyEvent (ref CreateGameObjectHierarchyEventArgs data ); Parameters Parameter Description data The event data to add to the stream. Description Adds an CreateGameObjectHierarchyEventArgs ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bae2bb9feb08
unity_docs
ui
What is `UIElements.VisualElement.UxmlSerializedData` in Unity? Explain its purpose and usage.
UxmlSerializedData class in UnityEngine.UIElements / Inherits from: UIElements.UxmlSerializedData / Implemented in: UnityEngine.UIElementsModule Description This is used by the code generator when a custom control is using the UxmlElementAttribute . Static Methods Method Description Register This is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d78ae046124b
unity_docs
scripting
What is `Experimental.GraphView.StackNode.OnStartDragging` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StackNode.OnStartDragging Declaration public void OnStartDragging ( Experimental.GraphView.GraphElement ge ); Parameters Parameter Description ge The GraphElement that is being dragged out of the stack. Description Thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2714a439db84
unity_docs
animation
Explain 'Importing a model with non-humanoid (generic) animations' in Unity.
When Unity imports a Generic model, you must tell it which bone is the Root node . This effectively defines the model’s center of mass . Since there is only one bone to map, Generic setups do not use the Humanoid Avatar window . As a result, preparing to import your non-Humanoid model file into Unity requires fewer ste...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2669be8d10b0
unity_docs
scripting
What is `Experimental.GraphView.Edge.UpdateEdgeControl` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Edge.UpdateEdgeControl Declaration public bool UpdateEdgeControl (); Returns bool False if it failed to update the control. True if it succeeded. Description Update the edge's EdgeControl.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b721d1caed94
unity_docs
editor
What is `Rendering.EditorGraphicsSettings.GetRenderPipelineGlobalSettingsAsset` in Unity? Explain its purpose and usage.
EditorGraphicsSettings.GetRenderPipelineGlobalSettingsAsset Declaration public static Rendering.RenderPipelineGlobalSettings GetRenderPipelineGlobalSettingsAsset (Type renderPipelineType ); Declaration public static Rendering.RenderPipelineGlobalSettings GetRenderPipelineGlobalSettingsAsset (); Parameter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a7a7b896efa8
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetImporters.AssetImportContext.GetReferenceToAssetMainObject`.
, AssetImportContext.DependsOnArtifact or AssetImportContext.DependsOnSourceAsset should be used instead. For example, this method should be used to reference Textures added to or created during an import. Since we are only setting a reference to the texture from the Material, it is not necessary to re-import when ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5b237a74483
unity_docs
scripting
What are the parameters of `Tilemaps.Tilemap.GetCellCenterLocal` in Unity?
Returns Vector3 Returns the center of the cell transformed into local space coordinates. Description Gets the logical center coordinate of a Grid cell in local space. The logical center for a cell of the Tilemap is defined by the Tile Anchor of the Tilemap. In a rectangular grid layout, a call to GridLayout.CellToLocal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_968fd4a0f2db
unity_docs
rendering
In Unity's 'Reflective Bumped Diffuse', what is 'Creating Normal maps' and how does it work?
You can import normal maps created outside of Unity, or you can import a regular grayscale image and convert it to a Normal Map from within Unity. (This page refers to a legacy shader which has been superseded by the Standard Shader , but you can learn more about how to use Normal Maps in the Standard Shader )
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2a3ea4d30da7
unity_docs
scripting
Explain 'macOS requirements and compatibility' in Unity.
Learn about the system requirements and compatibility information for macOS. Note : For information on requirements for all supported platforms, refer to System requirements . ## macOS version support Unity supports macOS Big Sur 11 and later. ## CPU support The following CPU architectures are supported when develo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_48e5eab56442
unity_docs
performance
Show me a Unity code example for 'Custom NativeContainer example'.
The following is a complete example of a custom NativeContainer as an append-only list. It demonstrates basic protection of read and write operations, as well as creating and invalidating aliasing views. For another example, see the NativeContainerAttribute API documentation. ```csharp using System; using System.Runtim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_972315ba1d3c
unity_docs
scripting
Give me an overview of the `ChangeGameObjectStructureHierarchyEventArgs` class in Unity.
ChangeGameObjectStructureHierarchyEventArgs struct in UnityEditor Description A change of this type indicates that the structure of a GameObject has changed and any GameObject in the hierarchy below it might have changed. This happens for example when Undo.RegisterFullObjectHierarchyUndo is used. An event o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74992df63904
unity_docs
physics
What is `Rendering.RenderingThreadingMode.SingleThreaded` in Unity? Explain its purpose and usage.
RenderingThreadingMode.SingleThreaded Description Use SingleThreaded for internal debugging. It uses only a single thread to simulate RenderingThreadingMode.MultiThreaded . In this mode, the main thread processes the application's high-level code through an internal class GfxDeviceClient that issues an intermedi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f504269c5250
unity_docs
rendering
What is `ParticleSystemMeshDistribution.NonUniformRandom` in Unity? Explain its purpose and usage.
ParticleSystemMeshDistribution.NonUniformRandom Description Use per-Mesh weights to make some Meshes appear more often than others. A higher weight value increases the chance of choosing the associated Mesh. To specify the weights, use ParticleSystemRenderer.SetMeshWeightings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8379b090f6ed
unity_docs
editor
What is `iOS.Xcode.PBXProject.RemoveAssetTag` in Unity? Explain its purpose and usage.
PBXProject.RemoveAssetTag Declaration public void RemoveAssetTag (string tag ); Parameters Parameter Description tag The name of the asset tag. Description Removes an asset tag. Removes the given asset tag from the list of configured asset tags for all files on all targets, the list of asset tags configur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76c6fb55c015
unity_docs
animation
What is `Animations.AnimatorControllerPlayable.GetInteger` in Unity? Explain its purpose and usage.
AnimatorControllerPlayable.GetInteger Declaration public int GetInteger (string name ); Declaration public int GetInteger (int id ); Parameters Parameter Description name The parameter name. id The parameter ID. Returns int The value of the parameter. Description Returns the value of the given...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4dd52a941be4
unity_docs
xr
What is `Camera.stereoSeparation` in Unity? Explain its purpose and usage.
Camera.stereoSeparation public float stereoSeparation ; Description 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.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f9c64ec697f0
unity_docs
rendering
Explain 'Custom Data module reference' in Unity.
View and edit the settings you can use to define custom data formats for particles . Use the Custom Data module to define two additional channels ( Custom1 and Custom2 ) of data in the Unity Editor for each particle. You can use custom data to specify additional particle properties to control gameplay effects (for exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f36f7816e9fe
unity_docs
scripting
What is `ModelImporter.extraExposedTransformPaths` in Unity? Explain its purpose and usage.
ModelImporter.extraExposedTransformPaths public string[] extraExposedTransformPaths ; Description Animation optimization setting. Specify the paths of the Transforms which are not supposed to be optimized out when optimizeGameObjects is enabled.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b3eb92c3d3d
unity_docs
ui
What is `Input.GetKeyUp` in Unity? Explain its purpose and usage.
Input.GetKeyUp Declaration public static bool GetKeyUp (string name ); Description Returns true during the frame the user releases the key identified by name . Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_84fb37c95df4_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The mode to use for the sample processor. Signature: ```csharp public enum ProcessorExampleMode ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_2dac10acdd4d
unity_docs
editor
What is `PlayerSettings.GetTemplateCustomValue` in Unity? Explain its purpose and usage.
PlayerSettings.GetTemplateCustomValue Declaration public static string GetTemplateCustomValue (string name ); Parameters Parameter Description name Name of the variable. Returns string The current value of the custom template variable. Description Returns a value of a custom template variable. Duri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab840cc91566
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.GetComponent`.
to. In this instance, you're actually calling Component.GetComponent because the script itself is a type of component, but the result is the same as if you'd referenced the GameObject itself. For example: ComponentType myComponent = GetComponent<ComponentType>() The following example gets a reference to a hinge joint...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1338ca65efdf
unity_docs
scripting
In Unity's 'VisualElement', what is 'Create a VisualElement' and how does it work?
You can create a VisualElement with UI Builder, UXML, or C#. The following C# example creates a VisualElement with a label and a text field: ``` var myElement = new VisualElement(); myElement.Add(new Label("Hello World")); myElement.Add(new TextField()); myElement.style.backgroundColor = Color.blue; myElement.style.wid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1187e3d0067f
unity_docs
scripting
What is `Progress.GetProgressById` in Unity? Explain its purpose and usage.
Progress.GetProgressById Declaration public static Progress.Item GetProgressById (int id ); Parameters Parameter Description id The progress indicator's unique ID. Returns Item The progress indicator's data structure. Description Gets information about a progress indicator.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_099b5839c677
unity_docs
physics
Show me a Unity C# example demonstrating `ShaderKeywordFilter.SelectIfNotAttribute`.
SelectIfNotAttribute class in UnityEditor.ShaderKeywordFilter / Inherits from: ShaderKeywordFilter.FilterAttribute Description Include only the specified shader keywords in the build if the data field doesn't match the condition. If the data field under SelectIf doesn't match the value of condition , Unity i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ed532f0fb84
unity_docs
scripting
Show me a Unity C# example demonstrating `Font.material`.
Font.material public Material material ; Description The material used for the font display. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Swap 3D Text font color each second // Add this script to a text mesh object bool flag = false; float rate = 1f; TextMesh t; void Update() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5bda61571614
unity_docs
physics
What is `ShortcutManagement.ShortcutAttribute` in Unity? Explain its purpose and usage.
ShortcutAttribute class in UnityEditor.ShortcutManagement / Inherits from: ShortcutManagement.ShortcutBaseAttribute Description Registers a static method as the action for an action shortcut. An action shortcut triggers when the binding for the shortcut is pressed down. The method that this attribute is placed ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f74554ca5051
unity_docs
scripting
What is `UIElements.BindingContext` in Unity? Explain its purpose and usage.
BindingContext struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Context object containing the necessary information to resolve a binding. Properties Property Description bindingId The binding ID of the element to bind. dataSource The data source that was r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_98c122415d10
unity_docs
rendering
In Unity's 'Self-Illuminated Normal mapped Diffuse', what is 'Self-Illuminated Properties' and how does it work?
Note. Unity 5 introduced the Standard Shader which replaces this shader. This shader allows you to define bright and dark parts of the object. The alpha channel of a secondary texture will define areas of the object that “emit” light by themselves, even when no light is shining on it. In the alpha channel, black is zer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0914fedf2fe
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObjectUtility.DuplicateGameObjects`.
rent. If there are any children or components that belong to the original GameObject, the duplicate will have them as well. If a parent and a child are both added to the input array, only the parent will be duplicated and returned (similar to the way Ctrl + D works in the editor). For duplicating a single GameObject us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd1c55f43443
unity_docs
math
What is `TestTools.Coverage.GetSequencePointsFor` in Unity? Explain its purpose and usage.
Coverage.GetSequencePointsFor Declaration public static CoveredSequencePoint[] GetSequencePointsFor (MethodBase method ); Parameters Parameter Description method The method to get the sequence points for. Returns CoveredSequencePoint[] Array of sequence points. Description Returns the coverage sequen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d8f309b268b0
unity_docs
scripting
Explain 'Best practices for managing elements' in Unity.
This page describes the best practices for managing elements in the visual tree . ## Pool recurring elements Elements pooling is to keep hold of elements that you might recreate later on, rather than creating elements with new() every time and letting go of them. It’s important to be fully in control of all elements ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_835917c50392
unity_docs
ui
In Unity's 'Test UI', what is 'Test UI in Preview mode' and how does it work?
To test your UI inside the UI Builder, directly inside the Canvas , you can enable Preview mode, found in the Viewport ’s toolbar . Preview mode removes the UI Builder-specific picking overlay and handles from the Canvas . You can tell if you have Preview mode enabled by looking for an orange border around the entire V...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_562c554768c5
unity_docs
editor
Show me a Unity C# example demonstrating `SettingsProvider.GetSearchKeywordsFromGUIContentProperties`.
SettingsProvider.GetSearchKeywordsFromGUIContentProperties Declaration public static IEnumerable<string> GetSearchKeywordsFromGUIContentProperties (); Returns IEnumerable<string> Returns the list of keywords extracted from the static GUIContent. Description Extract search keywords from all public static me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d7d25ca52012
unity_docs
rendering
In Unity's 'Upgrade to Unity 6.0', what is 'Gaussian Filter Radius properties from LightingSettings are now floating point values' and how does it work?
The Progressive Lightmapper includes a Gaussian option among its Advanced filtering options ( Lighting Window > Lightmapping Settings > Filtering > Direct Filter > Gaussian ). The Radius control for Gaussian filtering now supports decimal increments, such as 0.5. Previously, this control only supported integer steps (1...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a63ddb2dd191
unity_docs
scripting
What is `Build.Reporting.ScenesUsingAsset.scenePaths` in Unity? Explain its purpose and usage.
ScenesUsingAsset.scenePaths public string[] scenePaths ; Description The list of scenes in the build referring to the asset, identified by a string containing the scene index in the BuildPlayerOptions.scenes list, as well as the scene path.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab09a1c2af30
unity_docs
rendering
What are the parameters of `Graphics.DrawMesh` in Unity?
Description Draw a mesh. This function is now obsolete. Use Graphics.RenderMesh instead. DrawMesh draws a mesh for one frame. The mesh will be affected by the lights, can cast and receive shadows and be affected by Projectors - just like it was part of some game object. It can be drawn for all cameras or just for some ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.