Skip to content

Commit 8e6ef41

Browse files
authored
Complete QodotTrenchbroomConfigFolder descriptors
1 parent 72e4b9b commit 8e6ef41

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/class-reference.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,32 @@ A string that filters the specific texture to apply this tag with. Only applies
5252

5353
**Export File**
5454

55+
Creates a new subfolder in the Trenchbroom games folder, named after your Game Name. It also adds (or updates) files to the subfolder: A GameConfig.cfg file, an Icon.png, and all [FGDs](entities/fgd.md) linked in the Fgd Files array.
56+
5557
**Trenchbroom Games Folder**
5658

59+
The system location of your Trenchbroom games folder. This is either found inside your Trenchbroom installation, or your user folder. See [Config Folder Propeties](https://qodotplugin.github.io/docs/entities/game-definition#config-folder-properties) for common locations on various OSes.
60+
5761
**Game Name**
5862

63+
Unique identifier for your project in Trenchbroom's "select game" folder. Game names *can* contain spaces.
64+
5965
**Icon**
6066

67+
Pulls from your project's `res://icon.png` file by default.
68+
6169
**Fgd Files**
6270

71+
A list of all [FGD](entities/fgd.md) files to include in the [Game Definition](entities/game-definition.md).
72+
6373
**Brush Tags**
6474

75+
A lookup pattern for all brush entity classnames in the map to apply editor hints, such as `_transparent`.
76+
6577
**Face Tags**
6678

79+
A lookup pattern for all texture names in the map to apply editor hints, such as `_transparent`.
80+
6781
**Face Attrib Surface Flag**
6882

6983
Creates a map-wide boolean that can be applied to any face in Trenchbroom's face editor. Surface flags mark a face with a specific property, usually for rendering purposes.
@@ -102,17 +116,17 @@ Trenchbroom will fail to load any entity definitions missing a classname.
102116

103117
## QodotFGDClass
104118

105-
**Classname** - The name for this class in Trenchbroom.
119+
**Classname** - The name for this class in Trenchbroom. Cannot contain spaces.
106120

107-
**Description** - A short description that displays in Trenchbroom when this entity is selected.
121+
**Description** - A short description that displays in Trenchbroom's entity browser when this entity is selected.
108122

109123
**Qodot Internal** - Hides the entity in Trenchbroom's entity browser.
110124

111-
Qodot can still refer to this entity for building other entities (like base entities). Base Entities are already hidden in Trenchbroom by default, for most situations you can leave this off.
125+
Qodot can still refer to this entity for building other entities (like base entities). Base Entities are already hidden in Trenchbroom by default, in most cases you can leave this off.
112126

113127
**Base Classes** - An array of template entities to inherit properties from.
114128

115-
This determines the parent entities for this class, where this entity gets all the class properties, meta properties, and property descriptions from its parents.
129+
All base classes placed here will give the same class properties, meta properties, and property descriptions to the current entity definition.
116130

117131
**Class Properties** - A dictionary of properties.
118132

0 commit comments

Comments
 (0)