Photon Quantum 3.0.0

Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Quantum.View Struct Reference

Quantum component used to reference an EntityView asset which represents the view object that is created and updated in runtime, usually used for displaying entity graphics. More...

Inheritance diagram for Quantum.View:
Quantum.IComponent

Static Public Member Functions

static View Create (EntityView viewAsset)
 Creates and initializes an instance of this component type. More...
 
static View Create (FrameBase f, string path, DatabaseType dbType=DatabaseType.Default)
 Creates a new View instance and uses a path to find the EntityView asset that should be referenced by the component. More...
 
static void Serialize (void *ptr, FrameSerializer stream)
 Serializes a View into a FrameSerializer. More...
 

Public Attributes

AssetRef< EntityView > Current
 The EntityView asset that is currently referenced. More...
 

Static Public Attributes

const int SIZE = AssetRef<EntityView>.SIZE
 The size of the component (or struct/type) in-memory inside the Frame data-buffers or stack (when passed as value parameter). Not related to the snapshot payload this occupies, which is bit-packed and compressed. More...
 

Detailed Description

Quantum component used to reference an EntityView asset which represents the view object that is created and updated in runtime, usually used for displaying entity graphics.

Member Function Documentation

◆ Create() [1/2]

static View Quantum.View.Create ( EntityView  viewAsset)
inlinestatic

Creates and initializes an instance of this component type.

Parameters
viewAssetThe initial view asset
Returns

◆ Create() [2/2]

static View Quantum.View.Create ( FrameBase  f,
string  path,
DatabaseType  dbType = DatabaseType.Default 
)
inlinestatic

Creates a new View instance and uses a path to find the EntityView asset that should be referenced by the component.

Parameters
f
path
dbType
Returns

◆ Serialize()

static void Quantum.View.Serialize ( void *  ptr,
FrameSerializer  stream 
)
inlinestatic

Serializes a View into a FrameSerializer.

Parameters
ptrThe pointer to the View.
streamThe FrameSerializer instance into which the struct will be serialized.

Member Data Documentation

◆ SIZE

const int Quantum.View.SIZE = AssetRef<EntityView>.SIZE
static

The size of the component (or struct/type) in-memory inside the Frame data-buffers or stack (when passed as value parameter). Not related to the snapshot payload this occupies, which is bit-packed and compressed.

◆ Current

AssetRef<EntityView> Quantum.View.Current

The EntityView asset that is currently referenced.