OpenTTD Source  20241121-master-g67a0fccfad
TemporaryStorageArray< TYPE, SIZE > Struct Template Reference

Class for temporary storage of data. More...

#include <newgrf_storage.h>

Public Types

using StorageType = std::array< TYPE, SIZE >
 
using StorageInitType = std::array< uint16_t, SIZE >
 

Public Member Functions

void StoreValue (uint pos, int32_t value)
 Stores some value at a given position. More...
 
TYPE GetValue (uint pos) const
 Gets the value from a given position. More...
 
void ClearChanges ()
 

Data Fields

StorageType storage {}
 Memory for the storage array.
 
StorageInitType init {}
 Storage has been assigned, if this equals 'init_key'.
 
uint16_t init_key = 1
 Magic key to 'init'.
 

Detailed Description

template<typename TYPE, uint SIZE>
struct TemporaryStorageArray< TYPE, SIZE >

Class for temporary storage of data.

On #ClearChanges that data is always zero-ed.

Template Parameters
TYPEthe type of variable to store.
SIZEthe size of the array.

Definition at line 133 of file newgrf_storage.h.

Member Function Documentation

◆ GetValue()

template<typename TYPE , uint SIZE>
TYPE TemporaryStorageArray< TYPE, SIZE >::GetValue ( uint  pos) const
inline

Gets the value from a given position.

Parameters
posthe position to get the data from
Returns
the data from that position

Definition at line 160 of file newgrf_storage.h.

References TemporaryStorageArray< TYPE, SIZE >::init, and TemporaryStorageArray< TYPE, SIZE >::storage.

◆ StoreValue()

template<typename TYPE , uint SIZE>
void TemporaryStorageArray< TYPE, SIZE >::StoreValue ( uint  pos,
int32_t  value 
)
inline

Stores some value at a given position.

Parameters
posthe position to write at
valuethe value to write

Definition at line 146 of file newgrf_storage.h.

References TemporaryStorageArray< TYPE, SIZE >::init, TemporaryStorageArray< TYPE, SIZE >::init_key, and TemporaryStorageArray< TYPE, SIZE >::storage.


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