-
Notifications
You must be signed in to change notification settings - Fork 24
feat(ModuleNotifier): Add Module to get feedback in chat when modules toggle #258
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.
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
IceTank
wants to merge
3
commits into
lambda-client:1.21.11
Choose a base branch
from
IceTank:feature/module/module-notifyer
base: 1.21.11
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Copyright 2026 Lambda | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.lambda.event.events | ||
|
|
||
| import com.lambda.event.Event | ||
| import com.lambda.event.callback.Cancellable | ||
| import com.lambda.event.callback.ICancellable | ||
| import com.lambda.module.Module | ||
|
|
||
| /** | ||
| * Represents events related to toggling, enabling, and disabling of [Module]s. | ||
| * | ||
| * @see Toggle | ||
| * @see Enabled | ||
| * @see Disabled | ||
| */ | ||
| sealed class ModuleEvent { | ||
| /** | ||
| * Event that fires before a [Module] is toggled, allowing listeners to cancel the toggle. | ||
| * @property module The module that is being toggled. | ||
| * @property newValue The value that the module is being toggled to (true for enabling, false for disabling). | ||
| * @see Enabled | ||
| * @see Disabled | ||
| */ | ||
| data class Toggle(val module: Module, val newValue: Boolean) : Event, ICancellable by Cancellable() | ||
|
|
||
| /** | ||
| * Event that fires before a [Module] is enabled, allowing listeners to cancel the enable. | ||
| * @property module The module that is being enabled. | ||
| * @see Toggle | ||
| */ | ||
| data class Enabled(val module: Module) : Event, ICancellable by Cancellable() | ||
|
|
||
| /** | ||
| * Event that fires before a [Module] is disabled, allowing listeners to cancel the disable. | ||
| * @property module The module that is being disabled. | ||
| * @see Toggle | ||
| */ | ||
| data class Disabled(val module: Module) : Event, ICancellable by Cancellable() | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
src/main/kotlin/com/lambda/module/modules/client/ModuleNotifier.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* | ||
| * Copyright 2026 Lambda | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.lambda.module.modules.client | ||
|
|
||
| import com.lambda.event.events.ModuleEvent | ||
| import com.lambda.event.listener.SafeListener.Companion.listen | ||
| import com.lambda.module.Module | ||
| import com.lambda.threading.runSafe | ||
| import com.lambda.util.Communication.log | ||
| import com.lambda.util.Describable | ||
| import com.lambda.util.NamedEnum | ||
| import net.minecraft.text.Text | ||
| import net.minecraft.util.Colors | ||
|
|
||
| object ModuleNotifier : Module( | ||
| name = "ModuleNotifier", | ||
| description = "Notifies you when a module is enabled or disabled", | ||
| tag = com.lambda.module.tag.ModuleTag.CLIENT | ||
|
IceTank marked this conversation as resolved.
Outdated
|
||
| ) { | ||
| var notifyTarget by setting("Notify Target", setOf<NotifyTarget>(NotifyTarget.ActionBar), NotifyTarget.entries.toSet(), description = "Where to send notifications when modules are toggled") | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i'd add params to the enum rather than using a collection setting here. One boolean for chat, and one for actionBar. Then have a third enum selection for Both, which sets true for both. Then just check if the enum has the value set to true for whatever youre testing |
||
|
|
||
| enum class NotifyTarget(override val displayName: String, override val description: String) : Describable, NamedEnum { | ||
| Chat("Chat", "Sends a message to chat when a module is toggled"), | ||
| ActionBar("Action Bar", "Sends a message to the action bar when a module is toggled"),; | ||
| } | ||
|
|
||
| init { | ||
| listen<ModuleEvent.Enabled> { | ||
| runSafe { | ||
| logToTargets(Text.literal("on").withColor(Colors.GREEN)) | ||
|
IceTank marked this conversation as resolved.
Outdated
|
||
| } | ||
| } | ||
|
|
||
| listen<ModuleEvent.Disabled> { | ||
| runSafe { | ||
| logToTargets(Text.literal("off").withColor(Colors.RED)) | ||
| } | ||
| } | ||
|
|
||
| listen<ModuleEvent.Toggle> { | ||
| runSafe { | ||
| val newState = if (it.newValue) "on" else "off" | ||
| val color = if (it.newValue) Colors.GREEN else Colors.RED | ||
| val message = Text.literal(newState).withColor(color) | ||
| logToTargets(message) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun logToTargets(message: Text) { | ||
| if (notifyTarget.contains(NotifyTarget.Chat)) { | ||
|
IceTank marked this conversation as resolved.
Outdated
|
||
| log(message, source = name) | ||
| } | ||
| if (notifyTarget.contains(NotifyTarget.ActionBar)) { | ||
| log(message, source = name, inGameOverlay = true) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the kt docs here are pretty self explanatory; can honestly just remove them for this class / child classes