Struct godot_ggrs_wrapper::GodotGGRSSyncTestSession

pub struct GodotGGRSSyncTestSession { /* fields omitted */ }

A Godot implementation of SyncTestSession

Implementations

impl GodotGGRSSyncTestSession

pub fn create_session(
    &mut self,
    _owner: &Node,
    num_players: u32,
    check_distance: u32
)

Creates a SyncTestSession, call this when you want to start setting up a SyncTestSession takes the total number of players and the check distance as parameters

pub fn set_frame_delay(
    &mut self,
    _owner: &Node,
    frame_delay: u32,
    player_handle: PlayerHandle
)

Sets SyncTestSession::set_frame_delay() of specified handle.

Errors

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

pub fn advance_frame(&mut self, _owner: &Node, all_inputs: Vec<u32>)

This function will advance the frame using an array of all the inputs given as a parameter (inputs are currently an int in Godot). Before using this function you have to set the callback node and make sure it has the following callback functions implemented

• CALLBACK_FUNC_SAVE_GAME_STATE
• CALLBACK_FUNC_LOAD_GAME_STATE
• CALLBACK_FUNC_SAVE_GAME_STATE

Errors

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

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()

Trait Implementations

impl NativeClass for GodotGGRSSyncTestSession

type Base = Node

Base type of the class.

type UserData = DefaultUserData<GodotGGRSSyncTestSession>

User-data wrapper type of the class.

fn class_name() -> &'static str

The name of the class.

fn init(owner: TRef<'_, Self::Base>) -> Self

Function that creates a value of Self, used for the script-instance. The default implementation simply panics.

fn register_properties(builder: &ClassBuilder<Self>)

Register any exported properties to Godot.

fn new_instance() -> Instance<Self, Unique> where
    Self::Base: Instanciable, 

Convenience method to create an Instance<Self, Unique>. This is a new Self::Base with the script attached.

fn emplace(self) -> Instance<Self, Unique> where
    Self::Base: Instanciable, 

Convenience method to emplace self into an Instance<Self, Unique>. This is a new Self::Base with the script attached.

impl NativeClassMethods for GodotGGRSSyncTestSession

fn register(builder: &ClassBuilder<Self>)

Function that registers all exposed methods to Godot.