Skip to content

Commit c88d002

Browse files
committed
style changes
1 parent 6a1c232 commit c88d002

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+1729
-1719
lines changed

api/actor/State.md

+47-50
Original file line numberDiff line numberDiff line change
@@ -33,90 +33,87 @@ struct State
3333
}
3434
```
3535

36-
- `Frame`
36+
### `Frame`
3737

38-
The sprite frame of this state.
38+
The sprite frame of this state.
3939

40-
- `NextState`
40+
### `NextState`
4141

42-
A pointer to the next state in the global state table.
42+
A pointer to the next state in the global state table.
4343

44-
- `Sprite`
44+
### `Sprite`
4545

46-
The sprite ID of this state.
46+
The sprite ID of this state.
4747

48-
- `Tics`
48+
### `Tics`
4949

50-
The number of game ticks this state lasts.
50+
The number of game ticks this state lasts.
5151

52-
- `Misc1`
53-
- `Misc2`
52+
### `Misc1`, `Misc2`
5453

55-
Primarily used in DeHackEd compatibility. Don't use this.
54+
Primarily used in DeHackEd compatibility. Don't use this.
5655

57-
- `TicRange`
56+
### `TicRange`
5857

59-
The maximum amount of tics to add for random tic durations, or `0` if the
60-
duration is not random. For example, `TNT1 A random(5, 7)` would have a
61-
`Tics` value of `5` and a `TicRange` of `2`.
58+
The maximum amount of tics to add for random tic durations, or `0` if the
59+
duration is not random. For example, `TNT1 A random(5, 7)` would have a `Tics`
60+
value of `5` and a `TicRange` of `2`.
6261

63-
- `UseFlags`
62+
### `UseFlags`
6463

65-
The scope of this state. See *Action Scoping*. Can have any of the
66-
`DefaultStateUsage` flags.
64+
The scope of this state. See *Action Scoping*. Can have any of the
65+
`DefaultStateUsage` flags.
6766

68-
- `bCanRaise`
67+
### `bCanRaise`
6968

70-
State has the `CanRaise` flag, allowing `A_VileChase` to target this actor
71-
for healing without entering an infinitely long state.
69+
State has the `CanRaise` flag, allowing `A_VileChase` to target this actor for
70+
healing without entering an infinitely long state.
7271

73-
- `bDeHackEd`
72+
### `bDeHackEd`
7473

75-
`true` if the state has been modified by DeHackEd.
74+
`true` if the state has been modified by DeHackEd.
7675

77-
- `bFast`
76+
### `bFast`
7877

79-
State has the `Fast` flag, halving the duration when fast monsters is
80-
enabled.
78+
State has the `Fast` flag, halving the duration when fast monsters is enabled.
8179

82-
- `bFullBright`
80+
### `bFullBright`
8381

84-
State has the `Bright` flag, making it fully bright regardless of other
85-
lighting conditions.
82+
State has the `Bright` flag, making it fully bright regardless of other
83+
lighting conditions.
8684

87-
- `bNoDelay`
85+
### `bNoDelay`
8886

89-
State has the `NoDelay` flag, forcing the associated action function to be
90-
run if the actor is in its first tic.
87+
State has the `NoDelay` flag, forcing the associated action function to be run
88+
if the actor is in its first tic.
9189

92-
- `bSameFrame`
90+
### `bSameFrame`
9391

94-
`true` if the state's frame is to be kept from the last frame used, i.e., is
95-
`#`.
92+
`true` if the state's frame is to be kept from the last frame used, i.e., is
93+
`#`.
9694

97-
- `bSlow`
95+
### `bSlow`
9896

99-
State has the `Slow` flag, doubling the duration when slow monsters is
100-
enabled.
97+
State has the `Slow` flag, doubling the duration when slow monsters is enabled.
10198

102-
- `DistanceTo`
99+
### `DistanceTo`
103100

104-
Returns the offset between this state and `other` in the global frame table.
105-
Only works if both states are owned by the same actor.
101+
Returns the offset between this state and `other` in the global frame table.
102+
Only works if both states are owned by the same actor.
106103

107-
- `InStateSequence`
104+
### `InStateSequence`
108105

109-
Returns `true` if this state is within a contiguous state sequence beginning
110-
with `base`.
106+
Returns `true` if this state is within a contiguous state sequence beginning
107+
with `base`.
111108

