Version: Unity 6.1 Alpha (6000.1)
Language : English
Get started with scripting
Creating scripts

Introduction to scripting

Unity is customizable and extensible by design and almost everything is scriptable to some extent. Many items you can configure through the various Editor views have a corresponding public C# class representation that you can interact with in code.

You can use Editor APIs to customize and extend the Editor authoring tools to improve your development workflows. You can use Engine APIs to define the runtime functionality of your application, including graphics, physics, character behavior, and responses to user input.

The Scripting API reference provides the complete and authoritative reference for all public Unity APIs. The Manual provides additional context and guidance.

The Unity scripting environment

Unity supports scripting in the C# programming language. C# (pronounced C-sharp) is a managed, object-oriented programming language, which is part of the .NET platform and runs in the cross-platform .NET runtime. Other .NET languages can be used with Unity if they can compile a compatible DLL, refer to Managed plugins for further details.

The scripting environment refers to both:

  • Your own local environment or context in which you’re writing code. This includes your code editor (IDE) and integrated source control solution and operating system.
  • The C# scripting enviroment Unity provides. A given version of Unity supports given versions of the .NET platform, which determines the .NET libraries you can use in your code.

For more information on the scripting environment and tools, refer to Environment and tools.

How scripting in Unity works

C# scripts (files with a .cs file extension) are assetsAny media or data that can be used in your game or project. An asset may come from a file created outside of Unity, such as a 3D Model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
See in Glossary
in your project, stored in the Assets folder and saved as part of the asset database. You can create template scripts that derive from the common built-in Unity types through the Scripting submenu of the Assets > Create menu.

You configure a default External Script Editor, which is the program Unity opens your script assets in for editing. Usually this will be one of the supported IDEs for Unity development.

You can create your own regular C# types and logic to use in your game, as long as the code you write is compatible with the active .NET profile. But your scripted types gain additional functionality in Unity when they inherit from a built-in Unity type.

If your custom types inherit from UnityEngine.Object, they’ll be assignable to fields in the InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary
window. Inheriting from MonoBehaviour allows a script to be attached to a GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary
as a component to control the behaviour of a GameObject in a sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary
.

For more information on fundamental Unity types you can inherit from, refer to Fundamental Unity types.

For more information on viewing 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
and editing script components in the Inspector, refer to Inspecting scripts.

Compilation and code reload

Compilation transforms the C# code you write into code that runs on a given target platform. Some aspects of compilation are under your control and others aren’t. By organizing your scripts into assemblies you can reduce unnecessary recompilation and manage your dependencies effectively. With conditional compilation you can selectively include or exlcude sections of your code from compilation.

Depending on your settings, Unity recompiles and reloads your code in various contexts. Reloading code is important for changes to take effect or to preserve state when transitioning between Edit mode and Play mode, but it also impacts performance and iteration times. It’s important to understand these costs and how you can configure Unity’s code reload behavior to mitigate them.

Additional resources

Get started with scripting
Creating scripts