This section describes the conventions used throughout the guides in the Tutorials section on Nintendo Developer Portal.
Tutorial Structure
The Tutorials section for each platform contains a number of guides, each about a specific topic. The topic is further broken down into individual sections. A section can contain a general description of a concept, step-by-step instructions on how to implement the concept, or both. The guides can be read in any order, but some assume the reader is already familiar with the materials in the earlier guides.
Individual sections are generally structured as follows.
- An introduction that describes what the section covers.
- Any requirements before you can start.
- An explanation of any important platform-specific concepts.
- A step-by-step guide of how to implement the concepts in code.
The bottom of each page includes links to the previous and next section in the current guide. Use the left-hand navigation tree to go to a different guide.
Code Samples
Many of the sections include code samples that demonstrate how to implement certain Unity features on specific Nintendo platforms. Depending on the complexity of the concept being explained, code may be provided as a snippet or as a complete code file. All code samples are provided in C# only.
Formatting
The guides use the following conventions for formatting text.
- The names of specific UI elements are given in bold text.
- The names of classes, variables, methods, and Unity components are given in
monospace text
. - Menu sequences are separated by a greater-than symbol (>). For example,
Select Edit > Project Settings > Player to viewPlayerSettings
in the Inspector tab.
A Warning block provides critical information. Always read the information in a warning block before completing the step in which it appears.
A Note block provides important information such as guideline requirements and platform-specific information that is important to know in most situations.
An Info block provides supplementary information that is not necessarily required, but might be useful in certain situations. This includes guideline recommendations.