supertux
Public Member Functions | Public Attributes | List of all members
IntegrationStatus Class Reference

Public Member Functions

bool operator!= (const IntegrationStatus &is) const
 
bool operator== (const IntegrationStatus &is) const
 

Public Attributes

std::vector< std::string > m_details
 A list of lines describing what the player is doing. More...
 
int m_party_count
 The amount of people in the group (0 = no party)
 
int m_party_max
 The maximum amount of people in the group (0 = no limit)
 
long int m_timestamp
 Any timestamp relative to the game. More...
 

Member Data Documentation

◆ m_details

std::vector<std::string> IntegrationStatus::m_details

A list of lines describing what the player is doing.

Should go from general to specific.

A good first line should hint other people whether or not the user is available to play with them. For example, stating whether the user is playing online or offline, and if they're playing or if they're in the menus/level select screens.

The second line can give more details, such as which level is being played (or edited if in the level editor).

The lines should be short (max 100 characters). There shouldn't be more than 3 lines in total. Keep in mind that integrations don't display many lines: Discord displays two; Steam, just one.


A good example looks like: Playing (single player) In level: Welcome to Antartica Worldmap: Icy island

Or: Racing worldmap (online) Worldmap: LatestAddon's worldmap [custom]

(keep in mind party details have their own variables!)

Or even just: In menu

◆ m_timestamp

long int IntegrationStatus::m_timestamp

Any timestamp relative to the game.

A value before now will display an "Elapsed time" counter. A value after now will display a "Remaining time" counter. A value of 0 will display no timestamp.


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