chore: code improvements and better naming

TheFruxz · Oct 22, 2022 · f9406cf · f9406cf
1 parent 51ad2ca
commit f9406cf
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 10 deletions.
diff --git a/src/main/kotlin/de/fruxz/sparkle/framework/effect/ComplexEffect.kt b/src/main/kotlin/de/fruxz/sparkle/framework/effect/ComplexEffect.kt
@@ -30,6 +30,4 @@ data class ComplexEffect(
 		effects += effect
 	}
 
-
-
 }
diff --git a/src/main/kotlin/de/fruxz/sparkle/framework/event/canvas/CanvasUpdateEvent.kt b/src/main/kotlin/de/fruxz/sparkle/framework/event/canvas/CanvasUpdateEvent.kt
@@ -1,6 +1,7 @@
 package de.fruxz.sparkle.framework.event.canvas
 
 import de.fruxz.sparkle.framework.visual.canvas.Canvas
+import de.fruxz.sparkle.framework.visual.canvas.Canvas.ExperimentalCanvasApi
 import net.kyori.adventure.key.Key
 import org.bukkit.entity.Player
 import org.bukkit.event.HandlerList
@@ -26,7 +27,9 @@ class CanvasUpdateEvent(
 	}
 
 	enum class UpdateReason {
-		PLUGIN, SCROLL, PAGE_TURN;
+		PLUGIN,
+		@ExperimentalCanvasApi SCROLL,
+		@ExperimentalCanvasApi PAGE_TURN;
 	}
 
 }
diff --git a/src/main/kotlin/de/fruxz/sparkle/framework/visual/canvas/Canvas.kt b/src/main/kotlin/de/fruxz/sparkle/framework/visual/canvas/Canvas.kt
@@ -359,6 +359,6 @@ open class Canvas(
 
 	@MustBeDocumented
 	@RequiresOptIn(message = "This api is still in development and may not work like expected and may change in the future")
-	annotation class CanvasPrototypeAPI
+	annotation class ExperimentalCanvasApi
 
 }
diff --git a/src/main/kotlin/de/fruxz/sparkle/framework/visual/canvas/MutableCanvas.kt b/src/main/kotlin/de/fruxz/sparkle/framework/visual/canvas/MutableCanvas.kt
@@ -79,7 +79,7 @@ data class MutableCanvas(
 	fun base(inventoryType: InventoryType) = base(Companion.ofType(inventoryType))
 
 	@CanvasDsl
-	@CanvasPrototypeAPI
+	@ExperimentalCanvasApi
 	fun pagination(pagination: PaginationType<*>) {
 		this.pagination = pagination
 	}

diff --git a/src/main/kotlin/de/fruxz/sparkle/framework/visual/canvas/PaginationType.kt b/src/main/kotlin/de/fruxz/sparkle/framework/visual/canvas/PaginationType.kt
@@ -7,7 +7,7 @@ import de.fruxz.sparkle.framework.extension.subNamespacedKey
 import de.fruxz.sparkle.framework.extension.sparkle
 import de.fruxz.sparkle.framework.extension.visual.ui.item
 import de.fruxz.sparkle.framework.extension.visual.ui.skull
-import de.fruxz.sparkle.framework.visual.canvas.Canvas.CanvasPrototypeAPI
+import de.fruxz.sparkle.framework.visual.canvas.Canvas.ExperimentalCanvasApi
 import de.fruxz.sparkle.framework.visual.canvas.PaginationType.Companion.PaginationBase.PAGED
 import de.fruxz.sparkle.framework.visual.canvas.PaginationType.Companion.PaginationBase.SCROLL
 import de.fruxz.sparkle.framework.visual.item.Item
@@ -36,7 +36,7 @@ interface PaginationType<C> {
 				override fun contentRendering(scrollState: Int, lines: Int, contents: Map<Int, ItemLike>) = contents
 			}
 
-		@CanvasPrototypeAPI
+		@ExperimentalCanvasApi
 		fun scroll(configuration: ScrollControlSetup = ScrollControlSetup()) =
 			object : PaginationType<ScrollControlSetup> {
 				override val base: PaginationBase = SCROLL
@@ -83,7 +83,7 @@ interface PaginationType<C> {
 				}
 			}
 
-		@CanvasPrototypeAPI
+		@ExperimentalCanvasApi
 		fun paged(configuration: PageControlSetup = PageControlSetup()) =
 			object : PaginationType<PageControlSetup> {
 				override val base: PaginationBase = PAGED

diff --git a/src/main/kotlin/de/fruxz/sparkle/server/interchange/PlaygroundInterchange.kt b/src/main/kotlin/de/fruxz/sparkle/server/interchange/PlaygroundInterchange.kt
@@ -11,7 +11,7 @@ import de.fruxz.sparkle.framework.extension.visual.ui.skull
 import de.fruxz.sparkle.framework.infrastructure.command.completion.buildInterchangeStructure
 import de.fruxz.sparkle.framework.infrastructure.command.completion.content.CompletionAsset
 import de.fruxz.sparkle.framework.infrastructure.command.structured.StructuredInterchange
-import de.fruxz.sparkle.framework.visual.canvas.Canvas.CanvasPrototypeAPI
+import de.fruxz.sparkle.framework.visual.canvas.Canvas.ExperimentalCanvasApi
 import de.fruxz.sparkle.framework.visual.canvas.PaginationType
 import de.fruxz.sparkle.framework.visual.canvas.buildCanvas
 import de.fruxz.sparkle.framework.visual.color.ColorType
@@ -96,7 +96,7 @@ internal class PlaygroundInterchange : StructuredInterchange("playground", build
 
 		}
 
-		val canvasScrollable = @OptIn(CanvasPrototypeAPI::class)
+		val canvasScrollable = @OptIn(ExperimentalCanvasApi::class)
 		buildCanvas {
 			label("<i>Hello!")
 			pagination(PaginationType.scroll())