Struct ENetPacketPeer

pub struct ENetPacketPeer { /* private fields */ }

Expand description

Godot class ENetPacketPeer.

Inherits PacketPeer.

Related symbols:

enet_packet_peer: sidecar module with related enum/flag types

§Not instantiable

This class cannot be constructed. Obtain Gd<ENetPacketPeer> instances via Godot APIs.

§Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

§Godot docs

A PacketPeer implementation representing a peer of an ENetConnection.

This class cannot be instantiated directly but can be retrieved during service or via get_peers.

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Implementations§

§

impl ENetPacketPeer

pub const PACKET_LOSS_SCALE: i32 = 65536i32

pub const PACKET_THROTTLE_SCALE: i32 = 32i32

pub const FLAG_RELIABLE: i32 = 1i32

pub const FLAG_UNSEQUENCED: i32 = 2i32

pub const FLAG_UNRELIABLE_FRAGMENT: i32 = 8i32

pub fn peer_disconnect(&mut self)

To set the default parameters, use peer_disconnect_ex and its builder methods. See the book for detailed usage instructions. Request a disconnection from a peer. An EventType::DISCONNECT will be generated during service once the disconnection is complete.

pub fn peer_disconnect_ex<'ex>(&'ex mut self) -> ExPeerDisconnect<'ex>

Request a disconnection from a peer. An EventType::DISCONNECT will be generated during service once the disconnection is complete.

pub fn peer_disconnect_later(&mut self)

To set the default parameters, use peer_disconnect_later_ex and its builder methods. See the book for detailed usage instructions. Request a disconnection from a peer, but only after all queued outgoing packets are sent. An EventType::DISCONNECT will be generated during service once the disconnection is complete.

pub fn peer_disconnect_later_ex<'ex>( &'ex mut self, ) -> ExPeerDisconnectLater<'ex>

Request a disconnection from a peer, but only after all queued outgoing packets are sent. An EventType::DISCONNECT will be generated during service once the disconnection is complete.

pub fn peer_disconnect_now(&mut self)

To set the default parameters, use peer_disconnect_now_ex and its builder methods. See the book for detailed usage instructions. Force an immediate disconnection from a peer. No EventType::DISCONNECT will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function.

pub fn peer_disconnect_now_ex<'ex>(&'ex mut self) -> ExPeerDisconnectNow<'ex>

Force an immediate disconnection from a peer. No EventType::DISCONNECT will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function.

pub fn ping(&mut self)

Sends a ping request to a peer. ENet automatically pings all connected peers at regular intervals, however, this function may be called to ensure more frequent ping requests.

pub fn ping_interval(&mut self, ping_interval: i32)

Sets the ping_interval in milliseconds at which pings will be sent to a peer. Pings are used both to monitor the liveness of the connection and also to dynamically adjust the throttle during periods of low traffic so that the throttle has reasonable responsiveness during traffic spikes. The default ping interval is 500 milliseconds.

pub fn reset(&mut self)

Forcefully disconnects a peer. The foreign host represented by the peer is not notified of the disconnection and will timeout on its connection to the local host.

pub fn send( &mut self, channel: i32, packet: &PackedArray<u8>, flags: i32, ) -> Error

Queues a packet to be sent over the specified channel. See FLAG_* constants for available packet flags.

pub fn throttle_configure( &mut self, interval: i32, acceleration: i32, deceleration: i32, )

Configures throttle parameter for a peer.

Unreliable packets are dropped by ENet in response to the varying conditions of the Internet connection to the peer. The throttle represents a probability that an unreliable packet should not be dropped and thus sent by ENet to the peer. By measuring fluctuations in round trip times of reliable packets over the specified interval, ENet will either increase the probability by the amount specified in the acceleration parameter, or decrease it by the amount specified in the deceleration parameter (both are ratios to PACKET_THROTTLE_SCALE).

When the throttle has a value of PACKET_THROTTLE_SCALE, no unreliable packets are dropped by ENet, and so 100% of all unreliable packets will be sent.

When the throttle has a value of 0, all unreliable packets are dropped by ENet, and so 0% of all unreliable packets will be sent.

Intermediate values for the throttle represent intermediate probabilities between 0% and 100% of unreliable packets being sent. The bandwidth limits of the local and foreign hosts are taken into account to determine a sensible limit for the throttle probability above which it should not raise even in the best of conditions.

pub fn set_timeout(&mut self, timeout: i32, timeout_min: i32, timeout_max: i32)

Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds.

The timeout is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached timeout_min. The timeout_max parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped.

pub fn get_packet_flags(&self) -> i32

Returns the ENet flags of the next packet in the received queue. See FLAG_* constants for available packet flags. Note that not all flags are replicated from the sending peer to the receiving peer.

pub fn get_remote_address(&self) -> GString

Returns the IP address of this peer.

pub fn get_remote_port(&self) -> i32

Returns the remote port of this peer.

pub fn get_statistic(&self, statistic: PeerStatistic) -> f64

Returns the requested statistic for this peer.

pub fn get_state(&self) -> PeerState

Returns the current peer state.

pub fn get_channels(&self) -> i32

Returns the number of channels allocated for communication with peer.

pub fn is_active(&self) -> bool

Returns true if the peer is currently active (i.e. the associated ENetConnection is still valid).

Methods from Deref<Target = PacketPeer>§

pub fn get_var(&mut self) -> Variant

To set the default parameters, use get_var_ex and its builder methods. See the book for detailed usage instructions. Gets a Variant. If allow_objects is true, decoding objects is allowed.

Internally, this uses the same decoding mechanism as the bytes_to_var method.

Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn get_var_ex<'ex>(&'ex mut self) -> ExGetVar<'ex>

Gets a Variant. If allow_objects is true, decoding objects is allowed.

Internally, this uses the same decoding mechanism as the bytes_to_var method.

Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn put_var(&mut self, var: &Variant) -> Error

To set the default parameters, use put_var_ex and its builder methods. See the book for detailed usage instructions. Sends a Variant as a packet. If full_objects is true, encoding objects is allowed (and can potentially include code).

Internally, this uses the same encoding mechanism as the var_to_bytes method.

pub fn put_var_ex<'ex>(&'ex mut self, var: &'ex Variant) -> ExPutVar<'ex>

Sends a Variant as a packet. If full_objects is true, encoding objects is allowed (and can potentially include code).

Internally, this uses the same encoding mechanism as the var_to_bytes method.

pub fn get_packet(&mut self) -> PackedArray<u8>

Gets a raw packet.

pub fn put_packet(&mut self, buffer: &PackedArray<u8>) -> Error

Sends a raw packet.

pub fn get_packet_error(&self) -> Error

Returns the error state of the last packet received (via get_packet and get_var).

pub fn get_available_packet_count(&self) -> i32

Returns the number of packets currently available in the ring-buffer.

pub fn get_encode_buffer_max_size(&self) -> i32

pub fn set_encode_buffer_max_size(&mut self, max_size: i32)

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Returns the current reference count.

Methods from Deref<Target = Object>§

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.

Note: A metadata’s name must be a valid identifier as per is_valid_identifier method.