Skip to content

Commit eb2ce6f

Browse files
authored
Add face attribute documentation
1 parent 663cdcb commit eb2ce6f

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

docs/class-reference.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,37 @@
1-
# Warning
1+
# Class Reference
22

33
This class reference is incomplete. You can help complete it by [making an issue on GitHub](https://github.com/QodotPlugin/qodotplugin.github.io/issues/new) or [contributing to the class reference directly](https://github.com/QodotPlugin/qodotplugin.github.io).
44

5+
# QodotTrenchbroomConfigFolder
6+
7+
**Export File**
8+
9+
**Trenchbroom Games Folder**
10+
11+
**Game Name**
12+
13+
**Icon**
14+
15+
**Fgd Files**
16+
17+
**Brush Tags**
18+
19+
**Face Tags**
20+
21+
**Face Attrib Surface Flag**
22+
23+
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.
24+
25+
Quake 2 uses these for visual effects like "light", "warp", "moving", "nodraw", "sky", and more. Read more about Face Attributes in the [Trenchbroom Manual](https://trenchbroom.github.io/manual/latest/#face_attribute_editor).
26+
27+
**Face Attrib Content Flag**
28+
29+
Creates a map-wide boolean that can be applied to any face in the face editor. Content flags mark a brush with a specific property, usually for gameplay.
30+
31+
Quake 2 uses these for gameplay elements like "playerclip", "monsterclip", "water", "lava", "slime", "mist", and more. Read more about Face Attributes in the [Trenchbroom Manual](https://trenchbroom.github.io/manual/latest/#face_attribute_editor).
32+
33+
![](https://trenchbroom.github.io/manual/latest/images/FaceAttribsEditor.png)
34+
535
# QodotFGDFile
636

737
**Fgd Name**
@@ -20,9 +50,7 @@ Note
2050
{: .label .label-blue }
2151
Trenchbroom will fail to load any entity definitions missing a classname.
2252

23-
# QodotFGD*Class
24-
25-
These properties are shared by Point and Solid classes.
53+
# QodotFGDClass
2654

2755
**Classname** - The name for this class in Trenchbroom.
2856

@@ -40,31 +68,18 @@ This determines the parent entities for this class, where this entity gets all t
4068

4169
Once exported to the Trenchbroom game config, the dictionary values are written by editing entities in Trenchbroom, and read by accessing `properties` on a QodotEntity once the map is built.
4270

43-
To add a new class property to an entity:
44-
45-
1. Open the dictionary.
46-
2. Click the first pencil by "New Key: [null]" and select "String" as the key data type.
47-
3. Name your property in the key text field, no spaces.
48-
4. Click the second pencil by "New Value: [null]".
49-
5. Select any valid data type. Read [Class Property Data Types](#class-property-data-types) for more information.
50-
6. Change the value to your desired default, or leave it blank.
51-
7. Click "Add new key/value pair".
52-
8. Re-export your FGD once all class properties are added.
53-
54-
You can also set default values for your properties, by repeating this process in Meta Properties, matching the key names and value datatypes from this dictionary.
71+
You can also set default values for your properties by repeating this process in Meta Properties, matching the key names and value datatypes from this dictionary.
5572

5673
**Class Property Descriptions** - A dictionary of descriptions for each property, visible in Trenchbroom.
5774

58-
Follow the same steps as adding class properties to add property descriptions. Ensure the description's key matches the property's key. Description values can only be strings.
75+
Ensure the description's key matches the property's key. Description values can only be strings.
5976

6077
**Meta Properties** - Editor-specific properties, such as the default color and size used to represent this class.
6178

6279
Add an entry with a matching key to an existing property, set the value to the same data type, and whatever value is present will become the default. Only one meta property is read per class property.
6380

6481
**Node Class** - The type of Godot node to spawn at this location.
6582

66-
This doesn't fully control the type of node that Godot spawns, read on to learn more about using Node Class with Point Classes and Solid Classes.
67-
6883
## QodotFGDPointClass
6984

7085
**Scene File** - The .tscn Godot scene that spawns in place of QodotEntity. The easiest way to spawn a specific node at a specific point.

0 commit comments

Comments
 (0)