Difference between revisions of "Sending Packets"

Latest revision as of 16:11, 27 May 2023

Once a packet has been added to the network, it can be called to send a message to the side it refers to. Usually there are four different directions a packet can be sent:

Direction	Description
`PLAY_TO_CLIENT`	A packet is sent from the server to the client during gameplay.
`PLAY_TO_SERVER`	A packet is sent from the client to the server during gameplay.
`LOGIN_TO_CLIENT`	A packet is sent to the client on initial login.
`LOGIN_TO_SERVER`	A packet is sent to the server on initial login.

The two login packets are handled internally by forge itself. However, the other two need to be sent using SimpleChannel#send for SimpleChannel#sendToServer. Each method takes a new instance of the message to send.

Client Packet Locations

It might not always be necessary to update every single client with a packet if they are not viewing the entity or are not affected by it. To specify which clients to send a packet from the server to, a PacketDistributor$PacketTarget must also be passed in as a parameter. There are many helpful fields that hold simple implementations of where to send which packet within PacketDistributor. However, they must be supplied with the required input either via PacketDistributor#with or PacketDistributor#noArg if it is going to all players.

Here is a list of Forge provided PacketDistributors:

`PacketDistributor`	Supplied Value	Description
`PLAYER`	`ServerPlayer`	Send to the specified player .
`DIMENSION`	`ResourceKey<Level>`	Send to all players within the specified dimension.
`NEAR`	`TargetPoint`	Send to all players within the range of the target point.
`ALL`	None	Send to all currently logged in players.
`SERVER`	None	Send from the player client to the server. This is the only distributor that should be used for client -> server communication.
`TRACKING_ENTITY`	`Entity`	Send to all players currently tracking the specified entity.
`TRACKING_ENTITY_AND_SELF`	`Entity`	Send to all players currently tracking the specified entity and the entity itself, if it is a player.
`TRACKING_CHUNK`	`LevelChunk`	Send to all players tracking the specified chunk.
`NMLIST`	`List<Connection>`	Send to the listed connections. Each connection is typically an individual player.

@@ Line 21: / Line 21: @@
 *
-Here is a list of distributors available:
+Here is a list of Forge provided <code>PacketDistributor</code>s:
-<br />
+{| class="wikitable sortable" border=1
-* <u>PLAYER:</u>Send to the specified Player.
+!<code>PacketDistributor</code> !!Supplied Value !!Description
-* <u>DIMENSION:</u>Send to everyone in the specified dimension.
+|-
-* <u>NEAR:</u>Send to everyone near the specified <code>PacketDistributor$TargetPoint</code>
+|   <code>PLAYER</code>                     || <code>ServerPlayer</code>       || Send to the specified player .
-* <u>ALL:</u>Send to everyone
+|-
-* <u>SERVER:</u>Send to the server(from client)
+|   <code>DIMENSION</code>                  || <code>ResourceKey<Level></code> || Send to all players within the specified dimension.
-* <u>TRACKING_ENTITY:</u>Send to all tracking the specified Entity<br />
+|-
-* <u>TRACKING_ENTITY_AND_SELF:</u>Send to all tracking the specified Entity and Player
+|   <code>NEAR</code>                       || <code>TargetPoint</code>        || Send to all players within the range of the target point.
-* <u>TRACKING_CHUNK:</u>Send to all tracking the specified Chunk
+|-
-* <u>NMLIST:</u>Send to each NetworkManager instance in the specified List
+|   <code>ALL</code>                        || None                            || Send to all currently logged in players.
+|-
+|   <code>SERVER</code>                     || None                            || Send from the player client to the server. This is the only distributor that should be used for client -> server communication.
+|-
+|   <code>TRACKING_ENTITY</code>            || <code>Entity</code>             || Send to all players currently tracking the specified entity.
+|-
+|   <code>TRACKING_ENTITY_AND_SELF</code>   || <code>Entity</code>             || Send to all players currently tracking the specified entity and the entity itself, if it is a player.
+|-
+|   <code>TRACKING_CHUNK</code>             || <code>LevelChunk</code>         || Send to all players tracking the specified chunk.
+|-
+|   <code>NMLIST</code>                     || <code>List<Connection></code>   || Send to the listed connections. Each connection is typically an individual player.
+|-
+|}