Unity’s support for the C# language includes the use of directives, which allow you to selectively include or exclude code from compilation, based on whether certain scripting symbols are defined. For more information on how these directives work in C#, refer to Microsoft’s documentation on C# preprocessor directives.
Unity has a range of predefined symbols you can use in your scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary to selectively include or exclude sections of code from compilation. For example, the symbol that’s defined in project builds for Windows standalone platform is UNITY_STANDALONE_WIN
. You can check whether this symbol is defined using a special type of if
statement:
#if UNITY_STANDALONE_WIN
Debug.Log("Standalone Windows");
#endif
The hash (#
) character in front of #if
and #endif
indicates that these statements are directives that are handled during the compilation process, rather than at runtime. In the previous example, the Debug line is only included for compilation in the Windows standalone build of the project. When compiled in the Unity Editor or in other target builds, it’s omitted entirely. This is different to using a regular if statements, which might only bypass the execution of certain sections of code at runtime.
You can use the #elif
and #else
directives to check multiple conditions:
#if UNITY_EDITOR
Debug.Log("Unity Editor");
#elif UNITY_IOS
Debug.Log("Unity iOS");
#else
Debug.Log("Any other platform");
#endif
There are several predefined symbols which allow you to selectively compile or omit code based on the selected Platform, the Editor Version, and other system environment scenarios. For the full list of Unity’s predefined symbols, refer to Unity scripting symbol reference.
You can also define your own scripting symbols using the Editor, via scripting, or via an asset file. For more information, refer to Custom scripting symbols.
Note: Scripting symbols are also referred to as define symbols, preprocessor defines, or just defines.
Preprocessor directives are not always the most appropriate or reliable way to conditionally include or exclude code. Alternative approaches are listed here.
Conditional
attributeYou can use the C# Conditional
attribute which is a cleaner, less error-prone way of stripping out functions. For more information, refer to ConditionalAttribute Class. Common Unity callbacks such as Start()
, Update()
, LateUpdate()
, FixedUpdate()
, Awake()
aren’t affected by this attribute because they’re called directly from the engine and, for performance reasons, it doesn’t take them into account.
The recommended approach for conditional compilation at a high level is to organize your scripts in assemblies with associated Assembly Definition files. If the code you want to conditionally include or exclude is in an assembly, you can configure Define Constraints on the assembly definition to, for example, only compile the code when a given version of a package is present in the project.
Instead of conditional compilation, you can enforce conditional execution of the compiled code using standard if
statements. For example, Unity’s UNITY_64
scripting symbol is an unreliable test for 64-bit architecture, so it’s preferable to do the following instead:
if (IntPtr.Size == 4)
{
// 32 bit code
}
else
{
// 64-bit code
}
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.