NetworkButtons Struct Reference

Represents a set of buttons that can be networked. More...

Inherits INetworkStruct, and IEquatable< NetworkButtons >.

Public Member Functions
bool	Equals (NetworkButtons other)
	Determines whether the specified NetworkButtons is equal to the current NetworkButtons. More...
override bool	Equals (object obj)
	Determines whether the specified object is equal to the current NetworkButtons. More...
override int	GetHashCode ()
	Serves as the default hash function. More...
NetworkButtons	GetPressed (NetworkButtons previous)
	Gets the buttons that were pressed since the previous state. More...
NetworkButtons	GetPressedOrReleased (NetworkButtons previous)
NetworkButtons	GetReleased (NetworkButtons previous)
	Gets the buttons that were released since the previous state. More...
bool	IsSet (int button)
	Checks if the button at the specified index is set. More...
bool	IsSet< T > (T button)
	Checks if the button of the specified enum type is set. More...
	NetworkButtons (int buttons)
	Initializes a new instance of the NetworkButtons struct with the specified buttons state. More...
void	Set (int button, bool state)
	Sets the button at the specified index to the specified state. More...
void	Set< T > (T button, bool state)
	Sets the button of the specified enum type to the specified state. More...
void	SetAllDown ()
	Sets all buttons to down. More...
void	SetAllUp ()
	Sets all buttons to up. More...
void	SetDown (int button)
	Sets the button at the specified index to down. More...
void	SetDown< T > (T button)
	Sets the button of the specified enum type to down. More...
void	SetUp (int button)
	Sets the button at the specified index to up. More...
void	SetUp< T > (T button)
	Sets the button of the specified enum type to up. More...
bool	WasPressed (NetworkButtons previous, int button)
	Checks if the button at the specified index was pressed since the previous state. More...
bool	WasPressed< T > (NetworkButtons previous, T button)
	Checks if the button of the specified enum type was pressed since the previous state. More...
bool	WasReleased (NetworkButtons previous, int button)
	Checks if the button at the specified index was released since the previous state. More...
bool	WasReleased< T > (NetworkButtons previous, T button)
	Checks if the button of the specified enum type was released since the previous state. More...

Public Attributes
int	_bits
	NetworkButtons
	Gets the buttons that were pressed or released since the previous state. More...

Properties
int	Bits [get]
	Gets the bits representing the state of the buttons. More...

Detailed Description

Represents a set of buttons that can be networked.

Constructor & Destructor Documentation

NetworkButtons()

NetworkButtons

(

int

buttons

)

Initializes a new instance of the NetworkButtons struct with the specified buttons state.

Parameters

buttons

The integer representing the state of the buttons.

Member Function Documentation

Equals() [1/2]

bool Equals

(

NetworkButtons

other

)

Determines whether the specified NetworkButtons is equal to the current NetworkButtons.

Parameters

other

The NetworkButtons to compare with the current NetworkButtons.

Returns

true if the specified NetworkButtons is equal to the current NetworkButtons; otherwise, false.

Equals() [2/2]

override bool Equals

(

object

obj

)

Determines whether the specified object is equal to the current NetworkButtons.

Parameters

obj	The object to compare with the current NetworkButtons.

Returns

true if the specified object is equal to the current NetworkButtons; otherwise, false.

GetHashCode()

override int GetHashCode

(

)

Serves as the default hash function.

Returns

A hash code for the current NetworkButtons.

GetPressed()

NetworkButtons GetPressed

(

NetworkButtons

previous

)

Gets the buttons that were pressed since the previous state.

Parameters

previous

The previous state of the buttons.

Returns

The buttons that were pressed.

GetReleased()

NetworkButtons GetReleased

(

NetworkButtons

previous

)

Gets the buttons that were released since the previous state.

Parameters

previous

The previous state of the buttons.

Returns

The buttons that were released.

IsSet()

bool IsSet

(

int

button

)

Checks if the button at the specified index is set.

Parameters

button

The index of the button to check.

Returns

true if the button is set; otherwise, false.

IsSet< T >()

bool IsSet< T >

(

T

button

)

Checks if the button of the specified enum type is set.

Template Parameters

T	The enum type of the button.

Parameters

button

The button of type T to check.

Returns

true if the button is set; otherwise, false.

Type Constraints

T	:	unmanaged
T	:	Enum

Set()

void Set	(	int	button,
		bool	state
	)

Sets the button at the specified index to the specified state.

Parameters

button	The index of the button to set.
state	The state to set the button to.

Set< T >()

void Set< T >	(	T	button,
		bool	state
	)

Sets the button of the specified enum type to the specified state.

Template Parameters

T	The enum type of the button.

Parameters

button	The button of type T to set.
state	The state to set the button to.

Type Constraints

T	:	unmanaged
T	:	Enum

SetAllDown()

void SetAllDown

(

)

Sets all buttons to down.

SetAllUp()

void SetAllUp

(

)

Sets all buttons to up.

SetDown()

void SetDown

(

int

button

)

Sets the button at the specified index to down.

Parameters

button

The index of the button to set to down.

SetDown< T >()

void SetDown< T >

(

T

button

)

Sets the button of the specified enum type to down.

Template Parameters

T	The enum type of the button.

Parameters

button

The button of type T to set to down.

Type Constraints

T	:	unmanaged
T	:	Enum

SetUp()

void SetUp

(

int

button

)

Sets the button at the specified index to up.

Parameters

button

The index of the button to set to up.

SetUp< T >()

void SetUp< T >

(

T

button

)

Sets the button of the specified enum type to up.

Template Parameters

T	The enum type of the button.

Parameters

button

The button of type T to set to up.

Type Constraints

T	:	unmanaged
T	:	Enum

WasPressed()

bool WasPressed	(	NetworkButtons	previous,
		int	button
	)

Checks if the button at the specified index was pressed since the previous state.

Parameters

previous	The previous state of the buttons.
button	The index of the button to check.

Returns

true if the button was pressed; otherwise, false.

WasPressed< T >()

bool WasPressed< T >	(	NetworkButtons	previous,
		T	button
	)

Checks if the button of the specified enum type was pressed since the previous state.

Template Parameters

T	The enum type of the button.

Parameters

previous	The previous state of the buttons.
button	The button of type T to check.

Returns

true if the button was pressed; otherwise, false.

Type Constraints

T	:	unmanaged
T	:	Enum

WasReleased()

bool WasReleased	(	NetworkButtons	previous,
		int	button
	)

Checks if the button at the specified index was released since the previous state.

Parameters

previous	The previous state of the buttons.
button	The index of the button to check.

Returns

true if the button was released; otherwise, false.

WasReleased< T >()

bool WasReleased< T >	(	NetworkButtons	previous,
		T	button
	)

Checks if the button of the specified enum type was released since the previous state.

Template Parameters

T	The enum type of the button.

Parameters

previous	The previous state of the buttons.
button	The button of type T to check.

Returns

true if the button was released; otherwise, false.

Type Constraints

T	:	unmanaged
T	:	Enum

Member Data Documentation

NetworkButtons

NetworkButtons

Gets the buttons that were pressed or released since the previous state.

Parameters

previous

The previous state of the buttons.

Returns

A tuple containing the buttons that were pressed and the buttons that were released.

Property Documentation

Bits

int Bits

get

Gets the bits representing the state of the buttons.