Skip to content

C#: Add tip about excluding template files from build #7644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2023
Merged

C#: Add tip about excluding template files from build #7644

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions tutorials/scripting/creating_script_templates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,12 @@ This is an example of utilizing custom templates at editor and project level:
visible throughout the project's filesystem anymore, yet the templates can be
modified by an external text editor anytime.

.. tip::

By default, every C# file inside the project directory is included in the compilation.
Script templates must be manually excluded from the C# project to avoid build errors.
See `Exclude files from the build <https://learn.microsoft.com/en-us/visualstudio/msbuild/how-to-exclude-files-from-the-build>`_ in the Microsoft documentation.

It is possible to create editor-level templates that have the same level as a project-specific
templates, and also that have the same name as a built-in one, all will be shown on the new script
dialog.
Expand Down Expand Up @@ -190,20 +196,23 @@ which are currently implemented.
Base placeholders
~~~~~~~~~~~~~~~~~

+-------------+-----------------------------------------------------------------+
| Placeholder | Description |
+=============+=================================================================+
| ``_CLASS_`` | The name of the new class (used in C# only). |
+-------------+-----------------------------------------------------------------+
| ``_BASE_`` | The base type a new script inherits from. |
+-------------+-----------------------------------------------------------------+
| ``_TS_`` | Indentation placeholder. The exact type and number of |
| | whitespace characters used for indentation is determined by |
| | the ``text_editor/indent/type`` and ``text_editor/indent/size`` |
| | settings in the :ref:`EditorSettings <class_EditorSettings>` |
| | respectively. Can be overridden by the ``meta-space-indent`` |
| | header on the template. |
+-------------+-----------------------------------------------------------------+
+--------------------------+----------------------------------------------------+
| Placeholder | Description |
+==========================+====================================================+
| ``_BINDINGS_NAMESPACE_`` | The name of the Godot namespace (used in C# only). |
+--------------------------+----------------------------------------------------+
| ``_CLASS_`` | The name of the new class (used in C# only). |
+--------------------------+----------------------------------------------------+
| ``_BASE_`` | The base type a new script inherits from. |
+--------------------------+----------------------------------------------------+
| ``_TS_`` | Indentation placeholder. The exact type and number |
| | of whitespace characters used for indentation is |
| | determined by the ``text_editor/indent/type`` and |
| | ``text_editor/indent/size`` settings in the |
| | :ref:`EditorSettings <class_EditorSettings>` |
| | respectively. Can be overridden by the |
| | ``meta-space-indent`` header on the template. |
+--------------------------+----------------------------------------------------+

Type placeholders
~~~~~~~~~~~~~~~~~
Expand Down