Skip to content
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

Add a event for modify player's movement during using item #4112

Open
wants to merge 10 commits into
base: 1.21.1
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package net.fabricmc.fabric.api.entity.event.client;

import org.jetbrains.annotations.Nullable;

import net.minecraft.client.network.ClientPlayerEntity;

import net.fabricmc.fabric.api.event.Event;
import net.fabricmc.fabric.api.event.EventFactory;

public final class ClientPlayerEvents {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Does this also need to be handled on the server somewhere? E.g if I wanted to increase the players speed?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to make any changes on the server, as all information related to movement speed is processed on the client and sent to the server. We only need to modify the movement speed on the client. In the test mod, if you want to increase the player's speed, you only need to modify the multiplier coefficient. If you have any thoughts or additional comments, please let me know with more detailed information.

/**
* An event that is called when a player is moving during using an item.
*/
public static final Event<AdjustUsingItemSpeed> ADJUST_USING_ITEM_SPEED = EventFactory.createArrayBacked(AdjustUsingItemSpeed.class, callbacks -> player -> {
Float maxSpeedPercentage = null;

for (AdjustUsingItemSpeed callback : callbacks) {
Float speedPercentage = callback.adjustUsingItemSpeed(player);

if (speedPercentage != null) {
maxSpeedPercentage = maxSpeedPercentage == null ? speedPercentage : Math.max(speedPercentage, maxSpeedPercentage);
}
}

return maxSpeedPercentage;
});

@FunctionalInterface
public interface AdjustUsingItemSpeed {
/**
* Called when a player is moving during using an item.
*
* @param player the player is moving during using an item.
* @return a Float representing the speed adjustment as a percentage (e.g., 0.8 for 80% speed),
* or {@code null} indicates that no adjustment should be applied.
*/
@Nullable
Float adjustUsingItemSpeed(ClientPlayerEntity player);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package net.fabricmc.fabric.mixin.client.entity.event;

import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;

import net.minecraft.client.network.ClientPlayerEntity;

import net.fabricmc.fabric.api.entity.event.client.ClientPlayerEvents;

@Mixin(ClientPlayerEntity.class)
abstract class ClientPlayerMixin {
@Inject(method = "tickMovement", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/network/ClientPlayerEntity;isUsingItem()Z"))
private void invokeAdjustUsingItemSpeedEvent(CallbackInfo ci) {
ClientPlayerEntity player = (ClientPlayerEntity) (Object) this;

if (player.isUsingItem() && !player.hasVehicle() && (player.input.movementForward != 0.0F || player.input.movementSideways != 0.0F)) {
Float speedPercentage = ClientPlayerEvents.ADJUST_USING_ITEM_SPEED.invoker().adjustUsingItemSpeed(player);

if (speedPercentage != null) {
player.input.movementSideways *= speedPercentage * 5.0F;
player.input.movementForward *= speedPercentage * 5.0F;
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"package": "net.fabricmc.fabric.mixin.client.entity.event",
"compatibilityLevel": "JAVA_17",
"client": [
"elytra.ClientPlayerEntityMixin"
"elytra.ClientPlayerEntityMixin",
"ClientPlayerMixin"
],
"injectors": {
"defaultRequire": 1,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,47 @@

package net.fabricmc.fabric.test.entity.event.client;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import net.minecraft.entity.EquipmentSlot;
import net.minecraft.item.Items;

import net.fabricmc.api.ClientModInitializer;
import net.fabricmc.fabric.api.client.rendering.v1.LivingEntityFeatureRenderEvents;
import net.fabricmc.fabric.api.entity.event.client.ClientPlayerEvents;
import net.fabricmc.fabric.test.entity.event.EntityEventTests;

public class EntityEventTestsClient implements ClientModInitializer {
private static final Logger LOGGER = LoggerFactory.getLogger(EntityEventTestsClient.class);

@Override
public void onInitializeClient() {
LivingEntityFeatureRenderEvents.ALLOW_CAPE_RENDER.register(player -> {
return !player.getEquippedStack(EquipmentSlot.CHEST).isOf(EntityEventTests.DIAMOND_ELYTRA);
});

ClientPlayerEvents.ADJUST_USING_ITEM_SPEED.register(player -> {
if (player.getMainHandStack().isOf(Items.BOW) && player.getEquippedStack(EquipmentSlot.FEET).isOf(Items.LEATHER_BOOTS)) {
LOGGER.info("Player {} can move with normal speed becase of leather boots on feet.", player);
return 1.0F;
}

if (player.getMainHandStack().isOf(Items.BOW) && player.getEquippedStack(EquipmentSlot.FEET).isOf(Items.IRON_BOOTS)) {
LOGGER.info("Player {} can't move during using bow becase of iron boots on feet.", player);
return 0.0F;
}

return null;
});

ClientPlayerEvents.ADJUST_USING_ITEM_SPEED.register(player -> {
if (player.getMainHandStack().isOf(Items.BOW) && player.getOffHandStack().isOf(Items.FEATHER)) {
LOGGER.info("Player {} can move with half speed becase of feather in offhand.", player);
return 0.5F;
}

return null;
});
}
}