You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/class-reference.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,18 +52,32 @@ A string that filters the specific texture to apply this tag with. Only applies
52
52
53
53
**Export File**
54
54
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
+
55
57
**Trenchbroom Games Folder**
56
58
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
+
57
61
**Game Name**
58
62
63
+
Unique identifier for your project in Trenchbroom's "select game" folder. Game names *can* contain spaces.
64
+
59
65
**Icon**
60
66
67
+
Pulls from your project's `res://icon.png` file by default.
68
+
61
69
**Fgd Files**
62
70
71
+
A list of all [FGD](entities/fgd.md) files to include in the [Game Definition](entities/game-definition.md).
72
+
63
73
**Brush Tags**
64
74
75
+
A lookup pattern for all brush entity classnames in the map to apply editor hints, such as `_transparent`.
76
+
65
77
**Face Tags**
66
78
79
+
A lookup pattern for all texture names in the map to apply editor hints, such as `_transparent`.
80
+
67
81
**Face Attrib Surface Flag**
68
82
69
83
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.
102
116
103
117
## QodotFGDClass
104
118
105
-
**Classname** - The name for this class in Trenchbroom.
119
+
**Classname** - The name for this class in Trenchbroom. Cannot contain spaces.
106
120
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.
108
122
109
123
**Qodot Internal** - Hides the entity in Trenchbroom's entity browser.
110
124
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.
112
126
113
127
**Base Classes** - An array of template entities to inherit properties from.
114
128
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.
116
130
117
131
**Class Properties** - A dictionary of properties.
0 commit comments