CSV

Introduction

CSV (comma separated values) is a spreadsheet file format which has extensive support in FlatRedBall and Glue. For information on how to use CSVs in Glue, see the “Using CSVs” article. For more information on how to combine CSVs with Entities, see “How To Combine CSVs with Entities” article.

What is a CSV?

CSV stands for “comma separated values”. If you are familiar with Microsoft Excel, then you may be familiar with the .xlsx or .xls file format. The .csv file format is similar to the .xlsx file format in that they are both spreadsheet file formats. One main difference between the two is that the .csv file format is much easier to read and edit in a text editor. For example, consider the following:

Column 1 Column 2 Column 3
Value 1 Value 2 Value 3
Next Row Next Row 2 Next Row 3

If this were a CSV file viewed in a text editor then it would appear as follows:

You can see above that the values (such as “Column 1” and “Column 2”) are separated by commas. This is where the name “comma separated values” comes from.

CSVs create data files

When you create or modify a CSV which is part of your Glue project, Glue will automatically create code files (classes) which can be used to store information that is loaded from a CSV in your project. These files/classes are often referred to as “data” files and classes because Glue places them in the Data namespace of your project. The data file will include a class with the same name as your CSV file. This will include members matching the headers of the columns of your CSV. For example, consider a file EnemyInfo.csv which contains the following:

Name (required) Speed (float) Texture
Bear 60 Bear
Slug 20 Slug

If this file is added to a Screen, Entity, or Global Content, then Glue will automatically create a file called EnemyInfo.Generated.cs:

The generated file is partial

The generated code file for the data class is marked as “partial”. This means that you can add additional code files to add additional variables and functionality to data that is created by Glue. To do this:

  1. Find the data file in Visual Studio
  2. Right-click on the folder containing the Data file
  3. Select “Add”->”Class…”
  4. Enter the name of your CSV file without the extension. For example, if using EnemyInfo.csv, the new Class name would be EnemyInfo (so it matches the class name in the generated file)
  5. Once the file is selected, find the header of the file and make it partial. In other words, change:

to

Now you can things to EnemyInfo to help you work with the generated class.

Note that this approach of using partial classes is the same as what Glue automatically does for you when you create a Screen or Entity. Custom code is very common in Screens and Entities, so Glue automatically creates a custom code file for you. Custom code in data classes is less common so Glue does not automatically do this for you; however if you do it manually it will work the same way.