Skip to content

Commit 2c7343f

Browse files
wu-vincentwu-vincent
committed
feat: add new config options and template filter
1 parent b2aedfa commit 2c7343f

File tree

21 files changed

+1250
-1111
lines changed

21 files changed

+1250
-1111
lines changed

‎content/reference/python/actor.mdx‎

Lines changed: 47 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,29 @@ Represents a base actor in the level.
3030
</tr>
3131
</thead>
3232
<tbody>
33-
<tr key="add_scoreboard_tag">
33+
<tr key="1-add_scoreboard_tag">
3434
<td>[`add_scoreboard_tag`](#endstone.actor.Actor.add_scoreboard_tag)</td>
3535
<td>Adds a tag to this actor.</td>
3636
</tr>
37-
<tr key="remove">
37+
<tr key="2-remove">
3838
<td>[`remove`](#endstone.actor.Actor.remove)</td>
3939
<td>Remove this actor from the level.</td>
4040
</tr>
41-
<tr key="remove_scoreboard_tag">
41+
<tr key="3-remove_scoreboard_tag">
4242
<td>[`remove_scoreboard_tag`](#endstone.actor.Actor.remove_scoreboard_tag)</td>
4343
<td>Removes a given tag from this actor.</td>
4444
</tr>
45-
<tr key="set_rotation">
45+
<tr key="4-set_rotation">
4646
<td>[`set_rotation`](#endstone.actor.Actor.set_rotation)</td>
4747
<td>Sets the actor's rotation.</td>
4848
</tr>
49-
<tr key="teleport">
49+
<tr key="5-teleport">
5050
<td>[`teleport`](#endstone.actor.Actor.teleport)</td>
51-
<td></td>
51+
<td>Teleports this actor to the given location.</td>
52+
</tr>
53+
<tr key="6-teleport">
54+
<td>[`teleport`](#endstone.actor.Actor.teleport)</td>
55+
<td>Teleports this actor to the target Actor.</td>
5256
</tr></tbody>
5357
</table>
5458

@@ -160,14 +164,6 @@ Represents a base actor in the level.
160164
</tr></tbody>
161165
</table>
162166

163-
#### <code className="doc-symbol doc-symbol-method"/> add_scoreboard_tag [#endstone.actor.Actor.add_scoreboard_tag]
164-
165-
```python
166-
add_scoreboard_tag(tag:str) -> bool
167-
```
168-
169-
Adds a tag to this actor.
170-
171167
#### <code className="doc-symbol doc-symbol-attribute"/> dimension [#endstone.actor.Actor.dimension]
172168

173169
```python
@@ -280,83 +276,91 @@ name_tag: str
280276

281277
Gets or sets the current name tag of the actor.
282278

283-
#### <code className="doc-symbol doc-symbol-method"/> remove [#endstone.actor.Actor.remove]
279+
#### <code className="doc-symbol doc-symbol-attribute"/> runtime_id [#endstone.actor.Actor.runtime_id]
284280

285281
```python
286-
remove() -> None
282+
runtime_id: int
287283
```
288284

289-
Remove this actor from the level.
285+
Returns the runtime id for this actor.
290286

291-
#### <code className="doc-symbol doc-symbol-method"/> remove_scoreboard_tag [#endstone.actor.Actor.remove_scoreboard_tag]
287+
#### <code className="doc-symbol doc-symbol-attribute"/> score_tag [#endstone.actor.Actor.score_tag]
292288

293289
```python
294-
remove_scoreboard_tag(tag:str) -> bool
290+
score_tag: str
295291
```
296292

297-
Removes a given tag from this actor.
293+
Gets or sets the current score tag of the actor.
298294

299-
#### <code className="doc-symbol doc-symbol-attribute"/> runtime_id [#endstone.actor.Actor.runtime_id]
295+
#### <code className="doc-symbol doc-symbol-attribute"/> scoreboard_tags [#endstone.actor.Actor.scoreboard_tags]
300296

301297
```python
302-
runtime_id: int
298+
scoreboard_tags: list[str]
303299
```
304300

305-
Returns the runtime id for this actor.
301+
Returns a list of scoreboard tags for this actor.
306302

307-
#### <code className="doc-symbol doc-symbol-attribute"/> score_tag [#endstone.actor.Actor.score_tag]
303+
#### <code className="doc-symbol doc-symbol-attribute"/> type [#endstone.actor.Actor.type]
308304

309305
```python
310-
score_tag: str
306+
type: str
311307
```
312308

313-
Gets or sets the current score tag of the actor.
309+
Gets the type of the actor.
314310

315-
#### <code className="doc-symbol doc-symbol-attribute"/> scoreboard_tags [#endstone.actor.Actor.scoreboard_tags]
311+
#### <code className="doc-symbol doc-symbol-attribute"/> velocity [#endstone.actor.Actor.velocity]
316312

317313
```python
318-
scoreboard_tags: list[str]
314+
velocity: Vector
319315
```
320316

321-
Returns a list of scoreboard tags for this actor.
317+
Gets this actor's current velocity.
322318

323-
#### <code className="doc-symbol doc-symbol-method"/> set_rotation [#endstone.actor.Actor.set_rotation]
319+
#### <code className="doc-symbol doc-symbol-method"/> add_scoreboard_tag [#endstone.actor.Actor.add_scoreboard_tag]
324320

325321
```python
326-
set_rotation(yaw:float, pitch:float) -> None
322+
add_scoreboard_tag(tag:str) -> bool
327323
```
328324

329-
Sets the actor's rotation.
325+
Adds a tag to this actor.
330326

331-
#### <code className="doc-symbol doc-symbol-method"/> teleport [#endstone.actor.Actor.teleport]
327+
#### <code className="doc-symbol doc-symbol-method"/> remove [#endstone.actor.Actor.remove]
332328

333329
```python
334-
teleport(location:Location) -> None
330+
remove() -> None
335331
```
336332

337-
Teleports this actor to the given location.
333+
Remove this actor from the level.
334+
335+
#### <code className="doc-symbol doc-symbol-method"/> remove_scoreboard_tag [#endstone.actor.Actor.remove_scoreboard_tag]
338336

339337
```python
340-
teleport(target:Actor) -> None
338+
remove_scoreboard_tag(tag:str) -> bool
341339
```
342340

343-
Teleports this actor to the target Actor.
341+
Removes a given tag from this actor.
344342

345-
#### <code className="doc-symbol doc-symbol-attribute"/> type [#endstone.actor.Actor.type]
343+
#### <code className="doc-symbol doc-symbol-method"/> set_rotation [#endstone.actor.Actor.set_rotation]
346344

347345
```python
348-
type: str
346+
set_rotation(yaw:float, pitch:float) -> None
349347
```
350348

351-
Gets the type of the actor.
349+
Sets the actor's rotation.
352350

353-
#### <code className="doc-symbol doc-symbol-attribute"/> velocity [#endstone.actor.Actor.velocity]
351+
#### <code className="doc-symbol doc-symbol-method"/> teleport [#endstone.actor.Actor.teleport]
354352

355353
```python
356-
velocity: Vector
354+
teleport(location:Location) -> None
357355
```
358356

359-
Gets this actor's current velocity.
357+
Teleports this actor to the given location.
358+
359+
```python
360+
teleport(target:Actor) -> None
361+
```
362+
363+
Teleports this actor to the target Actor.
360364

361365
</div>
362366

‎content/reference/python/ban.mdx‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,19 @@ Represents a ban list containing banned IP addresses.
6969
</tr>
7070
</thead>
7171
<tbody>
72-
<tr key="add_ban">
72+
<tr key="1-add_ban">
7373
<td>[`add_ban`](#endstone.ban.IpBanList.add_ban)</td>
7474
<td>Adds a ban to this list, or updates an existing one.</td>
7575
</tr>
76-
<tr key="get_ban_entry">
76+
<tr key="2-get_ban_entry">
7777
<td>[`get_ban_entry`](#endstone.ban.IpBanList.get_ban_entry)</td>
7878
<td>Gets a BanEntry by IP address.</td>
7979
</tr>
80-
<tr key="is_banned">
80+
<tr key="3-is_banned">
8181
<td>[`is_banned`](#endstone.ban.IpBanList.is_banned)</td>
8282
<td>Checks if a BanEntry exists for the target by IP address.</td>
8383
</tr>
84-
<tr key="remove_ban">
84+
<tr key="4-remove_ban">
8585
<td>[`remove_ban`](#endstone.ban.IpBanList.remove_ban)</td>
8686
<td>Removes an IP address from the ban list.</td>
8787
</tr></tbody>
@@ -105,6 +105,14 @@ Represents a ban list containing banned IP addresses.
105105
</tr></tbody>
106106
</table>
107107

108+
#### <code className="doc-symbol doc-symbol-attribute"/> entries [#endstone.ban.IpBanList.entries]
109+
110+
```python
111+
entries: list[IpBanEntry]
112+
```
113+
114+
Gets a vector of pointers to entries in the ban list.
115+
108116
#### <code className="doc-symbol doc-symbol-method"/> add_ban [#endstone.ban.IpBanList.add_ban]
109117

110118
```python
@@ -118,14 +126,6 @@ add_ban(
118126

119127
Adds a ban to this list, or updates an existing one.
120128

121-
#### <code className="doc-symbol doc-symbol-attribute"/> entries [#endstone.ban.IpBanList.entries]
122-
123-
```python
124-
entries: list[IpBanEntry]
125-
```
126-
127-
Gets a vector of pointers to entries in the ban list.
128-
129129
#### <code className="doc-symbol doc-symbol-method"/> get_ban_entry [#endstone.ban.IpBanList.get_ban_entry]
130130

131131
```python
@@ -234,19 +234,19 @@ Represents a ban list containing banned players.
234234
</tr>
235235
</thead>
236236
<tbody>
237-
<tr key="add_ban">
237+
<tr key="1-add_ban">
238238
<td>[`add_ban`](#endstone.ban.PlayerBanList.add_ban)</td>
239239
<td>Adds a ban to this list, or updates an existing one.</td>
240240
</tr>
241-
<tr key="get_ban_entry">
241+
<tr key="2-get_ban_entry">
242242
<td>[`get_ban_entry`](#endstone.ban.PlayerBanList.get_ban_entry)</td>
243243
<td>Gets a BanEntry by player name, UUID, or XUID.</td>
244244
</tr>
245-
<tr key="is_banned">
245+
<tr key="3-is_banned">
246246
<td>[`is_banned`](#endstone.ban.PlayerBanList.is_banned)</td>
247247
<td>Checks if a BanEntry exists for the target by name, UUID, or XUID.</td>
248248
</tr>
249-
<tr key="remove_ban">
249+
<tr key="4-remove_ban">
250250
<td>[`remove_ban`](#endstone.ban.PlayerBanList.remove_ban)</td>
251251
<td>Removes a player from the ban list by name, UUID, or XUID.</td>
252252
</tr></tbody>
@@ -270,6 +270,14 @@ Represents a ban list containing banned players.
270270
</tr></tbody>
271271
</table>
272272

273+
#### <code className="doc-symbol doc-symbol-attribute"/> entries [#endstone.ban.PlayerBanList.entries]
274+
275+
```python
276+
entries: list[PlayerBanEntry]
277+
```
278+
279+
Gets a vector of pointers to entries in the ban list.
280+
273281
#### <code className="doc-symbol doc-symbol-method"/> add_ban [#endstone.ban.PlayerBanList.add_ban]
274282

275283
```python
@@ -285,14 +293,6 @@ add_ban(
285293

286294
Adds a ban to this list, or updates an existing one.
287295

288-
#### <code className="doc-symbol doc-symbol-attribute"/> entries [#endstone.ban.PlayerBanList.entries]
289-
290-
```python
291-
entries: list[PlayerBanEntry]
292-
```
293-
294-
Gets a vector of pointers to entries in the ban list.
295-
296296
#### <code className="doc-symbol doc-symbol-method"/> get_ban_entry [#endstone.ban.PlayerBanList.get_ban_entry]
297297

298298
```python

0 commit comments

Comments
 (0)