Struct airmash_protocol::client::Login

pub struct Login {
    pub protocol: u8,
    pub name: String,
    pub session: String,
    pub horizon_x: u16,
    pub horizon_y: u16,
    pub flag: String,
}

Initial packet sent to log in to the server.

This is sent to the server when the player first joins.

Fields

protocol: u8

The current protocol version. Should always be 5 as of the writing of this documentation.

name: String

The name that the player wishes to be called on the server. The actual name of the player given by the server will be returned in the Login packet returned by the server.

session: String

A session token for the current player. This is how a player logs into the server. If the player logging in wishes to be associated with an account, this must be set. Otherwise, "none" works to avoid being given an account.

horizon_x: u16

Theoretically should set the size of the horizon beyond which players are not sent to the server. In practice doesn't appear to do anything.

horizon_y: u16

Theoretically should set the size of the horizon beyond which players are not sent to the server. In practice doesn't appear to do anything.

flag: String

The flag of the player, it should be a 2-letter ISO country code corresponding to the country with the desired flag.

Trait Implementations

impl Clone for Login

fn clone(&self) -> Login

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Login

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.