VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::ChannelInfo Struct Reference

Detailed Description

ChannelInfo represents a communication channel in the chat system, characterized by a name, associated force (friendly, enemy, etc.), and activation status. This structure is designed to be accessible from QML through the Q_PROPERTY mechanism, allowing the UI to display and interact with channel information.

#include <vreChatWindow.h>

Public Member Functions

 ChannelInfo ()=default
 
 ChannelInfo (QString ch, int f, bool a)
 

Public Attributes

QString myChannelName
 
int myForce = 0
 
bool myActive = false
 
QStringList myEntities
 

Properties

QString channel
 
int force
 
bool active
 
QStringList entities
 

Constructor & Destructor Documentation

◆ ChannelInfo() [1/2]

makVre::ChannelInfo::ChannelInfo ( )
default

Default constructor.

◆ ChannelInfo() [2/2]

makVre::ChannelInfo::ChannelInfo ( QString ch,
int f,
bool a )
inline

Constructor with parameters.

Parameters
chChannel name
fForce identifier (friendly=1, enemy=2, neutral=3, etc.)
aActivation status (true if channel is currently active)

References myActive, myChannelName, and myForce.

Member Data Documentation

◆ myChannelName

QString makVre::ChannelInfo::myChannelName

Name of the communication channel.

Referenced by ChannelInfo().

◆ myForce

int makVre::ChannelInfo::myForce = 0

Force identifier associated with this channel (Typically: 1=friendly, 2=enemy, 3=neutral, etc.)

Referenced by ChannelInfo().

◆ myActive

bool makVre::ChannelInfo::myActive = false

Flag indicating if this channel is currently active.

Referenced by ChannelInfo().

◆ myEntities

QStringList makVre::ChannelInfo::myEntities

List of entities (participants) in this channel.

Property Documentation

◆ channel

QString makVre::ChannelInfo::channel

Channel name property exposed to QML.

◆ force

int makVre::ChannelInfo::force

Force identifier property exposed to QML.

◆ active

bool makVre::ChannelInfo::active

Channel activation status property exposed to QML.

◆ entities

QStringList makVre::ChannelInfo::entities

List of entities in this channel property exposed to QML.


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