112-
- `ValidateSpriteFrame`
109+
### `ValidateSpriteFrame`
113110

114-
Returns `true` if the sprite frame actually exists.
111+
Returns `true` if the sprite frame actually exists.
115112

116-
- `GetSpriteTexture`
113+
### `GetSpriteTexture`
117114

118-
Returns the texture, if the texture should be flipped horizontally, and
119-
scaling of this state's sprite. Scaling will return `scale` unless `skin` is
120-
nonzero. `skin` determines the player skin used.
115+
Returns the texture, if the texture should be flipped horizontally, and scaling
116+
of this state's sprite. Scaling will return `scale` unless `skin` is nonzero.
117+
`skin` determines the player skin used.
121118

122119
<!-- EOF -->

api/base/Array.md

+41-41
Original file line numberDiff line numberDiff line change
@@ -30,75 +30,75 @@ struct Array<Type>
3030
}
3131
```
3232

33-
- `Max`
33+
### `Max`
3434

35-
Returns the amount of allocated objects in the array.
35+
Returns the amount of allocated objects in the array.
3636

37-
- `Size`
37+
### `Size`
3838

39-
Returns the amount of constructed objects in the array.
39+
Returns the amount of constructed objects in the array.
4040

41-
- `Clear`
41+
### `Clear`
4242

43-
Clears out the entire array, possibly destroying all objects in it.
43+
Clears out the entire array, possibly destroying all objects in it.
4444

45-
- `Delete`
45+
### `Delete`
4646

47-
Removes `count` objects starting at `index`, possibly destroying them. Moves
48-
objects after `index + count` to the left.
47+
Removes `count` objects starting at `index`, possibly destroying them. Moves
48+
objects after `index + count` to the left.
4949

50-
- `Pop`
50+
### `Pop`
5151

52-
Removes the last item in the array, possibly destroying it. Returns `false`
53-
if there are no items in the array to begin with.
52+
Removes the last item in the array, possibly destroying it. Returns `false` if
53+
there are no items in the array to begin with.
5454

55-
- `Append`
55+
### `Append`
5656

57-
Value-copies another array's contents and places them into this array at the
58-
end.
57+
Value-copies another array's contents and places them into this array at the
58+
end.
5959

60-
- `Copy`
60+
### `Copy`
6161

62-
Value-copies another array's contents into this array. The contents of
63-
`other` are preserved. This operation can be extremely taxing in some cases.
62+
Value-copies another array's contents into this array. The contents of `other`
63+
are preserved. This operation can be extremely taxing in some cases.
6464

65-
- `Move`
65+
### `Move`
6666

67-
Moves another array's contents into this array. The contents of `other` are
68-
left indeterminate and shall not be used. This operation is extremely fast
69-
as it only copies pointers but must be used carefully to avoid error.
67+
Moves another array's contents into this array. The contents of `other` are
68+
left indeterminate and shall not be used. This operation is extremely fast
69+
as it only copies pointers but must be used carefully to avoid error.
7070

71-
- `Find`
71+
### `Find`
7272

73-
Finds the index of `item` in the array, or `Size` if it couldn't be found.
73+
Finds the index of `item` in the array, or `Size` if it couldn't be found.
7474

75-
- `Grow`
75+
### `Grow`
7676

77-
Ensures the array can hold at least `amount` new members, growing the
78-
allocated object amount if necessary.
77+
Ensures the array can hold at least `amount` new members, growing the allocated
78+
object amount if necessary.
7979

80-
- `Insert`
80+
### `Insert`
8181

82-
Inserts `item` at `index`. Moves objects after `index` to the right.
82+
Inserts `item` at `index`. Moves objects after `index` to the right.
8383

84-
- `Push`
84+
### `Push`
8585

86-
Places `item` at the end of the array, calling `Grow` if necessary.
86+
Places `item` at the end of the array, calling `Grow` if necessary.
8787

88-
- `Reserve`
88+
### `Reserve`
8989

90-
Adds `amount` new empty-constructed objects at the end of the array,
91-
increasing `Size` and calling `Grow` if necessary. Value types are
92-
initialized to zero and reference types to `null`.
90+
Adds `amount` new empty-constructed objects at the end of the array, increasing
91+
`Size` and calling `Grow` if necessary. Value types are initialized to zero and
92+
reference types to `null`.
9393

94-
- `Resize`
94+
### `Resize`
9595

96-
Adds or removes objects based on `amount`. If it is less than `Size` then
97-
objects are destroyed, if it is more then objects are empty-constructed. New
98-
objects follow the same initialization rules as `Reserve`.
96+
Adds or removes objects based on `amount`. If it is less than `Size` then
97+
objects are destroyed, if it is more then objects are empty-constructed. New
98+
objects follow the same initialization rules as `Reserve`.
9999

100-
- `ShrinkToFit`
100+
### `ShrinkToFit`
101101

102-
Shrinks `Max` to `Size`. Does not mutate any objects in the array.
102+
Shrinks `Max` to `Size`. Does not mutate any objects in the array.
103103

104104
<!-- EOF -->

api/base/CVar.md

+33-36
Original file line numberDiff line numberDiff line change
@@ -27,59 +27,56 @@ struct CVar
2727
}
2828
```
2929

