Dragengine.Networking.NetworkState Class Reference

Network state. More...

Inheritance diagram for Dragengine.Networking.NetworkState:

Public Member Functions
Constructors
NetworkState	new ()
	Create network state.
Management
bool	getReadOnly ()
	Network state is read only.
Values
int	getValueCount ()
	Nnumber of values.
void	addValue (NetworkStateValueType type, NetworkStateValueFormat format)
	Add value.
NetworkStateValueFormat	getValueFormatAt (int index)
	format of value at index.
int	getValueIntAt (int index)
	Value of integer value at index.
float	getValueFloatAt (int index)
	Value of float value at index.
String	getValueStringAt (int index)
	Value of string value at index.
Point	getValuePoint2At (int index)
	Value of point-2 value at index.
Point3	getValuePoint3At (int index)
	Value of point-3 value at index.
Vector2	getValueVector2At (int index)
	Value of vector-2 value at index.
Vector	getValueVector3At (int index)
	Value of vector-3 value at index.
DVector	getValueDVector3At (int index)
	Value of dvector-3 value at index.
Quaternion	getValueQuaternionAt (int index)
	Value of quaternion value at index.
void	getValueDataAt (int index, MemoryFile data)
	Value of data value at index.
void	setValueIntAt (int index, int value)
	Set value of integer value at index.
void	setValueFloatAt (int index, float value)
	Set value of float value at index.
void	setValueStringAt (int index, String value)
	Set value of string value at index.
void	setValuePoint2At (int index, Point value)
	Set value of point-2 value at index.
void	setValuePoint3At (int index, Point3 value)
	Set value of point-3 value at index.
void	setValueVector2At (int index, Vector2 value)
	Set value of vector-2 value at index.
void	setValueVector3At (int index, Vector value)
	Set value of vector-3 value at index.
void	setValueDVector3At (int index, DVector value)
	Set value of dvector-3 value at index.
void	setValueQuaternionAt (int index, Quaternion value)
	Set value of quaternion value at index.
void	setValueDataAt (int index, MemoryFile data)
	Set value of data value at index.
float	getValuePrecisionAt (int index)
	Precision of floating point based value at index.
void	setValuePrecisionAt (int index, float precision)
	Set precision of floating point based value at index.
NetworkStateListener	getStateListener ()
	State listener or null if not set.
void	setStateListener (NetworkStateListener listener)
	Set state listener or null if not set.

Detailed Description

Network state.

This is a native class.

Member Function Documentation

addValue()

void Dragengine.Networking.NetworkState.addValue	(	NetworkStateValueType	type,
		NetworkStateValueFormat	format
	)

Add value.

Parameters

type	Type of value to add.
format	Format to use. Has to be non-null for these types: NetworkStateValueType.integer NetworkStateValueType.floating NetworkStateValueType.point2 NetworkStateValueType.point3 NetworkStateValueType.vector2 NetworkStateValueType.vector3 For all other types this parameter is not used.

getReadOnly()

bool Dragengine.Networking.NetworkState.getReadOnly

(

)

Network state is read only.

getStateListener()

NetworkStateListener Dragengine.Networking.NetworkState.getStateListener

(

)

State listener or null if not set.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueCount()

int Dragengine.Networking.NetworkState.getValueCount

(

)

Nnumber of values.

getValueDataAt()

void Dragengine.Networking.NetworkState.getValueDataAt	(	int	index,
		MemoryFile	data
	)

Value of data value at index.

Version

1.13

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

Value is read into the provided memory file.

getValueDVector3At()

DVector Dragengine.Networking.NetworkState.getValueDVector3At

(

int

index

)

Value of dvector-3 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueFloatAt()

float Dragengine.Networking.NetworkState.getValueFloatAt

(

int

index

)

Value of float value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueFormatAt()

NetworkStateValueFormat Dragengine.Networking.NetworkState.getValueFormatAt

(

int

index

)

format of value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueIntAt()

int Dragengine.Networking.NetworkState.getValueIntAt

(

int

index

)

Value of integer value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValuePoint2At()

Point Dragengine.Networking.NetworkState.getValuePoint2At

(

int

index

)

Value of point-2 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValuePoint3At()

Point3 Dragengine.Networking.NetworkState.getValuePoint3At

(

int

index

)

Value of point-3 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValuePrecisionAt()

float Dragengine.Networking.NetworkState.getValuePrecisionAt

(

int

index

)

Precision of floating point based value at index.

Exceptions

EOutOfBoundary	index is less than 0 or greater than or equal to getValueCount().
EInvalidParam	Value at index is not VALUE_FLOAT, VALUE_QUATERNION, VALUE_VECTOR2 or VALUE_VECTOR3

getValueQuaternionAt()

Quaternion Dragengine.Networking.NetworkState.getValueQuaternionAt

(

int

index

)

Value of quaternion value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueStringAt()

String Dragengine.Networking.NetworkState.getValueStringAt

(

int

index

)

Value of string value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueVector2At()

Vector2 Dragengine.Networking.NetworkState.getValueVector2At

(

int

index

)

Value of vector-2 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

getValueVector3At()

Vector Dragengine.Networking.NetworkState.getValueVector3At

(

int

index

)

Value of vector-3 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

new()

NetworkState Dragengine.Networking.NetworkState.new

(

)

Create network state.

setStateListener()

void Dragengine.Networking.NetworkState.setStateListener

(

NetworkStateListener

listener

)

Set state listener or null if not set.

setValueDataAt()

void Dragengine.Networking.NetworkState.setValueDataAt	(	int	index,
		MemoryFile	data
	)

Set value of data value at index.

Version

1.13

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValueDVector3At()

void Dragengine.Networking.NetworkState.setValueDVector3At	(	int	index,
		DVector	value
	)

Set value of dvector-3 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValueFloatAt()

void Dragengine.Networking.NetworkState.setValueFloatAt	(	int	index,
		float	value
	)

Set value of float value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValueIntAt()

void Dragengine.Networking.NetworkState.setValueIntAt	(	int	index,
		int	value
	)

Set value of integer value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValuePoint2At()

void Dragengine.Networking.NetworkState.setValuePoint2At	(	int	index,
		Point	value
	)

Set value of point-2 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValuePoint3At()

void Dragengine.Networking.NetworkState.setValuePoint3At	(	int	index,
		Point3	value
	)

Set value of point-3 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValuePrecisionAt()

void Dragengine.Networking.NetworkState.setValuePrecisionAt	(	int	index,
		float	precision
	)

Set precision of floating point based value at index.

Exceptions

EOutOfBoundary	index is less than 0 or greater than or equal to getValueCount().
EInvalidParam	Value at index is not VALUE_FLOAT, VALUE_QUATERNION, VALUE_VECTOR2 or VALUE_VECTOR3

setValueQuaternionAt()

void Dragengine.Networking.NetworkState.setValueQuaternionAt	(	int	index,
		Quaternion	value
	)

Set value of quaternion value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValueStringAt()

void Dragengine.Networking.NetworkState.setValueStringAt	(	int	index,
		String	value
	)

Set value of string value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValueVector2At()

void Dragengine.Networking.NetworkState.setValueVector2At	(	int	index,
		Vector2	value
	)

Set value of vector-2 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

setValueVector3At()

void Dragengine.Networking.NetworkState.setValueVector3At	(	int	index,
		Vector	value
	)

Set value of vector-3 value at index.

Exceptions

EOutOfBoundary

index is less than 0 or greater than or equal to getValueCount().

---

The documentation for this class was generated from the following file:

• NetworkState.ds