Sending Packets - Revision history

ChampionAsh5357: Move distributor list into a table

2023-05-27T16:11:10Z

Move distributor list into a table

Ageuxo: /* Client Packet Locations */

2023-05-27T15:50:26Z

Client Packet Locations

Unbekannt: Inital Import dokuwiki

2020-10-25T12:41:34Z

Inital Import dokuwiki

New page

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:

{| class="wikitable sortable" border=1
!Direction !!Description
|-
| <code>PLAY_TO_CLIENT</code> || A packet is sent from the server to the client during gameplay.
|-
| <code>PLAY_TO_SERVER</code> || A packet is sent from the client to the server during gameplay.
|-
| <code>LOGIN_TO_CLIENT</code> || A packet is sent to the client on initial login.
|-
| <code>LOGIN_TO_SERVER</code> || 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 <code>SimpleChannel#send</code> for <code>SimpleChannel#sendToServer</code>. 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 <code>PacketDistributor$PacketTarget</code> must also be passed in as a parameter. There are many helpful fields that hold simple implementations of where to send which packet within <code>PacketDistributor</code>. However, they must be supplied with the required input either via <code>PacketDistributor#with</code> or <code>PacketDistributor#noArg</code> if it is going to all players.

Here is a list of distributors available:

@@ 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.

@@ Line 16: / Line 16: @@
 The two login packets are handled internally by forge itself. However, the other two need to be sent using <code>SimpleChannel#send</code> for <code>SimpleChannel#sendToServer</code>. Each method takes a new instance of the message to send.
-== Client Packet Locations ==
+==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 <code>PacketDistributor$PacketTarget</code> must also be passed in as a parameter. There are many helpful fields that hold simple implementations of where to send which packet within <code>PacketDistributor</code>. However, they must be supplied with the required input either via <code>PacketDistributor#with</code> or <code>PacketDistributor#noArg</code> if it is going to all players.
+* 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 <code>PacketDistributor$PacketTarget</code> must also be passed in as a parameter. There are many helpful fields that hold simple implementations of where to send which packet within <code>PacketDistributor</code>. However, they must be supplied with the required input either via <code>PacketDistributor#with</code> or <code>PacketDistributor#noArg</code> if it is going to all players.
 Here is a list of distributors available: