SCR_WeightedArray< Class TValue > Interface Template Reference

Public Member Functions
int	GetRandomValue (out TValue outValue)
int	GetRandomValue (out TValue outValue, notnull RandomGenerator randomGenerator)
int	GetWeightedValue (out TValue outValue, float weightedValue)
float	GetTotalWeight ()
TValue	Get (int n)
void	Set (int n, TValue value)
int	Insert (TValue value, float weight)
void	Remove (int i)
void	RemoveOrdered (int i)
float	GetWeight (int i)
TValue	GetValue (int i)
int	Count ()
bool	IsEmpty ()
bool	Contains (TValue value)
int	Find (TValue value)
int	CopyFrom (notnull SCR_WeightedArray< TValue > from)
void	Clear ()
int	ToArray (out notnull array< TValue > outArray)
void	Debug ()

Protected Attributes
ref array< TValue >	m_aValues = {}
ref array< float >	m_aWeights = {}
float	m_fTotalWeight

Member Function Documentation

Clear()

void SCR_WeightedArray< Class TValue >.Clear

(

)

Contains()

bool SCR_WeightedArray< Class TValue >.Contains

(

TValue

value

)

Parameters

[in]

value

Returns

CopyFrom()

int SCR_WeightedArray< Class TValue >.CopyFrom

(

notnull SCR_WeightedArray< TValue >

from

)

Parameters

[in]

from

Returns

Count()

int SCR_WeightedArray< Class TValue >.Count

(

)

Returns

Debug()

void SCR_WeightedArray< Class TValue >.Debug

(

)

Find()

int SCR_WeightedArray< Class TValue >.Find

(

TValue

value

)

Parameters

[in]

value

Returns

Get()

TValue SCR_WeightedArray< Class TValue >.Get

(

int

n

)

Parameters

[in]

n

Returns

GetRandomValue() [1/2]

int SCR_WeightedArray< Class TValue >.GetRandomValue

(

out TValue

outValue

)

Parameters

[out]

outValue

Returns

GetRandomValue() [2/2]

int SCR_WeightedArray< Class TValue >.GetRandomValue	(	out TValue	outValue,
		notnull RandomGenerator	randomGenerator )

Parameters

[out]	outValue
[in]	randomGenerator

Returns

GetTotalWeight()

float SCR_WeightedArray< Class TValue >.GetTotalWeight

(

)

Returns

GetValue()

TValue SCR_WeightedArray< Class TValue >.GetValue

(

int

i

)

Parameters

[in]

i

Returns

GetWeight()

float SCR_WeightedArray< Class TValue >.GetWeight

(

int

i

)

Parameters

[in]

i

Returns

GetWeightedValue()

int SCR_WeightedArray< Class TValue >.GetWeightedValue	(	out TValue	outValue,
		float	weightedValue )

Parameters

[out]	outValue
[in]	weightedValue

Returns

Insert()

int SCR_WeightedArray< Class TValue >.Insert	(	TValue	value,
		float	weight )

Parameters

[in]	value
[in]	weight

Returns

IsEmpty()

bool SCR_WeightedArray< Class TValue >.IsEmpty

(

)

Returns

Remove()

void SCR_WeightedArray< Class TValue >.Remove

(

int

i

)

Parameters

[in]

i

RemoveOrdered()

void SCR_WeightedArray< Class TValue >.RemoveOrdered

(

int

i

)

Parameters

[in]

i

Set()

void SCR_WeightedArray< Class TValue >.Set	(	int	n,
		TValue	value )

Parameters

[in]	n
[in]	value

ToArray()

int SCR_WeightedArray< Class TValue >.ToArray

(

out notnull array< TValue >

outArray

)

Parameters

[out]

outArray

Returns

Member Data Documentation

m_aValues

ref array<TValue> SCR_WeightedArray< Class TValue >.m_aValues = {}

protected

m_aWeights

ref array<float> SCR_WeightedArray< Class TValue >.m_aWeights = {}

protected

m_fTotalWeight

float SCR_WeightedArray< Class TValue >.m_fTotalWeight

protected

---

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

• Game/Global/SCR_WeightedArray.c