NetworkArray< T > Struct Template Reference

Fusion type for networking arrays. Maximum capacity is fixed, and is set with the CapacityAttribute.

More...

Inherits IEnumerable< T >, and INetworkArray.

Classes
struct	Enumerator
	Enumerator for NetworkArray. More...

Public Member Functions
void	Clear ()
	Clears the array, setting all values to default. More...
void	CopyFrom (List< T > source, int sourceOffset, int sourceCount)
	Copies a range of values from a supplied source list into the NetworkArray. More...
void	CopyFrom (T[] source, int sourceOffset, int sourceCount)
	Copies a range of elements from a source array into the NetworkArray. More...
void	CopyTo (List< T > list)
	Adds each value to the supplied List. This does not clear the list, so values will be appended to the existing list. More...
void	CopyTo (NetworkArray< T > array)
	Copies values to the supplied array. More...
void	CopyTo (T[] array, bool throwIfOverflow=true)
	Copies values to the supplied array. More...
T	Get (int index)
	Returns the array value at supplied index. More...
Enumerator	GetEnumerator ()
	Returns an enumerator that iterates through the collection. More...
	NetworkArray (byte *array, int length, IElementReaderWriter< T > readerWriter)
	NetworkArray constructor. More...
T	Set (int index, T value)
	Sets the array value at the supplied index. More...
T[]	ToArray ()
	Allocates a new array and copies values from this array. For a non-alloc alternative use CopyTo(List<T>). More...
string	ToListString ()
	Returns the elements of this array as a string, with value separated by characters. Specifically for use in the Unity inspector. This is private and only is found by NetworkBehaviourEditor using reflection, so do not rename this method. More...
NetworkArrayReadOnly< T >	ToReadOnly ()
	Returns a NetworkArrayReadOnly view of this array. More...
override string	ToString ()
	Returns a string that represents the current object. More...

Static Public Member Functions
static implicit	operator NetworkArrayReadOnly< T > (NetworkArray< T > value)
	Returns a NetworkArrayReadOnly view of this array. More...

Properties
int	Length [get]
	The fixed size of the array. More...
T	this[int index] [get, set]
	Indexer of array elements. More...
Properties inherited from INetworkArray
object	this[int index] [get, set]
	Gets or sets the element at the specified index. More...

Detailed Description

Fusion type for networking arrays. Maximum capacity is fixed, and is set with the CapacityAttribute.

Typical Usage: [Networked, Capacity(4)]
NetworkArray<float> syncedArray => default;

Optional usage (for NetworkBehaviours ONLY - this is not legal in INetworkStructs): [Networked, Capacity(4)]
NetworkArray<int> syncedArray { get; } = MakeInitializer(new int[] { 1, 2, 3, 4 });


Usage for modifying data: array.Set(123); array[0] = 456;

Template Parameters

T	T can be a primitive, or an INetworkStruct.

Constructor & Destructor Documentation

NetworkArray()

NetworkArray	(	byte *	array,
		int	length,
		IElementReaderWriter< T >	readerWriter
	)

NetworkArray constructor.

Member Function Documentation

Clear()

void Clear

(

)

Clears the array, setting all values to default.

CopyFrom() [1/2]

void CopyFrom	(	List< T >	source,
		int	sourceOffset,
		int	sourceCount
	)

Copies a range of values from a supplied source list into the NetworkArray.

Parameters

source	The source list from which to copy elements.
sourceOffset	The zero-based index in the source list at which copying begins.
sourceCount	The number of elements to copy from the source list.

Exceptions

ArgumentNullException	Thrown when the provided source list is null.
ArgumentException	Thrown when the number of elements to copy is greater than the length of the NetworkArray.
ArgumentOutOfRangeException	Thrown when the sum of sourceOffset and sourceCount is greater than the length of the source list.

CopyFrom() [2/2]

void CopyFrom	(	T[]	source,
		int	sourceOffset,
		int	sourceCount
	)

Copies a range of elements from a source array into the NetworkArray.

Parameters

source	The source array from which to copy elements. Must not be null.
sourceOffset	The zero-based index in the source array at which copying begins.
sourceCount	The number of elements to copy from the source array.

Exceptions

ArgumentNullException	Thrown when the provided source array is null.
ArgumentException	Thrown when the number of elements to copy is greater than the length of the NetworkArray.
ArgumentOutOfRangeException	Thrown when the sum of sourceOffset and sourceCount is greater than the length of the source array.

CopyTo() [1/3]

void CopyTo

(

List< T >

list

)

Adds each value to the supplied List. This does not clear the list, so values will be appended to the existing list.

CopyTo() [2/3]

void CopyTo

(

NetworkArray< T >

array

)

Copies values to the supplied array.

Parameters

array

NetworkArray to copy to.

Exceptions

ArgumentException

Thrown if the supplied array is smaller than this NetworkArray<T>.

CopyTo() [3/3]

void CopyTo	(	T[]	array,
		bool	throwIfOverflow = true
	)

Copies values to the supplied array.

Parameters

array	Array to copy to.
throwIfOverflow	If true, this method will throw an error if the supplied array is smaller than this NetworkArray<T>. If false, will only copy as many elements as the target array can hold.

Get()

T Get

(

int

index

)

Returns the array value at supplied index.

GetEnumerator()

Enumerator GetEnumerator

(

)

Returns an enumerator that iterates through the collection.

operator NetworkArrayReadOnly< T >()

static implicit operator NetworkArrayReadOnly< T > ( NetworkArray< T >  value )

static

Returns a NetworkArrayReadOnly view of this array.

Parameters

value

NetworkArray to convert.

Returns

NetworkArrayReadOnly view of this array.

Set()

T Set	(	int	index,
		T	value
	)

Sets the array value at the supplied index.

ToArray()

T [] ToArray

(

)

Allocates a new array and copies values from this array. For a non-alloc alternative use CopyTo(List<T>).

ToListString()

string ToListString

(

)

Returns the elements of this array as a string, with value separated by
characters. Specifically for use in the Unity inspector. This is private and only is found by NetworkBehaviourEditor using reflection, so do not rename this method.

ToReadOnly()

NetworkArrayReadOnly<T> ToReadOnly

(

)

Returns a NetworkArrayReadOnly view of this array.

ToString()

override string ToString

(

)

Returns a string that represents the current object.

Property Documentation

Length

int Length

get

The fixed size of the array.

this[int index]

T this[int index]

getset

Indexer of array elements.