Skip to content

Commit 65584c7

Browse files
committed
Add RegisterTagEvent
1 parent f4c5d8b commit 65584c7

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ tasks {
146146
exclude("org/spongepowered/api/event/lifecycle/RegisterBuilderEvent.java")
147147
exclude("org/spongepowered/api/event/lifecycle/RegisterRegistryEvent.java")
148148
exclude("org/spongepowered/api/event/lifecycle/RegisterRegistryValueEvent.java")
149+
exclude("org/spongepowered/api/event/lifecycle/RegisterTagEvent.java")
149150
exclude("org/spongepowered/api/event/lifecycle/RegisterCommandEvent.java")
150151
exclude("org/spongepowered/api/event/lifecycle/RegisterFactoryEvent.java")
151152
exclude("org/spongepowered/api/event/lifecycle/RegisterWorldEvent.java")
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
/*
2+
* This file is part of SpongeAPI, licensed under the MIT License (MIT).
3+
*
4+
* Copyright (c) SpongePowered <https://www.spongepowered.org>
5+
* Copyright (c) contributors
6+
*
7+
* Permission is hereby granted, free of charge, to any person obtaining a copy
8+
* of this software and associated documentation files (the "Software"), to deal
9+
* in the Software without restriction, including without limitation the rights
10+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
* copies of the Software, and to permit persons to whom the Software is
12+
* furnished to do so, subject to the following conditions:
13+
*
14+
* The above copyright notice and this permission notice shall be included in
15+
* all copies or substantial portions of the Software.
16+
*
17+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23+
* THE SOFTWARE.
24+
*/
25+
package org.spongepowered.api.event.lifecycle;
26+
27+
import org.spongepowered.api.registry.DefaultedRegistryReference;
28+
import org.spongepowered.api.registry.RegistryKey;
29+
import org.spongepowered.api.tag.Tag;
30+
31+
import java.util.function.BiPredicate;
32+
import java.util.function.Consumer;
33+
import java.util.function.Predicate;
34+
35+
/**
36+
* Lifecycle event for applying modifications to {@link Tag tags}.
37+
*
38+
* <p>This event provides mechanism for plugins to <strong>propose</strong>
39+
* changes to the tags that are processed during tag construction.</p>
40+
*
41+
* <p>The following chain of events take place during tag construction:</p>
42+
* <ul>
43+
* <li>Tags are merged from data packs</li>
44+
* <li>Append proposed tags</li>
45+
* <li>Apply filter to ALL present tags</li>
46+
* <li>Remaining items makes up the final tag</li>
47+
* </ul>
48+
*/
49+
public interface RegisterTagEvent extends LifecycleEvent {
50+
51+
<T> TagStep<T> tag(Tag<T> tag);
52+
53+
interface TagStep<T> {
54+
55+
default TagStep<T> delete() {
56+
return this.filter($ -> false);
57+
}
58+
59+
TagStep<T> filter(Predicate<DefaultedRegistryReference<T>> predicate);
60+
61+
default TagStep<T> filterTags(Predicate<Tag<T>> predicate) {
62+
return this.filterTags((t, k) -> predicate.test(t));
63+
}
64+
65+
TagStep<T> filterTags(BiPredicate<Tag<T>, DefaultedRegistryReference<T>> predicate);
66+
67+
TagStep<T> append(RegistryKey<T> key);
68+
69+
TagStep<T> append(Tag<T> tag);
70+
71+
TagStep<T> test(Predicate<DefaultedRegistryReference<T>> predicate, Consumer<TagStep<T>> consumer);
72+
73+
default TagStep<T> testTags(Predicate<Tag<T>> predicate, Consumer<TagStep<T>> consumer) {
74+
return this.testTags((t, k) -> predicate.test(t), consumer);
75+
}
76+
77+
TagStep<T> testTags(BiPredicate<Tag<T>, DefaultedRegistryReference<T>> predicate, Consumer<TagStep<T>> consumer);
78+
}
79+
}

0 commit comments

Comments
 (0)