Add SteerVehicleEvent #3421

avaruus1 · 2021-06-06T21:06:58Z

Added SteerVehicleEvent. Resolves SpongePowered/SpongeAPI#2283

While having the event be cancellable would be ideal, I’m not sure how that could be done or if it’s even possible, since Mojang changed the client to handle dismounting fully client-side in 1.16.

Regardless of that, I hope this event makes it to API-8, since I believe it would be of great use when creating vehicle plugins.

dualspiral · 2021-06-06T21:11:09Z

Gonna need an API PR too!

gabizou · 2021-06-07T00:28:11Z

src/mixins/resources/mixins.sponge.core.json

+    "core.RegistryAccessMixin",
+    "core.Vec3iMixin",
+    "core.dispenser.AbstractProjectileDispenseBehaviorMixin",
+    "data.SpongeDataHolderMixin",


Don't change the formatting here on a whim please.

Not exactly sure how I managed to do that, but it should be fixed now 😅

gabizou · 2021-06-07T00:28:39Z

...xins/java/org/spongepowered/common/mixin/core/network/ServerGamePacketListenerImplMixin.java

+
+    @Inject(method = "handlePlayerInput", at = @At("HEAD"))
+    public void onHandlePlayerInput(ServerboundPlayerInputPacket packet, CallbackInfo ci) {
+        SpongeCommon.postEvent(SpongeEventFactory.createSteerVehicleEvent(


Is the event cancellable? If so, you can make the injection cancellable

Pre 1.16 that would work fine, but that is not the case in newer vesions since dismounting is handled fully client-side.

gabizou · 2021-06-07T00:29:00Z

...xins/java/org/spongepowered/common/mixin/core/network/ServerGamePacketListenerImplMixin.java

+    @Shadow public ServerPlayer player;
+
+    @Inject(method = "handlePlayerInput", at = @At("HEAD"))
+    public void onHandlePlayerInput(ServerboundPlayerInputPacket packet, CallbackInfo ci) {


Make these variables final please

Suggested change

public void onHandlePlayerInput(ServerboundPlayerInputPacket packet, CallbackInfo ci) {

public void onHandlePlayerInput(final ServerboundPlayerInputPacket packet, final CallbackInfo ci) {

gabizou · 2021-06-07T00:29:45Z

...xins/java/org/spongepowered/common/mixin/core/network/ServerGamePacketListenerImplMixin.java

+    @Inject(method = "handlePlayerInput", at = @At("HEAD"))
+    public void onHandlePlayerInput(ServerboundPlayerInputPacket packet, CallbackInfo ci) {
+        SpongeCommon.postEvent(SpongeEventFactory.createSteerVehicleEvent(
+                PhaseTracker.getCauseStackManager().currentCause(),


Is it guaranteed that we'll always be on the main thread here?

dualspiral · 2021-06-09T19:57:45Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

+
+    @Inject(method = "setPlayerInput", at = @At("HEAD"))
+    public void onSetPlayerInput(final float sway, final float surge, final boolean jumping, final boolean dismount, final CallbackInfo ci) {
+        SpongeCommon.postEvent(SpongeEventFactory.createSteerVehicleEvent(


This is going to fire if the Player Input Packet is sent, regardless of whether the player is actually mounted. It would make more sense to redirect isPassenger and fire there if isPassenger would return true. You could then return false if you wanted to cancel this packet, which kind of leads me into my next question:

Pre 1.16 that would work fine, but that is not the case in newer vesions since dismounting is handled fully client-side.

...how does that make sense? The server still has to know about this and validate it. Is it because the client dismounts without validation from the server?

(I'll test it at some point, just haven't looked into it yet)

This is going to fire if the Player Input Packet is sent, regardless of whether the player is actually mounted. It would make more sense to redirect isPassenger and fire there if isPassenger would return true.

That's probably a good idea 😅

Is it because the client dismounts without validation from the server?

That's exactly what I meant! Sorry for being unclear.

dualspiral · 2021-08-08T20:01:58Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

@@ -830,6 +831,30 @@ public void sendMessage(final net.minecraft.network.chat.Component p_241151_1_,
            }
        }
    }
+
+    @Inject(method = "setPlayerInput", at = @At("HEAD"), cancellable = true)


This should be a redirect on isPassenger, so you can avoid calling it twice, and just return false here to short circuit the if statement.

dualspiral · 2021-08-08T20:02:15Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

@@ -830,6 +831,30 @@ public void sendMessage(final net.minecraft.network.chat.Component p_241151_1_,
            }
        }
    }
+
+    @Inject(method = "setPlayerInput", at = @At("HEAD"), cancellable = true)
+    public void onSetPlayerInput(final float sway, final float surge, final boolean jumping, final boolean dismount, final CallbackInfo ci) {


private boolean impl$onSetPlayerInput(final ServerPlayer player, final float sway, final float surge, final boolean jumping, final boolean dismount)

dualspiral · 2021-08-08T20:04:07Z

src/mixins/java/org/spongepowered/common/mixin/core/world/entity/EntityMixin.java

@@ -204,6 +204,8 @@
    @Shadow protected abstract boolean shadow$fireImmune();
    // @formatter:on

+    @Shadow public abstract boolean isPassenger();


This should be put in the // @formatter block above, and prefixed with shadow$, so

@Shadow public abstract boolean shadow$isPassenger();

dualspiral · 2021-08-08T20:04:28Z

src/mixins/java/org/spongepowered/common/mixin/core/world/entity/LivingEntityMixin.java

+    @Shadow public float xxa;
+    @Shadow public float zza;
+    @Shadow protected boolean jumping;


Put these in the // @formatter block above.

dualspiral · 2021-08-08T20:04:55Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

+
+    @Inject(method = "setPlayerInput", at = @At("HEAD"), cancellable = true)
+    public void onSetPlayerInput(final float sway, final float surge, final boolean jumping, final boolean dismount, final CallbackInfo ci) {
+        if(isPassenger()) {


We prefix all same class accesses with this. (but this would become this.shadow$isPassenger())

Also, space after if

dualspiral · 2021-08-08T20:05:50Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

+    public void onSetPlayerInput(final float sway, final float surge, final boolean jumping, final boolean dismount, final CallbackInfo ci) {
+        if(isPassenger()) {
+            if(sway == this.xxa && surge == this.zza && jumping == this.jumping) {
+                return;


This would return true; as this is a success condition - everything is the same but the action isn't being cancelled, so continue.

dualspiral · 2021-08-08T20:06:50Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

+            Sponge.eventManager().post(event);
+
+            if(event.isCancelled()) {
+                ci.cancel();
+            }


You could replace this with

Suggested change

Sponge.eventManager().post(event);

if(event.isCancelled()) {

ci.cancel();

}

return !Sponge.eventManager().post(event);

dualspiral · 2021-08-08T20:07:20Z

src/mixins/java/org/spongepowered/common/mixin/core/server/level/ServerPlayerMixin.java

+                ci.cancel();
+            }
+        }
+    }


You'll want to return false at the end.

…etListenerImplMixin & fix whatever the fuck happened to mixins.sponge.core.json

ImMorpheus · 2023-11-03T20:30:36Z

Hey! You seem to be running an unsupported version (API 8) of SpongeAPI. Support for API 8 ended in October 2023.

API-8 is now end-of-life. We will not be issuing any more API updates for version 8 of our API¹

As part of our legacy cleanup we are closing issues relating to API8/1.16

If you wish to move this forward, please rebase this PR on the current branch and reopen it.

https://forums.spongepowered.org/t/sponge-status-update-17th-october-2023/42212#spongeapi-82-1 ↩

avaruus1 mentioned this pull request Jun 6, 2021

Add SteerVehicleEvent SpongePowered/SpongeAPI#2364

Closed

gabizou reviewed Jun 7, 2021

View reviewed changes

dualspiral reviewed Jun 9, 2021

View reviewed changes

ImMorpheus added type: feature request A feature request version: 1.16 (u) API: 8 system: event labels Jun 12, 2021

ImMorpheus added the status: needs updating hey, origin changed, you need to update label Jun 19, 2021

dualspiral reviewed Aug 8, 2021

View reviewed changes

avaruus1 and others added 6 commits December 1, 2021 07:46

Add SteerVehicleEvent

f7e4ec2

Call SteerVehicleEvent in ServerPlayerMixin instead of ServerGamePack…

a5eaaba

…etListenerImplMixin & fix whatever the fuck happened to mixins.sponge.core.json

Improve SteerVehicleEvent

2e31900

Made SteerVehicleEvent cancellable

7d0162a

Fix Javadoc comment in SteerVehicleEvent

2a2ca6a

Take two

d5c7fc4

aromaa force-pushed the api-8 branch from 95c8f00 to c03c957 Compare December 1, 2021 17:09

ImMorpheus closed this Nov 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SteerVehicleEvent #3421

Add SteerVehicleEvent #3421

avaruus1 commented Jun 6, 2021 •

edited

Loading

dualspiral commented Jun 6, 2021

gabizou Jun 7, 2021

avaruus1 Jun 8, 2021

gabizou Jun 7, 2021

avaruus1 Jun 8, 2021

gabizou Jun 7, 2021

gabizou Jun 7, 2021

dualspiral Jun 9, 2021

avaruus1 Jun 26, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

dualspiral Aug 8, 2021

ImMorpheus commented Nov 3, 2023

	public void onHandlePlayerInput(ServerboundPlayerInputPacket packet, CallbackInfo ci) {
	public void onHandlePlayerInput(final ServerboundPlayerInputPacket packet, final CallbackInfo ci) {

Add SteerVehicleEvent #3421

Add SteerVehicleEvent #3421

Conversation

avaruus1 commented Jun 6, 2021 • edited Loading

dualspiral commented Jun 6, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ImMorpheus commented Nov 3, 2023

Footnotes

avaruus1 commented Jun 6, 2021 •

edited

Loading