diff options
author | RĂ©mi Verschelde <rverschelde@gmail.com> | 2019-06-27 15:05:18 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-27 15:05:18 +0200 |
commit | 071c033355953f225df5994558a084489f9e7b75 (patch) | |
tree | c830035ea61eb794d810362db108ece570e8c322 /doc/classes/NetworkedMultiplayerPeer.xml | |
parent | 2df8b5606b9de9d11873c27f0a297127bbbfc255 (diff) | |
parent | 528c4722d604a7e89b20e719a000e2b0d73c5675 (diff) |
Merge pull request #30123 from akien-mga/doc-misc-updates
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks, remove @GlobalScope scope when unnecessary
Diffstat (limited to 'doc/classes/NetworkedMultiplayerPeer.xml')
-rw-r--r-- | doc/classes/NetworkedMultiplayerPeer.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index e5cadb6ffe..ac84c32b5e 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -45,7 +45,7 @@ </argument> <description> Sets the peer to which packets will be sent. - The [code]id[/code] can be one of: [code]TARGET_PEER_BROADCAST[/code] to send to all connected peers, [code]TARGET_PEER_SERVER[/code] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: [code]TARGET_PEER_BROADCAST[/code] + The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: [constant TARGET_PEER_BROADCAST] </description> </method> </methods> @@ -90,10 +90,10 @@ </signals> <constants> <constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode"> - Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [code]TRANSFER_MODE_UNRELIABLE_ORDERED[/code]. Use for non-critical data, and always consider whether the order matters. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [constant TRANSFER_MODE_UNRELIABLE_ORDERED]. Use for non-critical data, and always consider whether the order matters. </constant> <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode"> - Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [code]TRANSFER_MODE_RELIABLE[/code]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [constant TRANSFER_MODE_RELIABLE]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. </constant> <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> Packets must be received and resend attempts should be made until the packets are acknowledged. Packets must be received in the order they were sent in. Most reliable transfer mode, but potentially slowest due to the overhead. Use for critical data that must be transmitted and arrive in order, for example an ability being triggered or a chat message. Consider carefully if the information really is critical, and use sparingly. |