Skip to content

Adding documentation for undocumented events #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Adding documentation for undocumented events #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da5fed0
New page for BlockEvents.broken event
undeadf0x Aug 9, 2025
a509948
Fix some stuff for blockevent.broken
undeadf0x Aug 10, 2025
bf995ae
yet another fix, accidentally named it page.kubejsdoc instead of kubedoc
undeadf0x Aug 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions wiki/events/BlockEvents/broken/meta.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
title: "BlockEvents.broken"
description: "Called when block broken by player"
script: "common"
event-result: true
11 changes: 11 additions & 0 deletions wiki/events/BlockEvents/broken/page.kubedoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
This event is triggered whenever a block is broken.

Here's an example, where whenever the user breaks a block, they will see "(username) broke (block)" in the chat.

```js
BlockEvents.broken(event => {
event.player.tell(`${event.getEntity().getName().getString()} broke a ${event.getBlock()}`)
})
```

To get the player that broke a block, use the method `getEntity()`, to get the block that was broken, use the method `getBlock()`