Code Tab

Introduction

The Code tab provides generated code for your current Gum objects.

This tab provides the following functionality:

• Immediate display of generated code for the selected object

• Ability to see generated code for individual instances in an object or for an entire component/screen

• Ability to generate code automatically for a variety of target platforms

If you are working with Gum in a C# environment then the Code tab can help you write Gum code.

Enabling CodeGen Preview

To enable code generation:

1. Select a Screen, Component, or instance

2. Check the Is CodeGen Plugin Enabled checkbox

3. Check the Show CodeGen Preview checkbox to display the current selection in the preview window

Previewing Instances

If you have a single instance selected, the preview window displays the code for creating the instance and assigning its variables. This is especially useful if you are unsure how to reproduce a particular layout in code. For example, the following image shows the generated code for a Text named TextInstance.

The generated code shows all of the assignments necessary to reproduce the current instance's layout. Keep in mind that only explicitly-set variables are displayed. Any default (green background) variables are not assigned in generated code.

Previewing Entire Screens and Components

If a Screen or Component is selected, then an entire class for the component is displayed in the preview window. This generated code includes:

• using statements

• A partial class with the suggested name. The name appends the word "Runtime" to the Screen or Component name

• enum declaration for all categories

• Properties for each category including switch statements assigning all properties for each state

• A property for each instance in the Screen or Component

• Initialization of all variables including variables on the instances

Automatic Saving of Generated Code

The Code tab supports the automatic copying of files to disk. By using this feature, C# projects can automatically stay in sync with Gum projects, eliminating the need to write custom Runtime objects.

To set up automatic code generation, first enable the code generation plugin as shown above. The Show CodeGen Preview checkbox does not need to be checked.

Next, modify the values in the Project-Wide Code Generation section and the Element Code Generation section as discussed in the following sections:

Output Library

Select the desired Output Library, such as MonoGame.

Object Instantiation Type

If you are planning on loading the .gumx project, select the FindByName option.

If you would like the entire project generated, select the FullyInCode option. This option enables working in Gum to create layouts which will work fully in code without loading a .gumx file. This is especially important if you are working on a platform with limited IO access. Generated code can run faster than loading a .gumx file since it does not require file IO, XML parsing, and reflection.

For more details see the Runtime Generation Details page.

Project-wide Using Statements

Add the following using statement at the end of the Project-wide Using Statement box so that references to standard runtime types are found.

using MonoGameGum.GueDeriving;

If you plan on creating Screens, you should also add using statements for your component runtimes

using {YourProjectNamespace}.Components;

Code Project Root

Enter the location of the folder containing the .csproj file in the Code Project Root text box. If an absolute path is entered, it is saved to a relative path so that generation works for all users working on a project regardless of where a project is cloned even though it appears absolute in Gum. For example: C:\Users\Owner\Documents\GitHub\Gum\Samples\MonoGameGumCodeGeneration\

Since the path is saved as relative to your .gumx location, this path will break if you move your Gum project to a new location. Be sure to update this if you are moving your .gumx.

Root Namespace

Enter the project's Root Namespace, such as MyGame.

Default Screen Base

Enter the type that you would like all Screen runtimes to inherit from. If you're not sure what to enter, then use GraphicalUiElement. If your game uses a custom class that you have written for all Screens, then use the name of that class. You can switch to custom classes later as your project grows.

Generation Behavior

Select NeverGenerate for components which should not generate to disk

Select GenerateManually if you would like to generate code only when the Generate Code button is clicked.

Select GenerateAutomaticallyOnPropertyChange to generate code whenever a property changed. This option is useful once you are comfortable with code generation. It results in code being generated automatically as you make edits in Gum.