Rapid packet-based entity data changes #2540
Conversation
| @@ -85,6 +85,7 @@ public static void registerCommands() { | |||
| registerCommand(ResetCommand.class); | |||
| registerCommand(ZapCommand.class); | |||
| // entity | |||
| registerCommand(SmoothEntityDataCommand.class); // <--------- | |||
There was a problem hiding this comment.
Will remove later, was a badly made TODO for myself
v1_20/src/main/java/com/denizenscript/denizen/nms/v1_20/helpers/EntityHelperImpl.java
Show resolved
Hide resolved
|
|
||
| public FakeInternalDataCommand() { | ||
| setName("fakeinternaldata"); | ||
| setSyntax("fakeinternaldata [entity:<entity>] [data:<map>|...] [for:<player>|...] (speed:<duration>)"); |
There was a problem hiding this comment.
for arg should be optional and default to linked player
...src/main/java/com/denizenscript/denizen/scripts/commands/entity/FakeInternalDataCommand.java
Show resolved
Hide resolved
| public FakeInternalDataCommand() { | ||
| setName("fakeinternaldata"); | ||
| setSyntax("fakeinternaldata [entity:<entity>] [data:<map>|...] (for:<player>|...) (speed:<duration>)"); | ||
| setRequiredArguments(3, 4); |
There was a problem hiding this comment.
Forgot to update that, fixed
| // @Usage | ||
| // Animates a rainbow glow on a display entity for all online players. | ||
| // - define color <color[red]> | ||
| // - repeat 361 from:0 as:hue: |
There was a problem hiding this comment.
A: hue is 0-255, not 0-360?
B: even if it wasn't a byte, the usage of 361 would still be 1 too many here (in a circle, 0 degrees and 360 degrees are the same value)
| // Animates a rainbow glow on a display entity for all online players. | ||
| // - define color <color[red]> | ||
| // - repeat 361 from:0 as:hue: | ||
| // - define frames:->:<map[glow_color=<[color].with_hue[<[hue]>].argb_integer>]> |
There was a problem hiding this comment.
constructor tag is redundant
| try { | ||
| for (List<Object> frame : frames) { | ||
| NMSHandler.packetHelper.sendEntityDataPacket(sendTo, entity, frame); | ||
| Thread.sleep(ms); |
There was a problem hiding this comment.
Should either note in meta that the delay is inaccurate for long runs, or switch this sleep to a more accurate delay manager.
Also considering the possibility of long runs, should also add a check to kill the loop if the player(s) are gone
| // <--[command] | ||
| // @Name FakeInternalData | ||
| // @Syntax fakeinternaldata [entity:<entity>] [data:<map>|...] (for:<player>|...) (speed:<duration>) | ||
| // @Required 3 |
There was a problem hiding this comment.
required min mismatch between meta and setSyntax
...src/main/java/com/denizenscript/denizen/scripts/commands/entity/FakeInternalDataCommand.java
Show resolved
Hide resolved
| // Sends fake internal entity data updates, optionally sending multiple over time. | ||
| // This supports sub-tick precision, allowing smooth/high FPS animations. | ||
| // | ||
| // The input to 'data:' is a list of <@link object MapTag>s, with each map being a frame to send, with each map being formatted like <@link mechanism EntityTag.internal_data>'s input. |
There was a problem hiding this comment.
A command should probably be considered "more primary" than a mech (ie put the details in command and have the mech link to it) - or add a separate language defining the data that both link to
There was a problem hiding this comment.
Pushed an initial attempt at a language doc for this, let me know if it looks good
...src/main/java/com/denizenscript/denizen/scripts/commands/entity/FakeInternalDataCommand.java
Show resolved
Hide resolved
| // - fakeinternaldata entity:<[item_display]> data:[item=iron_ingot;scale=0.6,0.6,0.6]|[item=gold_ingot;scale=0.8,0.8,0.8]|[item=netherite_ingot;scale=1,1,1] speed:0.5s | ||
| // | ||
| // @Usage | ||
| // Changes an item display's item, then it's scale a second later, then it's item again another second later. |
| // Each entity in Minecraft has a set of data values that get sent to the client, with each data value being a number id -> value pair. | ||
| // Denizen allows direct control over that data, as it can be useful for things like setting values that would usually be blocked. | ||
| // Because this is such a direct control that's meant to impose less restrictions, there's no limitations/verification on the values being set other than basic type checking. | ||
| // For all possible internal entity data values and their respective ids, see <@link url https://github.com/DenizenScript/Denizen/blob/dev/v1_20/src/main/java/com/denizenscript/denizen/nms/v1_20/helpers/EntityDataNameMapper.java#L50>. |
There was a problem hiding this comment.
This doc should note somewhere that these values are liable to change between minecraft versions
Changes
EntityHelper#modifyInternalEntityDatanow takes in aMapTag, to match the new method & share it's internal handling.PacketHelperImpl(1.20)#sendAsyncSafe's code was slightly changed to work properly without network interception being enabled.Removals
EntityHelper#mapInternalEntityDataNamewas removed in favor of having that logic/handling in NMS.Additions
EntityHelper#convertInternalEntityDataValues- converts aMapTagto a list ofDataValue's (returned asList<Object>), used to parse entity data in the new command, implemented as such a bridge method so that it can be done outside of the async task.PacketHelperImpl#sendEntityDataPacket- sends an entity data update packet to a list of players, taking in aList<Object>(DataValues).fakeinternaldatacommand - sends fake entity data updates, optionally animating them with sub-tick precision.EntityHelperImpl(1.20)#getDataItems- util method to get an entity's internalid -> DataItemmap.EntityHelperImpl(1.20)#convertToInternalData- internal util to parse aMapTaginto entity data values, taking in aBiConsumerto use the converted values.PacketHelperImpl(1.20)#sendAsyncSafe- util to send packets async, as this was done in 2 places now.DenizenNetworkManagerImpl#getConnection(Player)- util to get a connection from a bukkit player.Internal Entity Datalanguage doc - a general explanation of internal entity data with relevant links, used in both the command and the mechanism.Notes
speedoptional), but is that something we want to officially document? if we do we should probably