RideYourHook v1.0 - Chat

# #######################################
# #### RideYourHook v1.0 by rePeteGG ####
# #######################################



# #### Variables
On Script Load:
	set {rideyourhook.style} to "&6&o" # This is how the item name will be displayed. Standard is orange & italic.
	set {rideyourhook.name} to "Rider's Fishing Rod" # How the Fishing Rod will be named. Obviously.

# #### Debug settings
	set {skript.logging} to true # Logs actions from this skript to a log file.
	set {skript.logging.msg} to true # Logs actions from this skript live to console.

function func_logging(prefix: text, message: text, file: text):
	if {skript.logging} is true:
		log "[%{_prefix}%] %{_message}%" to "%{_file}%"
	if {skript.logging.msg} is true:
		message "[%{_prefix}%] %{_message}%" to console



# #### Command to spawn the special Fishing Rod.
command /rideyourhook:
	aliases: /ryh
	executable by: players
	trigger:
		player has permission "skript.rideyourhook":
			give player fishing rod named "%{rideyourhook.style}%%{rideyourhook.name}%"
			func_logging("%{rideyourhook.name}%", "Successfully gave %{rideyourhook.name}% to %player%.", "RideYourHook.log")



# #### Functionality
On Shoot:
	shooter is holding fishing rod
	display name of shooter's tool is "%{rideyourhook.style}%%{rideyourhook.name}%":
		set {_difference} to difference between {rideyourhook.cooldown.%shooter%} and now # Checks wether the cooldown is done or not.
		if {_difference} < 8 seconds: # Stops the code if the cooldown is not done. Set this to any value you like. 1 minute, 20 seconds, whatever. Just be advised that the cooldown is not saved between server restarts.
			func_logging("%{rideyourhook.name}%", "%shooter% tried to ride his hook but his cooldown was not ready.", "RideYourHook.log")
			stop trigger
		else:
			set {rideyourhook.proj.%projectile%} to projectile # saves the just launched hook projectile in a variable to be called later for the ride.
			if {rideyourhook.riding.%shooter%} is not set: # This variable is only true if the player is already riding a hook projectile. If that is the case, code will not attempt to ride another projectile.
				wait 1 ticks
				loop entities in radius 16 around shooter:
					loop-entity is {rideyourhook.proj.%projectile%}:
						make shooter ride loop-entity
						damage shooter's tool by 2 # Fishing rod has a durability of 64. By damaging the tool by 2 on every successful use you can use the rod 32 times.
						wait 1 tick
						if shooter is not riding loop-entity:
							func_logging("%{rideyourhook.name}%", "Something went wrong. %shooter% couldn't be placed on his hook. Maybe he/she was moving too fast when firing the hook or it lagged.", "RideYourHook.log")
							stop trigger
						else:
							set {rideyourhook.riding.%shooter%} to true # Flags the player as "riding a hook." This is needed for the "On Damage:" Event below.
							set {rideyourhook.cooldown.%shooter%} to now # Resets the cooldown.
							set {_counter} to 8 + 1 # Whatever you set for the cooldown a few lines above, set the same amount of time in seconds here. (Don't mind the + 1, its there to make the messages look better.)
							func_logging("%{rideyourhook.name}%", "%shooter% was successfully put on his hook, riding flag was set, cooldown started.", "RideYourHook.log")

			while {_counter} > 1: # Sends the cooldown every second to the player as a fancy "action-bar".
				subtract 1 from {_counter}
				message "%{rideyourhook.style}%Cooldown: %{_counter}%" to shooter
				wait 1 second
				if {_counter} = 1:
					delete {rideyourhook.cooldown.%shooter%} # Cleans up the variables file a bit.
					func_logging("%{rideyourhook.name}%", "The cooldown of %shooter% expired.", "RideYourHook.log")

On Fishing: # AFAIK this event is called if player right clicks with a fishing rod and "reels in" the hook. This code kills the "riding a hook" flag of the player when he right clicks while riding the hook.
	player is holding fishing rod
	display name of tool is "%{rideyourhook.style}%%{rideyourhook.name}%":
		if {rideyourhook.riding.%player%} is true:
			delete {rideyourhook.riding.%player%}
			func_logging("%{rideyourhook.name}%", "The riding flag of %player% was successfully deleted due to right click while riding. (Variable: rideyourhook.riding.%player%)", "RideYourHook.log")

On tool change: # Since it is possible to despawn the hook+string by changing a tool this part makes sure that if you change your tool during a ride it removes your "riding a hook" flag.
	if tool is fishing rod: # to prevent this code to be fired EVERY time someone changes his tool this part checks wether the player switched TO the special fishing rod before firing the code that deletes the variables.
		display name of tool is "%{rideyourhook.style}%%{rideyourhook.name}%"
		set {rideyourhook.changetool.%player%} to true
		func_logging("%{rideyourhook.name}%", "%player% changed tool to %{rideyourhook.name}%.", "rideyourhook.log")
		stop
	if tool is not fishing rod named "%{rideyourhook.style}%%{rideyourhook.name}%":
		{rideyourhook.changetool.%player%} is true
		delete {rideyourhook.riding.%player%}
		delete {rideyourhook.changetool.%player%}
		func_logging("%{rideyourhook.name}%", "%player% changed away from %{rideyourhook.name}%. The riding flag of %player% was successfully deleted. (Variable: rideyourhook.riding.%player%)", "RideYourHook.log")

On Damage: # Prevents a bug where when you mount your hook in survival mode, you get damage and the hook starts pushing you up in the air infintely.
	victim is holding fishing rod
	display name of victim's tool is "%{rideyourhook.style}%%{rideyourhook.name}%"
	{rideyourhook.riding.%victim%} is set
	damage cause is not contact, attack, projectile, suffocation, fire, burning, melting, lava, drowning, block explosion, entity explosion, void, lightning, suicide, starvation, poison, potion, wither, falling block, thorns or unknown: # Since the damage the hook doing is seemingly not in the damage cause list that skript supports, this is needed. It excludes all damage causes that ARE supported and prevents damage from the fishing hook. As a bonus i took out fall damage, so as long as you ride a hook, you don't take fall damage.
		cancel event
		func_logging("%{rideyourhook.name}%", "Hook damage to %victim% was successfully prevented. (This message will appear multiple times per use.)", "RideYourHook.log")

On Projectile Hit: # Dismounts the player from the hook when it hits a block. Also minimizes how often you dismount halfway into the block below you.
	shooter is holding fishing rod
	display name of shooter's tool is "%{rideyourhook.style}%%{rideyourhook.name}%"
	if projectile is {rideyourhook.proj.%projectile%}:
		set {_block} to the block at location 0.5 beneath the projectile
		if {_block} is not air:
			eject passenger from {rideyourhook.proj.%projectile%}
			wait 1 tick
			delete {rideyourhook.proj.%projectile%}
			delete {rideyourhook.riding.%shooter%}
			func_logging("%{rideyourhook.name}%", "%shooter% was dismounted due to hook hitting a block. The riding flag of %shooter% was successfully deleted. (Variable: shamanrod.riding.%shooter%)", "RideYourHook.log")