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_900d46f06081
unity_docs
rendering
What is `TextureResizeAlgorithm` in Unity? Explain its purpose and usage.
TextureResizeAlgorithm enumeration Description For Texture to be scaled down choose resize algorithm. ( Applyed only when Texture dimension is bigger than Max Size ). Properties Property Description Mitchell Default high quality resize algorithm. Bilinear Might provide better result than Mitchell for some nois...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b6b0f7ee2e5c
unity_docs
editor
In Unity's 'Access package assets using scripts', what is 'Resolving absolute paths' and how does it work?
To get the absolute path of a packaged asset, use the Path.GetFullPath() method, which requires the using System.IO directive. For example: ``` using System.IO; // ... string absolute = Path.GetFullPath("Packages/com.unity.images-library/Example/Images/image.png"); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4ed8c2b3366
unity_docs
scripting
What is `ContextMenuItemAttribute.ctor` in Unity? Explain its purpose and usage.
ContextMenuItemAttribute Constructor Declaration public ContextMenuItemAttribute (string name , string function ); Parameters Parameter Description name The name of the context menu item. function The name of the function that should be called. Description Use this attribute to add a context menu to a f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ef54dddfdb8
unity_docs
performance
What are the parameters of `Profiling.Profiler.GetTotalFragmentationInfo` in Unity?
Returns long Returns the total number of free blocks in the dynamic heap. Description Returns heap memory fragmentation information. Heap fragmentation is a measure of how much space is potentially unusable in the dynamic heap. If your application has too much heap fragmentation it can lead to memory allocation failure...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_300b6198f1c3
unity_docs
ui
Show me a Unity code example for 'Slider'.
ify the value directly. Note : To align an element with other fields in an Inspector window, simply apply the.unity-base-field__aligned USS class to it. For more information, refer to BaseField . ## Create a Slider You can create a Slider with UI Builder, UXML, or C#. The following C# example creates a Slider with a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5b59cf3722a
unity_docs
rendering
What is `Experimental.Rendering.GraphicsStateCollection.variantCount` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsStateCollection.variantCount public int variantCount ; Description The number of shader variants contained in this collection. Each shader variant may have associated graphics states that are used when prewarming to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b9ffd8dcee5
unity_docs
editor
What is `Rendering.EditorGraphicsSettings.PopulateRenderPipelineGraphicsSettings` in Unity? Explain its purpose and usage.
EditorGraphicsSettings.PopulateRenderPipelineGraphicsSettings Declaration public static void PopulateRenderPipelineGraphicsSettings ( Rendering.RenderPipelineGlobalSettings settings ); Parameters Parameter Description settings A valid asset with SupportedOnRenderPipelineAttribute targetting a valid Rende...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fdc18c54e16c
unity_docs
rendering
In Unity's 'Introduction to surface shaders in the Built-In Render Pipeline', what is 'How it works' and how does it work?
You define a “surface function” that takes any UVs or data you need as input, and fills in output structure SurfaceOutput . SurfaceOutput basically describes properties of the surface (its albedo color, normal, emission, specularity etc.). You write this code in HLSL. Surface Shader compiler then figures out what input...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ca6a51fe8d72
github
scripting
Write a Unity C# script called Example System
```csharp using starikcetin.Joy.Core; using UnityEngine; namespace starikcetin.Joy.Example { public class ExampleSystem : ISystem { public Filter[] Filters { get; } = { FooFilter, BarFilter }; private static Filter FooFilter { get; } = new Filter() ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_f0fb4b0079bf
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerSummaryMetrics.LongestReadAssetType` in Unity? Explain its purpose and usage.
AsyncReadManagerSummaryMetrics.LongestReadAssetType public ulong LongestReadAssetType ; Description The asset type ID for the longest read included in the summary calculation. Note: A value of zero denotes a read where the asset type ID was never set.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_02638580e428
unity_docs
ui
What is `UIElements.VisualElement.TryGetDataSourceContext` in Unity? Explain its purpose and usage.
VisualElement.TryGetDataSourceContext Declaration public bool TryGetDataSourceContext ( UIElements.BindingId bindingId , out UIElements.DataSourceContext context ); Parameters Parameter Description bindingId The binding ID to query. context The resulting context object. Returns bool Returns true ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd00aeb97231
unity_docs
rendering
What is `TextureImporter.mipMapsPreserveCoverage` in Unity? Explain its purpose and usage.
TextureImporter.mipMapsPreserveCoverage public bool mipMapsPreserveCoverage ; Description Enables or disables coverage-preserving alpha mipmapping. Enable this to rescale the alpha values of computed mipmaps so coverage is preserved. This means a higher percentage of pixels passes the alpha test and lower mipm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1fc0a19f6e48
unity_docs
scripting
Show me a Unity code example for 'Using a custom update manager'.
tion to perform, which reduces the number of functions that must be called each frame. ## When to use a custom update manager A custom update manager can be beneficial when the number of MonoBehaviour instances with per-frame update callbacks reaches the hundreds or thousands. You can improve performance significantl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a69dc3bc6af7
unity_docs
rendering
Give me an overview of the `GraphicsBuffer` class in Unity.
GraphicsBuffer class in UnityEngine / Implemented in: UnityEngine.CoreModule Description GPU graphics data buffer, for working with geometry or compute shader data. ComputeShader programs often need to read or write arbitrary data from or to memory buffers, and some rendering algorithms need a lower level acce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5eac5bd10dd2
unity_docs
performance
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerCategoryDescription` in Unity? Explain its purpose and usage.
ProfilerCategoryDescription struct in Unity.Profiling.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Provides information about Profiler category. Properties Property Description Color Profiler category color. Flags Profiler category flags. Id Profiler category identifier. Name Gets ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f83674afa2fd
unity_docs
rendering
What is `Rendering.LightEvent.AfterScreenspaceMask` in Unity? Explain its purpose and usage.
LightEvent.AfterScreenspaceMask Description After directional light screenspace shadow mask is computed. Directional lights when using non-mobile shadows "gather" shadowmap into a screenspace buffer and do PCF filtering during this step. Later on actual object rendering just samples this screenspace buffer. This li...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_802c1da32212
unity_docs
input
Show me a Unity code example for 'The SearchProvider class'.
The SearchProvider class executes searches for specific types of items, and manages thumbnails, descriptions, and sub-filters. It has the following basic API: ```csharp public class SearchProvider { public SearchProvider(string id, string displayName = null); // Creates an Item bound to this provider. public Search...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bbce49df7fd9
unity_docs
editor
Show me a Unity C# example demonstrating `EditorUtility.InstanceIDToObject`.
EditorUtility.InstanceIDToObject Declaration public static Object InstanceIDToObject (int instanceID ); Description Translates an instance ID to a reference to an object. If the object is not loaded from disk, loads it from disk. Editor Window to enter the instance ID and print the name of the object. ```csh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83fac406be2f
unity_docs
rendering
What is `ParticleSystem.AllocateAxisOfRotationAttribute` in Unity? Explain its purpose and usage.
ParticleSystem.AllocateAxisOfRotationAttribute Declaration public void AllocateAxisOfRotationAttribute (); Description Ensures that the axisOfRotations particle attribute array is allocated. This is important if you want to use this attribute in a job, such as IJobParticleSystem .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7dc1844301b
unity_docs
xr
What is `Font.CreateDynamicFontFromOSFont` in Unity? Explain its purpose and usage.
Font.CreateDynamicFontFromOSFont Declaration public static Font CreateDynamicFontFromOSFont (string fontname , int size ); Declaration public static Font CreateDynamicFontFromOSFont (string[] fontnames , int size ); Parameters Parameter Description fontname The name of the OS font to use for this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3fa7334a4288
github
scripting
Write a Unity C# XR/VR script for Injector
```csharp /* The MIT License (MIT) Copyright (c) 2015 Sergey Sychov 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, mod...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_92969df9077f
unity_docs
audio
In Unity's 'Edit Animation curves', what is 'Add and Move Keys on a Curve' and how does it work?
You can add a key a curve by double-clicking on the curve at the point where you want to add the key . You can also right-click on a curve and selecting Add Key from the context menu. Once added, a key can be moved with the mouse: Click a key to select it. Drag the selected key with the mouse. To snap the key to the gr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e718cd96aee7
unity_docs
rendering
Explain 'Texture Sheet Animation module reference' in Unity.
A particle ’s graphic need not be a still image. This module lets you treat the Texture as a grid of separate sub-images that can be played back as frames of animation. ## Grid mode properties Property Function Mode popup Select Grid mode. Tiles The number of tiles the Texture is divided into in the X (horizontal) an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a4407b2b641
unity_docs
editor
What is `PlayerSettings.Android.showActivityIndicatorOnLoading` in Unity? Explain its purpose and usage.
PlayerSettings.Android.showActivityIndicatorOnLoading public static AndroidShowActivityIndicatorOnLoading showActivityIndicatorOnLoading ; Description Application should show ActivityIndicator when loading. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Build;public class ShowActivityIndic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da516741a860
unity_docs
editor
What is `RenderParams.overrideSceneCullingMask` in Unity? Explain its purpose and usage.
RenderParams.overrideSceneCullingMask public bool overrideSceneCullingMask ; Description Uses the RenderParams.sceneCullingMask property to specify a custom SceneCullingMasks . This property is only available in the Editor, you can still access it in a Player but it'll be ignored.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_053baef8840e
github
scripting
Write a Unity Editor script for Hand Pose Editor
```csharp /* * Copyright (c) Meta Platforms, Inc. and affiliates. * All rights reserved. * * Licensed under the Oculus SDK License Agreement (the "License"); * you may not use the Oculus SDK except in compliance with the License, * which is provided at the time of installation or download, or which * otherwise a...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_0ef717c683d7
unity_docs
editor
Explain 'Call native plug-ins for iOS' in Unity.
Your app can only call iOS native plug-ins when deployed on an actual device. Wrap all native code methods with an additional C# code layer to only call native methods when the app is running on a device. Store this C# file in your Project’s Assets folder. This C# layer can use platform conditional compilation or check...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ce978b128f3f
unity_docs
physics
What is `PhysicsScene.InterpolateBodies` in Unity? Explain its purpose and usage.
PhysicsScene.InterpolateBodies Declaration public void InterpolateBodies (); Description Interpolates Rigidbodies in this PhysicsScene . Interpolates all Rigidbodies in this PhysicsScene with Rigidbody.interpolation set to either RigidbodyInterpolation.Interpolate or RigidbodyInterpolation.Extrapolate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22ed4dfbd869
unity_docs
scripting
What is `Awaitable.FromAsyncOperation` in Unity? Explain its purpose and usage.
Awaitable.FromAsyncOperation Declaration public static Awaitable FromAsyncOperation ( AsyncOperation op , CancellationToken cancellationToken ); Parameters Parameter Description op Async operation object. cancellationToken Optional cancellation token. Description Creates an Awaitable from an existing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_331f8776da12
unity_docs
physics
What is `CapsuleCollider2D.size` in Unity? Explain its purpose and usage.
CapsuleCollider2D.size public Vector2 size ; Description The width and height of the capsule area. The capsule will alter its geometry to fit into this area as best it can. A capsule will automatically adjust the radius of the capsule ends as well as the capsule sides to fit this area. When the capsule area i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6177ec3d7c32
unity_docs
rendering
What are the parameters of `Font.RequestCharactersInTexture` in Unity?
Description Request characters to be added to the font texture (dynamic fonts only). Note: You should only ever need to use this when you want to implement your own text rendering. Call this function to request Unity to make sure all the characters in the string characters are available in the font's font texture (and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f3ba17b46385
unity_docs
scripting
What is `Rendering.CommandBuffer.SetViewport` in Unity? Explain its purpose and usage.
CommandBuffer.SetViewport Declaration public void SetViewport ( Rect pixelRect ); Parameters Parameter Description pixelRect Viewport rectangle in pixel coordinates. Description Add a command to set the rendering viewport. By default after render target changes the viewport is set to encompass the whole ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f92f3b564c8
unity_docs
audio
What is `Audio.AudioMixer.FindSnapshot` in Unity? Explain its purpose and usage.
AudioMixer.FindSnapshot Declaration public Audio.AudioMixerSnapshot FindSnapshot (string name ); Parameters Parameter Description name Name of snapshot object to be returned. Returns AudioMixerSnapshot The snapshot identified by the name. Description The name must be an exact match.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_944ed52322ff
unity_docs
editor
What is `UIElements.InspectorElement.ctor` in Unity? Explain its purpose and usage.
InspectorElement Constructor Declaration public InspectorElement (); Description Initialized a new instance of InspectorElement . Declaration public InspectorElement ( Object obj ); Parameters Parameter Description obj The object to bind to. Description Initialized a new instance of InspectorE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f75eabdbbbae
unity_docs
physics
What is `XR.InputDevice.TryGetFeatureUsages` in Unity? Explain its purpose and usage.
InputDevice.TryGetFeatureUsages Declaration public bool TryGetFeatureUsages (List<InputFeatureUsage> featureUsages ); Parameters Parameter Description featureUsages A List of InputFeatureUsage structures to receive the available features on this device. Returns bool true if device can be queried; other...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1241bf8fc3c5
unity_docs
ui
In Unity's 'Toggle', what is 'Style a Toggle' and how does it work?
By default, a Toggle control appears as a checkbox. You can apply styles to make it look like a typical toggle switch. To style the checkbox of a toggle, use the.unity-toggle__input and.unity-toggle__checkmark style properties. For example, if you have applied a class named className to the Toggle. The following USS ch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa8856286b54
unity_docs
scripting
Show me a Unity C# example demonstrating `AI.NavMeshEditorHelpers.DrawBuildDebug`.
All); Parameters Parameter Description navMeshData NavMesh object for which debug data has been deliberately collected during the build process. flags Bitmask that designates the types of data to show at one time. Description Displays in the Editor the precise intermediate data used during the build process ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4997717a861b
unity_docs
scripting
What is `Input.gyro` in Unity? Explain its purpose and usage.
Input.gyro public static Gyroscope gyro ; Description Returns default gyroscope. 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, use the Input System package. To learn more about input, refer to Input . Use t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f8a5cf7816f
unity_docs
rendering
What is `LightEditor.Settings` in Unity? Explain its purpose and usage.
Settings class in UnityEditor Description Contains all drawable elements of the LightEditor . Properties Property Description areaSizeX Exposed SerializedProperty for the inspected Light. areaSizeY Exposed SerializedProperty for the inspected Light. bakedShadowAngleProp Exposed SerializedProperty for the in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_dc36e5cc1fa9
github
scripting
Write a Unity C# ScriptableObject for Editable Entry
```csharp // Copyright (c) Rotorz Limited. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root. using UnityEngine; namespace Rotorz.Games.Collections { /// <summary> /// A class with a <see cref="OrderedDictionary"/> field that can be used to draw /// an 'Add Entr...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_b01cbf1a6790
unity_docs
physics
Explain 'Sprites' in Unity.
Sprites are a type of 2D asset you can use in your Unity project. Use this section to learn how to set up your sprites and manage them with different components. If you’re used to working in 3D, sprites are similar to standard textures but there are special techniques to combine and manage sprite textures for efficienc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d5ebc9fe7f3
unity_docs
physics
What is `SerializedObject.SetIsDifferentCacheDirty` in Unity? Explain its purpose and usage.
SerializedObject.SetIsDifferentCacheDirty Declaration public void SetIsDifferentCacheDirty (); Description Update hasMultipleDifferentValues cache on the next /Update()/ call. Normally, you should not need to call this, as the SerializedProperty setters take care of this. However, when you change an object by...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9f5fe4703d0
unity_docs
rendering
What is `TrailRenderer.minVertexDistance` in Unity? Explain its purpose and usage.
TrailRenderer.minVertexDistance public float minVertexDistance ; Description Set the minimum distance the trail can travel before a new vertex is added to it. Smaller values with give smoother trails, consisting of more vertices, but costing more performance. ```csharp using UnityEngine; using System.Collecti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1343e2fb669e
unity_docs
editor
In Unity's 'ScriptableObject', what is 'Create a ScriptableObject' and how does it work?
To create a new ScriptableObject script, the quickest way is to use the predefined ScriptableObject script template from the Assets menu in one of the following ways: In the main menu, go to Assets > Create > Scripting > and select ScriptableObject Script . In the Project window toolbar , right-click to open the Projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34d73014387a
unity_docs
rendering
What is `AssetImporters.AssetImportContext.AddObjectToAsset` in Unity? Explain its purpose and usage.
AssetImportContext.AddObjectToAsset Declaration public void AddObjectToAsset (string identifier , Object obj ); Declaration public void AddObjectToAsset (string identifier , Object obj , Texture2D thumbnail ); Parameters Parameter Description identifier A unique identifier associated to this ob...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5b59934c8863
github
scripting
Write a Unity C# MonoBehaviour script called Scene03_Customize Environment
```csharp using RMC.Mini.Features.SceneSystem; using RMC.Mini.Samples.Configurator.Mini; using RMC.Mini.Samples.Configurator.Mini.Feature; using RMC.Mini.Samples.Configurator.Mini.View; using UnityEngine; namespace RMC.Mini.Samples.Configurator.Standard { /// <summary> /// This is the main entry point to one o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21dcae0e614c
unity_docs
rendering
What is `MeshRenderer.additionalVertexStreams` in Unity? Explain its purpose and usage.
MeshRenderer.additionalVertexStreams public Mesh additionalVertexStreams ; Description Vertex attributes in this mesh will override or add attributes of the primary mesh in the MeshRenderer. This can be used for vertex painting tools, etc. This data is serialized. For example, if the primary mesh doesn't co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df0bb47fa9bb
unity_docs
scripting
What is `Search.IQueryEngineFilter.supportedOperators` in Unity? Explain its purpose and usage.
IQueryEngineFilter.supportedOperators public IEnumerable<string> supportedOperators ; Description List of supported operators. This list either contains the supported operators, or it is empty to indicate that all operators are supported. See AddFilter .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe3ef0a2bd3c
unity_docs
rendering
Give me an overview of the `TextureImporterGenerateCubemap` class in Unity.
TextureImporterGenerateCubemap enumeration Description Cubemap generation mode for TextureImporter . Cubemap textures can be generated from 2D texture using one of these modes. Additional resources: TextureImporter.generateCubemap . Properties Property Description Spheremap Generate cubemap from spheremap t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_12c9282e6eed
unity_docs
input
What is `RenderPickingResult.resolver` in Unity? Explain its purpose and usage.
RenderPickingResult.resolver public HandleUtility.ResolvePickingCallback resolver ; Description The callback to invoke to resolve a picking index into a GameObject reference. The callback is invoked only if one of the picking indices rendered ends up being the topmost one under the mouse click position. The c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_13eebe5ebe99
unity_docs
input
What is `UIElements.ManipulatorActivationFilter.Matches` in Unity? Explain its purpose and usage.
ManipulatorActivationFilter.Matches Declaration public bool Matches ( UIElements.IMouseEvent e ); Parameters Parameter Description e The mouse event. Returns bool True if the event matches the requirements. False otherwise. Description Checks whether the current mouse event satisfies the activation...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4820b43f0417
unity_docs
scripting
What is `Animations.BoundProperty.index` in Unity? Explain its purpose and usage.
BoundProperty.index public int index ; Description The index of this BoundProperty to the internal list of bound properties. The bound property index is recycled when a domain reload occurs or when either the GameObject or Component associated with a BoundProperty is destroyed. When the index is recycled, the s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0d351936d75b_doc_4
github
scripting
What does `PauseReplay` do in this Unity script? Explain its purpose and signature.
Updates the control UI when the user pauses playback of a eye gaze log file. Signature: ```csharp public void PauseReplay() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_63d214c2ecf6
unity_docs
rendering
Explain 'Post-processing effect availability reference' in Unity.
This table contains information on which post-processing effects and full-screen effects are available in Unity’s different post-processing solutions, how to find those effects, and what other effects you can use to achieve a similar result. In previous versions of Unity, you applied all post-processing effects and ful...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c7c06722df9
unity_docs
scripting
What is `Animator.SetInteger` in Unity? Explain its purpose and usage.
Animator.SetInteger Declaration public void SetInteger (string name , int value ); Declaration public void SetInteger (int id , int value ); Parameters Parameter Description name The parameter name. id The parameter ID. value The new parameter value. Description Sets the value of the given inte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d45bd11031d3
unity_docs
performance
What is `Rendering.CullingResults.GetReflectionProbeIndexMap` in Unity? Explain its purpose and usage.
CullingResults.GetReflectionProbeIndexMap Declaration public NativeArray<int> GetReflectionProbeIndexMap ( Unity.Collections.Allocator allocator ); Parameters Parameter Description allocator The allocator to use. Returns NativeArray<int> Array of indices that map from VisibleReflectionProbe indices to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2ddb1b79d404
unity_docs
editor
In Unity's 'LiveOps Building Blocks prerequisites', what is 'Set a target environment' and how does it work?
A project that uses Unity Cloud targets an environment in the Cloud project. You can create and delete environments in the Unity Dashboard. To select a target environment, do the following: Link your project to the Unity dashboard. In the Editor, go to Edit > Project Settings. Go to the Services > Environments section....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5a43b34e735
unity_docs
physics
What is `JointSpring` in Unity? Explain its purpose and usage.
JointSpring struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description JointSpring is used add a spring force to HingeJoint and PhysicsMaterial . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { HingeJoint hinge = GetComponent<HingeJoint>(); // Make the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2a8071dfac7f
unity_docs
scripting
What is `Rendering.RenderStateBlock.blendState` in Unity? Explain its purpose and usage.
RenderStateBlock.blendState public Rendering.BlendState blendState ; Description Specifies the new blend state. Unity applies these values to the GPU's render state if RenderStateBlock.mask includes a value of RenderStateMask.Blend . The default value is BlendState.defaultValue .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_277127c6d548
unity_docs
rendering
In Unity's 'Custom Render Texture Inspector window reference', what is 'Custom Texture:' and how does it work?
These properties are exclusive to Custom Render Textures. Custom Texture parameters are separated into three categories: Material : Defines what shader is used to update the texture. Initialization : Controls how the texture is initialized before the shader performs any updates. Update : Controls how the shader updates...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_810440fed4cb
unity_docs
scripting
What is `Animations.ConstraintSource` in Unity? Explain its purpose and usage.
ConstraintSource struct in UnityEngine.Animations / Implemented in: UnityEngine.AnimationModule Description Represents a source for the constraint. Properties Property Description sourceTransform The transform component of the source object. weight The weight of the source in the evaluation of the constrain...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8e0e6f762530_doc_2
github
scripting
What does `CameraInput` do in this Unity script? Explain its purpose and signature.
Create a video recording input from a game camera.Media recorder to receive committed frames.Clock for generating timestamps.Game cameras to record. Signature: ```csharp public CameraInput(IMediaRecorder recorder, IClock clock, params Camera[] cameras) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_967525ca0f9f
unity_docs
rendering
What is `Sprites.Packer.GetTexturesForAtlas` in Unity? Explain its purpose and usage.
Packer.GetTexturesForAtlas Declaration public static Texture2D[] GetTexturesForAtlas (string atlasName ); Parameters Parameter Description atlasName Atlas name. Description Returns all atlas textures generated for the specified atlas.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1129acf6cee
unity_docs
scripting
What is `PluginImporter.SetCompatibleWithAnyPlatform` in Unity? Explain its purpose and usage.
PluginImporter.SetCompatibleWithAnyPlatform Declaration public void SetCompatibleWithAnyPlatform (bool enable ); Parameters Parameter Description enable Determines whether the plugin is compatible with Any Platform . Description Sets compatibility with Any Platform . This does not mean that all platform...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a78cc2eb718
unity_docs
editor
What is `Device.Screen` in Unity? Explain its purpose and usage.
Screen class in UnityEngine.Device / Implemented in: UnityEngine.CoreModule Description Access platform-specific display information. This class has the same functionality as Screen and also mimics platform-specific behavior in the Unity Editor. Use it together with the Device Simulator to test platform-speci...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c126b5ced95d
unity_docs
physics
In Unity's 'Profiler counters reference', what is 'Memory profiler counters' and how does it work?
The following table outlines the available memory profiler counters and availability in release (non-development) players. Tip: You can use the Object.FindObjectsByType method to find objects of specific types, and then pass this information to Profiler.GetRuntimeMemorySizeLong to get their memory amount and then imple...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1651b8e7982
unity_docs
rendering
Show me a Unity C# example demonstrating `TrailRenderer.numCornerVertices`.
TrailRenderer.numCornerVertices public int numCornerVertices ; Description Set this to a value greater than 0, to get rounded corners between each segment of the trail. The value controls how many vertices are added to each joint, where a higher value will give a smoother result. ```csharp using UnityEngine; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d0d642b692d
unity_docs
input
Show me a Unity C# example demonstrating `TouchScreenKeyboardType.Default`.
TouchScreenKeyboardType.Default Description The default keyboard layout of the target platform. An iOS example is shown below: ```csharp using UnityEngine; using UnityEngine.iOS;public class ExampleClass : MonoBehaviour { private TouchScreenKeyboard keyboard; protected void OnGUI() { GUI.skin.button.fontSize = ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f77cce05131
unity_docs
scripting
What are the parameters of `Search.IPropertyDatabaseView.InvalidateMask` in Unity?
Description Invalidate all properties stored from multiple documents that match a document key mask. This operation is slower than the simpler IPropertyDatabaseView.Invalidate since we cannot rely on a binary search to find all keys that match the mask. ``` using (var view = propertyDatabase.GetView()) { // Store p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_51455ffcb9e1
unity_docs
rendering
Explain 'Use the Project Settings window' in Unity.
To open the Project Settings window, go to Edit > Project Settings . The Project Settings window can also display additional categories and settings, based on the packages you install. For more information on package-specific settings, refer to corresponding package documentation. Use the Search box to filter the list ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_117048f8f8d3
unity_docs
scripting
What is `Playables.DirectorUpdateMode.UnscaledGameTime` in Unity? Explain its purpose and usage.
DirectorUpdateMode.UnscaledGameTime Description Update is based on Time.unscaledTime . Use this for graphs that need to be updated even when gameplay is paused. Example: Menus transitions need to be updated even when the game is paused.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_129f22177a2c
unity_docs
scripting
What is `DeviceType.Handheld` in Unity? Explain its purpose and usage.
DeviceType.Handheld Description A handheld device, like a mobile phone, a tablet, or a gaming handheld. ```csharp //Attach this script to a GameObject //This script checks what device type the Application is running on and outputs this to the consoleusing UnityEngine;public class DeviceTypeExample : MonoBehaviour {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd0d83a62610
unity_docs
scripting
Show me a Unity C# example demonstrating `Quaternion.Set`.
Quaternion.Set Declaration public void Set (float newX , float newY , float newZ , float newW ); Description Set x, y, z and w components of an existing Quaternion. ```csharp //Create three Sliders ( Create>UI>Slider) and three Text GameObjects (Create>UI>Text). These are for manipulating the x, y, and z v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dfdf98cbd2d0
unity_docs
scripting
Explain 'Get started with QNX' in Unity.
Learn how to set up a project for QNX development. Topic Description Install the platform package for QNX Install the platform package for QNX on your selected platform. Set up your environment for QNX Set up your environment to develop for QNX. QNX Player settings Reference documentation for QNX Player settings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_107e4b532f8f
unity_docs
scripting
Explain 'Android environment setup' in Unity.
To create a Unity application for Android, you must first set up your Unity project to support Android. A Unity project requires the following dependencies to support Android development: The Android Build Support module. The Android Software Development Kit (SDK) . The Native Development Kit (NDK) . A Java Development...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_68c1b1655524
unity_docs
rendering
Explain 'Global Illumination Profiler module reference' in Unity.
The Global Illumination Profiler module displays statistics about how much CPU time the Enlighten Realtime Global Illumination subsystem uses across all worker threads. To control the number of Enlighten worker threads included, you can pass the Unity Editor a command line argument . To open the Profiler window, go to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e956a4b9bca7
unity_docs
rendering
Explain 'Style UI' in Unity.
You can style your UI with a Unity Style Sheet (USS). USS files are text files inspired by Cascading Style Sheets (CSS) from HTML. USS syntax is the same as CSS syntax, but USS includes overrides and customizations to work better with Unity. Topic Description Introduction to USS Understand the fundamental building bloc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_644f47d0d128
unity_docs
scripting
What is `PackageManager.PackageRegistrationEventArgs.removed` in Unity? Explain its purpose and usage.
PackageRegistrationEventArgs.removed public ReadOnlyCollection<PackageInfo> removed ; Description A collection of PackageInfo entries to remove during the Package Manager registration process.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7375de3ea7fc_doc_5
github
scripting
What does `EmbedPackage` do in this Unity script? Explain its purpose and signature.
Moves the desired package to the Packages folder. (This prevents the package from being read only).Skip checking if the package exists Signature: ```csharp public static void EmbedPackage(string packageName, bool skipCheck, Action<bool> success) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_bfbfac95ed3b
unity_docs
scripting
What is `MonoBehaviour.OnTriggerExit` in Unity? Explain its purpose and usage.
MonoBehaviour.OnTriggerExit(Collider) Parameters Parameter Description other The other collider involved in this collision. Description OnTriggerExit is called when a collider stops touching a trigger. OnTriggerExit is called during whichever iteration of the physics FixedUpdate loop Unity detects that a c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32faad57cfa5
unity_docs
rendering
What is `U2D.SpriteAtlasExtensions.SetPlatformSettings` in Unity? Explain its purpose and usage.
SpriteAtlasExtensions.SetPlatformSettings Declaration public static void SetPlatformSettings ( U2D.SpriteAtlas spriteAtlas , TextureImporterPlatformSettings src ); Description Set the platform specific settings. If overridden, packing will use this setting for the target platform.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ace10bc98c6
unity_docs
physics
What is `ColliderDistance2D` in Unity? Explain its purpose and usage.
ColliderDistance2D struct in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Represents the separation or overlap of two Collider2D . The ColliderDistance2D primarily defines a point on the exterior of each Collider2D along with the distance between those two points. The distance ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bc72384c3506
unity_docs
scripting
What is `IMGUI.Controls.TreeView.cellMargin` in Unity? Explain its purpose and usage.
TreeView.cellMargin protected float cellMargin ; Description When using a MultiColumnHeader this value adjusts the cell rects provided for all columns except the tree foldout column. This value is used for all cell margins except the column with the tree view foldouts since that column uses baseIndent and ass...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f9749752b3c1
unity_docs
xr
In Unity's 'Store credentials for automatic proxy configuration (Windows)', what is 'Procedure' and how does it work?
Follow these steps to store your proxy credentials in Windows, replacing the proxy address of webproxy.mycompany.com and the user name of proxyuser . To open Credential Manager, type credential manager in the search box on the taskbar to find Credential Manager Control panel . Open Credential Manager . Select Windows C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_620fb120bde7
unity_docs
scripting
What is `Collision2D.transform` in Unity? Explain its purpose and usage.
Collision2D.transform public Transform transform ; Description The Transform of the incoming object involved in the collision. Additional resources: Transform class. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void OnCollisionEnter2D(Collision2D collis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4d34e3ceeced
unity_docs
scripting
In Unity's 'Create a car with Wheel colliders', what is 'Add the Wheel colliders' and how does it work?
To add Wheel colliders to the wheel models, you need to create four new separate GameObjects at the same position as the wheel models (but not as child GameObjects of the wheels). A fast way to set this up at approximately the same position is to duplicate the wheel GameObjects and then configure the new GameObject: Se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_965b303af793
unity_docs
rendering
What is `Rendering.AlbedoSwatchInfo` in Unity? Explain its purpose and usage.
AlbedoSwatchInfo struct in UnityEditor.Rendering Description Contains the custom albedo swatch data. The custom AlbedoSwatchInfo struct contains custom data that can be used to specify an albedo value to validate the albedo values in the Scene. For details on how to use the data, see EditorGraphicsSettings.albed...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1410fc183fc
unity_docs
math
What is `Rendering.VertexAttribute.Position` in Unity? Explain its purpose and usage.
VertexAttribute.Position Description Vertex position. Positions usually use Vector3 format. Vector3 uses three 32-bit floats; 12 bytes in total. This vertex attribute maps to POSITION Semantic in the HLSL shading language. Additional resources: Mesh.HasVertexAttribute , Mesh.SetVertices .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3071cc649a49
unity_docs
physics
Explain 'Runtime data binding' in Unity.
Runtime data binding binds the properties of any plain C# object to the properties of a UI control. You can use this type of data binding in both the runtime and Editor UI. However, for serialized data in the Editor UI, use the SerializedObject data binding because it provides better support for Unity’s serialization s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b73952fb0990
unity_docs
scripting
What is `Scripting.PreserveAttribute` in Unity? Explain its purpose and usage.
PreserveAttribute class in UnityEngine.Scripting / Implemented in: UnityEngine.CoreModule Description PreserveAttribute prevents byte code stripping from removing a class, method, field, or property. When you create a build, Unity will try to strip unused code from your project. This is great to get small build...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cbbb83c9f088
unity_docs
editor
Explain 'IMGUI (Immediate Mode GUI)' in Unity.
IMGUI (Immediate Mode GUI) is an entirely separate feature to Unity’s main GameObject-based UI System. IMGUI is a code-driven GUI system, and is mainly intended as a tool for programmers. It is driven by calls to the OnGUI function on any script which implements it. For example, this code: ```csharp void OnGUI() { if ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d4c63fed36d
unity_docs
audio
What is `AudioSettings.GetSpatializerPluginName` in Unity? Explain its purpose and usage.
AudioSettings.GetSpatializerPluginName Declaration public static string GetSpatializerPluginName (); Returns string The spatializer plugin name. Description Returns the name of the spatializer selected on the currently-running platform. This function can be used in the Editor and in player builds.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9bdc8726db0
unity_docs
physics
What is `ParticleSystem.CollisionModule.multiplyColliderForceByParticleSize` in Unity? Explain its purpose and usage.
ParticleSystem.CollisionModule.multiplyColliderForceByParticleSize public bool multiplyColliderForceByParticleSize ; Description Specifies whether the physics system considers particle sizes when it applies forces to Colliders. If enabled, the force applied to a collider is proportional to the area (2D) or vol...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0eaddc344ea0
unity_docs
math
What is `Experimental.Rendering.ScriptableBakedReflectionSystem.stateHashes` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ScriptableBakedReflectionSystem.stateHashes public Hash128[] stateHashes ; Description The hashes of the current baked state of the ScriptableBakedReflectionSystem. An array of Hash128 values representing the files to keep i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_983be0759fa2
unity_docs
scripting
What is `ParticleSystem.LimitVelocityOverLifetimeModule.limitZMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.LimitVelocityOverLifetimeModule.limitZMultiplier public float limitZMultiplier ; Description Change the limit multiplier on the z-axis. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall limit multiplier. ```csharp using UnityEngine;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b8cabc75661
unity_docs
animation
Show me a Unity C# example demonstrating `Animations.PositionConstraint.translationAxis`.
PositionConstraint.translationAxis public Animations.Axis translationAxis ; Description The axes affected by the PositionConstraint. Use this property to restrict the effect of the constraint on a particular axis. ```csharp using UnityEngine.Animations;public class ConstraintAxis { public void ConstrainOnly...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_272962814061
unity_docs
physics
What is `PhysicsShape2D.vertexStartIndex` in Unity? Explain its purpose and usage.
PhysicsShape2D.vertexStartIndex public int vertexStartIndex ; Description The start index for the geometry of this shape within the PhysicsShapeGroup2D . Multiple PhysicsShape2D in a PhysicsShapeGroup2D are represented as a single list of vertices. This index is the start of this shape within that list. Ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ccec8900f2d6
unity_docs
scripting
Show me a Unity C# example demonstrating `NetworkReachability.NotReachable`.
NetworkReachability.NotReachable Description Network is not reachable. ```csharp //Attach this script to a GameObject //This script checks the device’s ability to reach the internet and outputs it to the console windowusing UnityEngine;public class Example : MonoBehaviour { string m_ReachabilityText; void Update()...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7af75ba15a33
unity_docs
rendering
Explain 'Configuring material properties in the Standard Shader in the Built-In Render Pipeline' in Unity.
Resources for changing how materials look by configuring the properties of the Standard Shader . Page Description Make a material transparent To make a material transparent, use the Albedo property. Set the color of a material To adjust the color of a material, use the Albedo property or assign a texture. Configure edg...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0d10ea4fd4dd
unity_docs
scripting
In Unity's 'Creating scene templates', what is 'Creating an empty scene template' and how does it work?
You can create empty scene templates and configure them later. An empty template does not appear in the New Scene dialog until you edit its properties to associate a scene asset to it. To create an empty scene template in the current project folder: From the menu, select Assets > Create > Scene Template . To create an ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.