Merge changes to master --release

build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "com.github.shynixn"
-version = "9.13.1"
+version = "9.14.0"
 
 repositories {
     mavenCentral()

docs/wiki/docs/template.md

@@ -23,8 +23,12 @@ Events define what actions to execute on certain events.
 The following events are supported:
 
 * leftClick
+* leftClickSneak
 * rightClick
+* rightClickSneak
 * ridingSneak
+* spawn
+* despawn
 
 For example the ``leftClick`` event gets executed when a player left-clicks on the pet. However, it may not be the owner, who clicks on a pet, therefore you need
 to check if the player is the owner first as a condition.

src/main/java/com/github/shynixn/petblocks/impl/PetEntityImpl.kt

@@ -19,7 +19,6 @@ import com.github.shynixn.petblocks.contract.Pet
 import com.github.shynixn.petblocks.contract.PetActionExecutionService
 import com.github.shynixn.petblocks.entity.PetMeta
 import com.github.shynixn.petblocks.enumeration.DropType
-import com.github.shynixn.petblocks.enumeration.PetVisibility
 import com.github.shynixn.petblocks.exception.PetBlocksPetDisposedException
 import com.github.shynixn.petblocks.impl.physic.ArmorstandEntityComponent
 import com.github.shynixn.petblocks.impl.physic.MathComponent
@@ -229,6 +228,32 @@ class PetEntityImpl(
         }
     }
 
+    /**
+     * Spawn is initiated.
+     */
+    fun onSpawn(player: Player){
+        cancellationTokenLongRunning.isCancelled = true
+        val spawnEvent = pet.template.events["spawn"]
+        if (spawnEvent != null) {
+            plugin.launch(plugin.minecraftDispatcher + object : CoroutineTimings() {}) {
+                petActionExecutionService.executeAction(player, pet, spawnEvent, CancellationToken())
+            }
+        }
+    }
+
+    /**
+     * Despawn is initiated.
+     */
+    fun onDespawn(player: Player){
+        cancellationTokenLongRunning.isCancelled = true
+        val despawnEvent = pet.template.events["despawn"]
+        if (despawnEvent != null) {
+            plugin.launch(plugin.minecraftDispatcher + object : CoroutineTimings() {}) {
+                petActionExecutionService.executeAction(player, pet, despawnEvent, CancellationToken())
+            }
+        }
+    }
+
     /**
      * Moves to the given location.
      */

src/main/java/com/github/shynixn/petblocks/impl/PetImpl.kt

@@ -46,9 +46,7 @@ class PetImpl(
             // Remove pet if the player does not have any spawn permission.
             while (!isDisposed) {
                 if (!player.hasPermission(Permission.SPAWN.text)) {
-                    petEntity?.remove()
-                    petEntity = null
-                    petMeta.isSpawned = false
+                    remove()
                 }
 
                 delay(5000)
@@ -317,8 +315,7 @@ class PetImpl(
             val petWorld = location.world
 
             if (playerWorld != petWorld) {
-                petEntity!!.remove()
-                petEntity = null
+                remove()
             }
         }
 
@@ -368,6 +365,7 @@ class PetImpl(
             return
         }
 
+        petEntity!!.onDespawn(player)
         petEntity!!.remove()
         petEntity = null
         petMeta.isSpawned = false
@@ -394,7 +392,7 @@ class PetImpl(
 
         petEntity = petEntityFactory.createPetEntity(this, petMeta)
         petMeta.isSpawned = true
-
+        petEntity?.onSpawn(player)
 
         plugin.launch {
             if (petMeta.ridingState == PetRidingState.HAT) {

src/main/resources/pets/pet_classic.yml

@@ -98,7 +98,7 @@ events:
         run:
           - "/petblocks velocity %petblocks_pet_name% %petblocks_js_jsonKnockback_x% 0.2 %petblocks_js_jsonKnockback_z% %petblocks_eventPlayer_name%"
   leftClickSneak:
-    actions:  # You can add/remove actions as you want here.
+    actions: # You can add/remove actions as you want here.
       - name: "Open the pet GUI"
         condition:
           type: STRING_EQUALS
@@ -110,7 +110,7 @@ events:
           - "/petblocks select %petblocks_pet_name%"
           - "/petblock"
   rightClick:
-    actions:  # You can add/remove actions as you want here.
+    actions: # You can add/remove actions as you want here.
       - name: "Start riding pet"
         condition:
           type: STRING_EQUALS
@@ -121,7 +121,7 @@ events:
         run:
           - "/petblocks ride %petblocks_pet_name%"
   rightClickSneak:
-    actions:  # You can add/remove actions as you want here.
+    actions: # You can add/remove actions as you want here.
       - name: "Open the pet GUI"
         condition:
           type: STRING_EQUALS
@@ -140,6 +140,16 @@ events:
         level: "PLAYER"
         run:
           - "/petblocks unmount %petblocks_pet_name%"
+  spawn:
+    actions:
+      - name: "Delay Action"
+        type: "DELAY"
+        ticks: 20
+  despawn:
+    actions:
+      - name: "Delay Action"
+        type: "DELAY"
+        ticks: 20
 
 #
 # Defines the action a pet should perform in an interval on its own.

src/main/resources/pets/pet_flying_dolphin.yml

@@ -140,6 +140,16 @@ events:
         level: "PLAYER"
         run:
           - "/petblocks unmount %petblocks_pet_name%"
+  spawn:
+    actions:
+      - name: "Delay Action"
+        type: "DELAY"
+        ticks: 20
+  despawn:
+    actions:
+      - name: "Delay Action"
+        type: "DELAY"
+        ticks: 20
 
 #
 # Defines the action a pet should perform in an interval on its own.

src/main/resources/pets/pet_mining.yml

@@ -129,6 +129,16 @@ events:
         level: "PLAYER"
         run:
           - "/petblocks unmount %petblocks_pet_name%"
+  spawn:
+    actions:
+      - name: "Delay Action"
+        type: "DELAY"
+        ticks: 20
+  despawn:
+    actions:
+      - name: "Delay Action"
+        type: "DELAY"
+        ticks: 20
 
 #
 # Defines the action a pet should perform in an interval on its own.

src/main/resources/plugin-legacy.yml

@@ -1,5 +1,5 @@
 name: PetBlocks
-version: 9.13.1
+version: 9.14.0
 author: Shynixn
 main: com.github.shynixn.petblocks.PetBlocksPlugin
 softdepend: [ PlaceholderAPI, HeadDatabase]

src/main/resources/plugin.yml

@@ -1,5 +1,5 @@
 name: PetBlocks
-version: 9.13.1
+version: 9.14.0
 author: Shynixn
 main: com.github.shynixn.petblocks.PetBlocksPlugin
 softdepend: [ PlaceholderAPI, HeadDatabase]