Add a event for modify player's movement during using item #4112
Conversation
|
|
||
| public final class ClientPlayerEvents { | ||
| /** | ||
| * An event that is called when a player is moving during using an item. |
There was a problem hiding this comment.
Question: Whats an example usecase?
There was a problem hiding this comment.
For example, a mod may wish to adjust or disable the slowdown when a player is using the mod's custom bow.
| import net.fabricmc.fabric.api.event.Event; | ||
| import net.fabricmc.fabric.api.event.EventFactory; | ||
|
|
||
| public final class ClientPlayerEvents { |
There was a problem hiding this comment.
Question: Does this also need to be handled on the server somewhere? E.g if I wanted to increase the players speed?
There was a problem hiding this comment.
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.
| if (player.getMainHandStack().isOf(Items.BOW) && player.getEquippedStack(EquipmentSlot.FEET).isOf(Items.DIAMOND_BOOTS)) { | ||
| LOGGER.info("Player {} can move without slowdown becase of diamond boots on feet.", player); | ||
| player.input.movementForward *= 5F; | ||
| player.input.movementSideways *= 5F; |
There was a problem hiding this comment.
So this PR, if you want to prevent slowdown, you multiply the move speed by 5? Uhhhhhhhhh
Have you considered what happens if two mods’s condition passes for trying to turn off the move speed? The two multiplying will end up causing the player to move 5 times as fast.
This PR is not suitable for multiple mods trying to turn off item use slowdown. It will need a rethinking
There was a problem hiding this comment.
Got it, I will try as soon as possible. Thank you!
There was a problem hiding this comment.
I changed the event to DISABLE_USINGITEM_SLOWDOWN. When the return value is true, the player can move without being slowed down, which will also resolve the issue of multiple mods affecting this simultaneously.
fishshi
changed the title
fishshi
changed the title
|
Description: |
| for (AdjustUsingItemSpeed callback : callbacks) { | ||
| float currentSpeed = callback.adjustUsingItemSpeed(player); | ||
|
|
||
| if (currentSpeed >= 0.0F && currentSpeed <= 1.0F) { |
There was a problem hiding this comment.
why is the speed capped at 1.0?
There was a problem hiding this comment.
On a similar note, why doesn't it accept speeds below zero? Is it just because of the -1.0F fallback or do negative values crash the game? If it's the former, consider allowing negative values after changing the fallback to @Nullable Float. If it's the latter, consider adding a comment to document why negative values would break stuff.
There was a problem hiding this comment.
Since this event is used to adjust the player's movement speed while using items, a value of 0 means the player's speed is already 0. A value of 1 means the player will maintain their original movement speed without any slowdown.
When the value is negative, it implies that the player will actually move backward when trying to move forward, which is counterintuitive. Therefore, negative values are not needed.
When the value is greater than 1, it can be understood as the player moving faster while using an item. I'm currently questioning whether this is even necessary.
There was a problem hiding this comment.
Personally, I find it perfectly intuitive that negative speed would move you backwards. Do we really ever know that this functionality will not be necessary for any current or future mod? It just seems like an artificial limit to me.
If it requires extra effort to make these values work, that would be a different story. But given that it seems to just work without the limit, I think we might as well remove the limit and give modders the flexibility to use crazy values if they want to.
There was a problem hiding this comment.
Thank you! I understand, and I will remove this limit.
| /* | ||
| * Flag for using default slowdown during using an item. | ||
| */ | ||
| public static final float USE_DEFAULT_SLOWDOWN_SPEED = -1.0F; |
There was a problem hiding this comment.
change the return type of the interface to @Nullable Float instead of using this
There was a problem hiding this comment.
This is indeed a good idea. Thank you!
| float currentSpeed = callback.adjustUsingItemSpeed(player); | ||
|
|
||
| if (currentSpeed >= 0.0F && currentSpeed <= 1.0F) { | ||
| maxSpeed = currentSpeed > maxSpeed ? currentSpeed : maxSpeed; |
There was a problem hiding this comment.
Thank you! I’ve made the changes.
| @Mixin(ClientPlayerEntity.class) | ||
| abstract class ClientPlayerMixin { | ||
| @Inject(method = "tickMovement", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/network/ClientPlayerEntity;isUsingItem()Z")) | ||
| private void beforeTickMovement(CallbackInfo ci) { |
There was a problem hiding this comment.
| private void beforeTickMovement(CallbackInfo ci) { | |
| private void invokeAdjustUsingItemSpeedEvent(CallbackInfo ci) { |
There was a problem hiding this comment.
Thank you! I’ve made the changes.
|
What do you think about naming it |
Sorry, my English level is not very high, so I can't be sure which name is better. Can anyone else provide a bit more advice? |
fishshi
changed the title
Fixes #4103
Add a event for modify player's movement during using item.
The event ADJUST_USING_ITEM_SPEED is used to adjust a player's movement speed while using an item. It allows mods to modify the player's movement speed based on specific conditions when they are using a item.
When a player is moving while using an item, the movement speed can be modified based on various conditions. The return value is a float representing the speed adjustment percentage (e.g., 0.8 for 80% of the original speed). If it returns null, it means there is no speed adjustment. Among multiple speeds, the maximum value is taken.