3es  0.7
tes::UpdateMessage Struct Reference

A update message is identical in header to a CreateMessage. More...

#include <3esmessages.h>

Public Types

enum  { MessageId = OIdUpdate }
 ID for this message.
 

Public Member Functions

bool read (PacketReader &reader)
 Read message content. More...
 
bool write (PacketWriter &writer) const
 Write this message to writer. More...
 

Public Attributes

uint32_t id
 Object creation id. Zero if defining a transient/single frame message.
 
uint16_t flags
 Update flags from ObjectFlag.
 
ObjectAttributes attributes
 Initial transformation and colour.
 

Detailed Description

A update message is identical in header to a CreateMessage.

It's payload may vary and in many cases it will have no further payload.

Member Function Documentation

◆ read()

bool tes::UpdateMessage::read ( PacketReader reader)
inline

Read message content.

Crc should have been validated already

Parameters
readerThe stream to read from.
Returns
True on success, false if there is an issue with amount of data available.

References tes::ObjectAttributes::read(), and tes::PacketReader::readElement().

◆ write()

bool tes::UpdateMessage::write ( PacketWriter writer) const
inline

Write this message to writer.

Parameters
writerThe target buffer.
Returns
True on success.

References tes::ObjectAttributes::write(), and tes::PacketWriter::writeElement().


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