// Note: your pArrayProp will NOT get iElement set to anything other than 0, because this function installs its
// own proxy in front of yours. pStruct will point at the CUtlVector and pData will point at the element in the CUtlVector.It will pass you the direct pointer to the element inside the CUtlVector.
//
// You can skip the first 3 parameters in pArrayProp because they're ignored. So your array specification
// could look like this:
// SendPropUtlVector(
// SENDINFO_UTLVECTOR( m_FloatArray ),
// SendPropFloat( NULL, 0, 0, 0 [# bits], SPROP_NOSCALE [flags] ) );
//
// Note: you have to be DILIGENT about calling NetworkStateChanged whenever an element in your CUtlVector changes
// since CUtlVector doesn't do this automatically.
SendProp SendPropUtlVector(
const char *pVarName, // Use SENDINFO_UTLVECTOR to generate these 4.
int offset, // Used to generate pData in the function specified in varProxy.
int sizeofVar, // The size of each element in the utlvector.
EnsureCapacityFn ensureFn, // This is the value returned for elements out of the array's current range.
int nMaxElements, // Max # of elements in the array. Keep this as low as possible.
SendProp pArrayProp, // Describe the data inside of each element in the array.
SendTableProxyFn varProxy // This can be overridden to control who the array is sent to.
)
{
SendProp ret;
Assert( nMaxElements <= MAX_ARRAY_ELEMENTS );
ret.m_Type = DPT_DataTable;
ret.m_pVarName = pVarName;
ret.SetOffset( 0 );
ret.SetDataTableProxyFn( varProxy );
// Handle special proxy types where they always let all clients get the results.
if ( varProxy == SendProxy_DataTableToDataTable || varProxy == SendProxy_DataTablePtrToDataTable )
{
ret.SetFlags( SPROP_PROXY_ALWAYS_YES );
}
// Extra data bound to each of the properties.
CSendPropExtra_UtlVector *pExtraData = new CSendPropExtra_UtlVector;
pExtraData->m_nMaxElements = nMaxElements;
pExtraData->m_ElementStride = sizeofVar;
pExtraData->m_EnsureCapacityFn = ensureFn;
pExtraData->m_Offset = offset;
if ( pArrayProp.m_Type == DPT_DataTable )
pExtraData->m_DataTableProxyFn = pArrayProp.GetDataTableProxyFn();
else
pExtraData->m_ProxyFn = pArrayProp.GetProxyFn();
SendProp *pProps = new SendProp[nMaxElements+1]; // TODO free that again
// The first property is datatable with an int that tells the length of the array.
// It has to go in a datatable, otherwise if this array holds datatable properties, it will be received last.
SendProp *pLengthProp = new SendProp;
*pLengthProp = SendPropInt( AllocateStringHelper( "lengthprop%d", nMaxElements ), 0, 0, NumBitsForCount( nMaxElements ), SPROP_UNSIGNED, SendProxy_UtlVectorLength );
pLengthProp->SetExtraData( pExtraData );
char *pLengthProxyTableName = AllocateUniqueDataTableName( true, "_LPT_%s_%d", pVarName, nMaxElements );
SendTable *pLengthTable = new SendTable( pLengthProp, 1, pLengthProxyTableName );
pProps[0] = SendPropDataTable( "lengthproxy", 0, pLengthTable, SendProxy_LengthTable );
pProps[0].SetExtraData( pExtraData );
// The first element is a sub-datatable.
for ( int i = 1; i < nMaxElements+1; i++ )
{
pProps[i] = pArrayProp; // copy array element property setting
pProps[i].SetOffset( 0 ); // leave offset at 0 so pStructBase is always a pointer to the CUtlVector
pProps[i].m_pVarName = s_ElementNames[i-1]; // give unique name
pProps[i].SetExtraData( pExtraData );
pProps[i].m_ElementStride = i-1; // Kind of lame overloading element stride to hold the element index,
// but we can easily move it into its SetExtraData stuff if we need to.
// We provide our own proxy here.
if ( pArrayProp.m_Type == DPT_DataTable )
{
pProps[i].SetDataTableProxyFn( SendProxy_UtlVectorElement_DataTable );
pProps[i].SetFlags( SPROP_PROXY_ALWAYS_YES );
}
else
{
pProps[i].SetProxyFn( SendProxy_UtlVectorElement );
}
}
SendTable *pTable = new SendTable(
pProps,
nMaxElements+1,
AllocateUniqueDataTableName( true, "_ST_%s_%d", pVarName, nMaxElements )
);
ret.SetDataTable( pTable );
return ret;
}
RecvProp RecvPropUtlVector(
const char *pVarName, // Use RECVINFO_UTLVECTOR to generate these 4.
int offset, // Used to generate pData in the function specified in varProxy.
int sizeofVar, // The size of each element in the utlvector.
ResizeUtlVectorFn fn,
EnsureCapacityFn ensureFn,
int nMaxElements, // Max # of elements in the array. Keep this as low as possible.
RecvProp pArrayProp
)
{
RecvProp ret;
Assert( nMaxElements <= MAX_ARRAY_ELEMENTS );
ret.m_RecvType = DPT_DataTable;
ret.m_pVarName = pVarName;
ret.SetOffset( 0 );
ret.SetDataTableProxyFn( DataTableRecvProxy_StaticDataTable );
RecvProp *pProps = new RecvProp[nMaxElements+1]; // TODO free that again
// Extra data bound to each of the properties.
CRecvPropExtra_UtlVector *pExtraData = new CRecvPropExtra_UtlVector;
pExtraData->m_nMaxElements = nMaxElements;
pExtraData->m_ElementStride = sizeofVar;
pExtraData->m_ResizeFn = fn;
pExtraData->m_EnsureCapacityFn = ensureFn;
pExtraData->m_Offset = offset;
if ( pArrayProp.m_RecvType == DPT_DataTable )
pExtraData->m_DataTableProxyFn = pArrayProp.GetDataTableProxyFn();
else
pExtraData->m_ProxyFn = pArrayProp.GetProxyFn();
// The first property is datatable with an int that tells the length of the array.
// It has to go in a datatable, otherwise if this array holds datatable properties, it will be received last.
RecvProp *pLengthProp = new RecvProp;
*pLengthProp = RecvPropInt( AllocateStringHelper( "lengthprop%d", nMaxElements ), 0, 0, 0, RecvProxy_UtlVectorLength );
pLengthProp->SetExtraData( pExtraData );
char *pLengthProxyTableName = AllocateUniqueDataTableName( false, "_LPT_%s_%d", pVarName, nMaxElements );
RecvTable *pLengthTable = new RecvTable( pLengthProp, 1, pLengthProxyTableName );
pProps[0] = RecvPropDataTable( "lengthproxy", 0, 0, pLengthTable, DataTableRecvProxy_LengthProxy );
pProps[0].SetExtraData( pExtraData );
// The first element is a sub-datatable.
for ( int i = 1; i < nMaxElements+1; i++ )
{
pProps[i] = pArrayProp; // copy array element property setting
pProps[i].SetOffset( 0 ); // leave offset at 0 so pStructBase is always a pointer to the CUtlVector
pProps[i].m_pVarName = s_ClientElementNames[i-1]; // give unique name
pProps[i].SetExtraData( pExtraData );
pProps[i].SetElementStride( i-1 ); // Kind of lame overloading element stride to hold the element index,
// but we can easily move it into its SetExtraData stuff if we need to.
// We provide our own proxy here.
if ( pArrayProp.m_RecvType == DPT_DataTable )
{
pProps[i].SetDataTableProxyFn( RecvProxy_UtlVectorElement_DataTable );
}
else
{
pProps[i].SetProxyFn( RecvProxy_UtlVectorElement );
}
}
RecvTable *pTable = new RecvTable(
pProps,
nMaxElements+1,
AllocateUniqueDataTableName( false, "_ST_%s_%d", pVarName, nMaxElements )
); // TODO free that again
ret.SetDataTable( pTable );
return ret;
}