30-
- `FindCVar`
30+
### `FindCVar`
3131

32-
Returns a server CVar by name, or `null` if none is found.
32+
Returns a server CVar by name, or `null` if none is found.
3333

34-
- `GetCVar`
34+
### `GetCVar`
3535

36-
Returns a user or server CVar by name, with `player` as the user if
37-
applicable, or `null` if none is found.
36+
Returns a user or server CVar by name, with `player` as the user if applicable,
37+
or `null` if none is found.
3838

39-
- `GetBool`
39+
### `GetBool`
4040

41-
Returns a boolean representing the value of the CVar, or `false` if it
42-
cannot be represented.
41+
Returns a boolean representing the value of the CVar, or `false` if it
42+
cannot be represented.
4343

44-
- `GetFloat`
44+
### `GetFloat`
4545

46-
Returns a float representing the value of the CVar, or `0.0` if it cannot be
47-
represented.
46+
Returns a float representing the value of the CVar, or `0.0` if it cannot be
47+
represented.
4848

49-
- `GetInt`
49+
### `GetInt`
5050

51-
Returns an integer representing the value of the CVar, or `0` if it cannot
52-
be represented.
51+
Returns an integer representing the value of the CVar, or `0` if it cannot be
52+
represented.
5353

54-
- `GetString`
54+
### `GetString`
5555

56-
Returns a string representing the value of the CVar. CVars can always be
57-
represented as strings.
56+
Returns a string representing the value of the CVar. CVars can always be
57+
represented as strings.
5858

59-
- `SetBool`
60-
- `SetFloat`
61-
- `SetInt`
62-
- `SetString`
59+
### `SetBool`, `SetFloat`, `SetInt`, `SetString`
6360

64-
Sets the representation of the CVar to `v`. May only be used on mod-defined
65-
CVars.
61+
Sets the representation of the CVar to `v`. May only be used on mod-defined
62+
CVars.
6663

67-
- `GetRealType`
64+
### `GetRealType`
6865

69-
Returns the type of the CVar as it was defined, which may be one of the
70-
following:
66+
Returns the type of the CVar as it was defined, which may be one of the
67+
following:
7168

72-
| Name |
73-
| ---- |
74-
| `CVar.CVAR_BOOL` |
75-
| `CVar.CVAR_COLOR |
76-
| `CVar.CVAR_FLOAT` |
77-
| `CVar.CVAR_INT` |
78-
| `CVar.CVAR_STRING` |
69+
| Name |
70+
| ---- |
71+
| `CVar.CVAR_BOOL` |
72+
| `CVar.CVAR_COLOR` |
73+
| `CVar.CVAR_FLOAT` |
74+
| `CVar.CVAR_INT` |
75+
| `CVar.CVAR_STRING` |
7976

80-
- `ResetToDefault`
77+
### `ResetToDefault`
8178

82-
Resets the CVar to its default value and returns 0. The purpose of the
83-
return is unknown. May only be used on mod-defined CVars.
79+
Resets the CVar to its default value and returns 0. The purpose of the
80+
return is unknown. May only be used on mod-defined CVars.
8481

8582
<!-- EOF -->

api/base/FixedArray.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ struct Type[N]
99
}
1010
```
1111

12-
- `Size`
12+
### `Size`
1313

14-
Returns the size of the array. This is a compile-time constant.
14+
Returns the size of the array. This is a compile-time constant.
1515

1616
<!-- EOF -->

0 commit comments

Comments
 (0)