Crossfire Server, Trunk
GeneralMessage Struct Reference

#include <book.h>

+ Collaboration diagram for GeneralMessage:

Data Fields

int chance
const Faceface
sstring identifier
sstring message
sstring quest_code
sstring title

Detailed Description

One general message, from the lib/messages file.

Definition at line 44 of file book.h.

Field Documentation

◆ chance

int GeneralMessage::chance

Relative chance of the message appearing randomly. If 0 will never appear.

Definition at line 45 of file book.h.

Referenced by Messages::added(), GeneralMessageWrapper::chance(), Messages::replace(), and GeneralMessageWrapper::setChance().

◆ face

const Face* GeneralMessage::face

Face the message displays at in the knowledge dialog, NULL if no face defined.

Definition at line 51 of file book.h.

Referenced by GeneralMessageWrapper::displayIcon(), GeneralMessageWrapper::face(), GeneralMessageWrapper::setFace(), and GeneralMessageWrapper::uses().

◆ identifier

sstring GeneralMessage::identifier

Message identifier, can be NULL.

Definition at line 47 of file book.h.

Referenced by GeneralMessageWrapper::displayName(), GeneralMessageWrapper::identifier(), and Messages::replace().

◆ message

sstring GeneralMessage::message

The message's body.

Definition at line 49 of file book.h.

Referenced by GeneralMessageWrapper::message(), Messages::replace(), and GeneralMessageWrapper::setMessage().

◆ quest_code

sstring GeneralMessage::quest_code

Optional quest code and state this message will start.

Definition at line 50 of file book.h.

Referenced by GeneralMessageWrapper::quest(), Messages::replace(), GeneralMessageWrapper::setQuest(), and GeneralMessageWrapper::uses().

◆ title

sstring GeneralMessage::title

The message's title, only used for knowledge.

Definition at line 48 of file book.h.

Referenced by GeneralMessageWrapper::displayName(), Messages::replace(), GeneralMessageWrapper::setTitle(), and GeneralMessageWrapper::title().

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