Struct godot_ggrs_wrapper::GodotGGRSP2PSpectatorSession

source · [−]

pub struct GodotGGRSP2PSpectatorSession { /* private fields */ }

Expand description

A Godot implementation of P2PSpectatorSession

Implementations

source

impl GodotGGRSP2PSpectatorSession

source

pub fn create_new_session(
    &mut self,
    _owner: &Node,
    local_port: u16,
    num_players: u32,
    host_addr: String
)

Creates a P2PSpectatorSession, call this when you want to start setting up a P2PSpectatorSession. Takes the local port and total number of players and the host address as parameters.

source

pub fn create_session(
    &mut self,
    _owner: &Node,
    local_port: u16,
    num_players: u32,
    host_addr: String
)

👎 Deprecated since 0.5.0:

please use create_new_session() instead

Deprecated method to create a P2PSpectatorSession. Use Self::create_new_session() instead.

source

pub fn is_running(&mut self, _owner: &Node) -> bool

Returns true if connection has been established with remote players and is ready to start advancing frames via Self::advance_frame()

source

pub fn get_current_state(&mut self, _owner: &Node) -> String

Returns the current sate of the session as a String. See SessionState for all possible states.

source

pub fn start_session(&mut self, _owner: &Node)

Starts the P2PSpectatorSession

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn set_callback_node(&mut self, _owner: &Node, callback: Ref<Node>)

Sets the callback node that will be called when using Self::advance_frame()

source

pub fn advance_frame(&mut self, _owner: &Node)

This function will advance the frame using the inputs received from the host_session. Before using this function you have to set the callback node and make sure it has the following callback functions implemented

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made
Will print a ERR_MESSAGE_NO_CALLBACK_NODE error if a callback node has not been set

source

pub fn get_frames_behind_host(&mut self, _owner: &Node) -> u32

Returns P2PSpectatorSession::frames_behind_host()

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn set_catchup_speed(&mut self, _owner: &Node, desired_catchup_speed: u32)

Sets P2PSpectatorSession::set_catchup_speed()

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn set_max_frames_behind(&mut self, _owner: &Node, desired_value: u32)

Sets P2PSpectatorSession::set_max_frames_behind()

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn poll_remote_clients(&mut self, _owner: &Node)

Calls P2PSpectatorSession::poll_remote_clients()

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn set_fps(&mut self, _owner: &Node, fps: u32)

Sets P2PSpectatorSession::set_fps()

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn print_network_stats(&mut self, _owner: &Node)

Prints out network stats of host address

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn get_network_stats(
&mut self,
_owner: &Node
) -> (usize, u64, usize, i32, i32 )

Will return network stats of host address as a tuple, which will be converted to an Array inside godot.

Errors

Will print a ERR_MESSAGE_NO_SESSION_MADE error if a session has not been made

source

pub fn get_events(&mut self, _owner: &Node) -> Vec<(&str, Variant)>

Returns an Array of events which contain usefull information, while you don’t have to implement everything, the one thing you should implement is the WaitRecommendation. For details regarding the events please take a loot at GGRSEvent.

Example

var events = ggrs.get_events()
for item in events:
    match item[0]:
        "WaitRecommendation":
            frames_to_skip += item[1]
        "NetworkInterrupted":
            var handle = item[1][0]
            var disconnect_timeout = item[1][1]
        "NetworkResumed":
            var handle = item[1]
        "Disconnected":
            var handle = item[1]
        "Synchronized":
            var handle = item[1]
        "Synchronizing":
            var handle = item[1][0]
            var total = item[1][1]
            var count = item[1][2]