CGameAreaNotes Class¶

The structure used for this class is CGameAreaNotes

Quick Ref

void CGameAreaNotes::CGameAreaNotes()

void CGameAreaNotes::~CGameAreaNotes()

void CGameAreaNotes::Add(CString area, unsigned short startX, unsigned short startY, CString szNote, unsigned long dwFlags, unsigned long strRef)

void CGameAreaNotes::Add()

int CGameAreaNotes::AddANote(CAreaUserNote* cNote)

int CGameAreaNotes::AddButton(CPoint ptWorld)

void CGameAreaNotes::AddPredefinedNote(unsigned long strref, unsigned long flags, CPoint cPoint, int bAddToEnd)

int CGameAreaNotes::DeleteANote(unsigned long nButtonId)

CAreaUserNote* CGameAreaNotes::GetNoteAt(CPoint& cPt)

int CGameAreaNotes::GetNoteButtonColor(unsigned long iD)

unsigned long CGameAreaNotes::GetNoteButtonText(unsigned long iD)

void CGameAreaNotes::IntrnlInitialize()

int CGameAreaNotes::IsANoteThere(CPoint& cPt)

void CGameAreaNotes::Marshal(unsigned char**& pArea, unsigned long& cnt)

void CGameAreaNotes::PushNoteToLua(CPoint ptWorld, CPoint ptScreen)

void CGameAreaNotes::RemoveTextFromNote(unsigned long strref, CPoint cPoint)

void CGameAreaNotes::Uninitialize()

int CGameAreaNotes::UpdateButton(CPoint ptWorld, int nID)

void CGameAreaNotes::UpdateButtonPositions()

Constructors¶

Name	Description
CGameAreaNotes::CGameAreaNotes	Constructs a `CGameAreaNotes` object
CGameAreaNotes::~CGameAreaNotes	Destroys a `CGameAreaNotes` object

CGameAreaNotes::CGameAreaNotes¶

Constructs a CGameAreaNotes object

void CGameAreaNotes::CGameAreaNotes();

Remarks

Constructs a CGameAreaNotes object

CGameAreaNotes::~CGameAreaNotes¶

Destroys the CGameAreaNotes object

void CGameAreaNotes::~CGameAreaNotes();

Remarks

Destroys the CGameAreaNotes object

Methods¶

Name	Description
CGameAreaNotes::Add	Add notes to an area
CGameAreaNotes::AddANote	Add a note to area
CGameAreaNotes::AddButton	Add a note button
CGameAreaNotes::AddPredefinedNote	Add a predefined note using a string reference from the tlk table
CGameAreaNotes::DeleteANote	Delete an existing note button
CGameAreaNotes::GetNoteAt	Get note information at a specified coordinate
CGameAreaNotes::GetNoteButtonColor	Returns note color for a specified note button
CGameAreaNotes::GetNoteButtonText	Returns note text for a specified note button
CGameAreaNotes::IntrnlInitialize
CGameAreaNotes::IsANoteThere	Determines if a note exists at the specified coordinates
CGameAreaNotes::Marshal
CGameAreaNotes::PushNoteToLua	Push a note at a specified world and screen location to the lua stack
CGameAreaNotes::RemoveTextFromNote	Remove text from an existing note
CGameAreaNotes::Uninitialize
CGameAreaNotes::UpdateButton	Refresh and update note button
CGameAreaNotes::UpdateButtonPositions	Update note positions

CGameAreaNotes::Add¶

Add notes to an area

void CGameAreaNotes::Add(
   CString area,
   unsigned short startX,
   unsigned short startY,
   CString szNote,
   unsigned long dwFlags,
   unsigned long strRef);

Parameters

CString area - map area name to add notes to
unsigned short startX - x coordinate to add note at
unsigned short startY - y coordinate to add note at
CString szNote - the text content of the note to add
unsigned long dwFlags - flags
unsigned long strRef - string reference

Remarks

CGameAreaNotes::AddANote¶

Add a note to area

int CGameAreaNotes::AddANote(CAreaUserNote* cNote);

Parameters

CAreaUserNote* cNote - note structure to use for adding a note

Return Value

Returns int

Remarks

CGameAreaNotes::AddButton¶

Add a note button

int CGameAreaNotes::AddButton(CPoint ptWorld);

Parameters

CPoint ptWorld - x and y coordinates to add note button at

Return Value

Returns int

Remarks

CGameAreaNotes::AddPredefinedNote¶

Add a predefined note using a string reference from the tlk table

void CGameAreaNotes::AddPredefinedNote(
   unsigned long strref,
   unsigned long flags,
   CPoint cPoint,
   int bAddToEnd);

Parameters

unsigned long strref - string reference of existing note defined in tlk table to add
unsigned long flags - flags
CPoint cPoint - x and y coordinates to add note at
int bAddToEnd - add note to end or beginning

Remarks

CGameAreaNotes::DeleteANote¶

Delete an existing note button

int CGameAreaNotes::DeleteANote(unsigned long nButtonId);

Parameters

unsigned long nButtonId - id of note button to delete

Return Value

Returns int

Remarks

CGameAreaNotes::GetNoteAt¶

Get note information at a specified coordinate

CAreaUserNote* CGameAreaNotes::GetNoteAt(CPoint& cPt);

Parameters

CPoint& cPt - x and y coordinates to return note at this location for

Return Value

Returns CAreaUserNote*

Remarks

CGameAreaNotes::GetNoteButtonColor¶

Returns note color for a specified note button

int CGameAreaNotes::GetNoteButtonColor(unsigned long iD);

Parameters

unsigned long iD - id of note button to return color for

Return Value

Returns int

Remarks

CGameAreaNotes::GetNoteButtonText¶

Returns note text for a specified note button

unsigned long CGameAreaNotes::GetNoteButtonText(unsigned long iD);

Parameters

unsigned long iD - id of note button

Return Value

Returns unsigned long

Remarks

CGameAreaNotes::IntrnlInitialize¶

void CGameAreaNotes::IntrnlInitialize();

Remarks

CGameAreaNotes::IsANoteThere¶

Determines if a note exists at the specified coordinates

int CGameAreaNotes::IsANoteThere(CPoint& cPt);

Parameters

CPoint& cPt - x and y coordinates to check if a note exists at

Return Value

Returns an int value representing 1 true, or 0 false

Remarks

CGameAreaNotes::Marshal¶

void CGameAreaNotes::Marshal(
   unsigned char**& pArea,
   unsigned long& cnt);

Parameters

unsigned char**& pArea - pointer to area
unsigned long& cnt - count

Remarks

CGameAreaNotes::PushNoteToLua¶

Push a note at a specified world and screen location to the lua stack

void CGameAreaNotes::PushNoteToLua(
   CPoint ptWorld,
   CPoint ptScreen);

Parameters

CPoint ptWorld - x and y coordinates of world
CPoint ptScreen - x and y coordinates of screen

Remarks

CGameAreaNotes::RemoveTextFromNote¶

Remove text from an existing note

void CGameAreaNotes::RemoveTextFromNote(
   unsigned long strref,
   CPoint cPoint);

Parameters

unsigned long strref - string reference to remove from note
CPoint cPoint - x and y coordinates of note button

Remarks

CGameAreaNotes::Uninitialize¶

void CGameAreaNotes::Uninitialize();

Remarks

CGameAreaNotes::UpdateButton¶

Refresh and update note button

int CGameAreaNotes::UpdateButton(
   CPoint ptWorld,
   int nID);

Parameters

CPoint ptWorld - x and y coordinates of note button
int nID - button id

Return Value

Returns int

Remarks

CGameAreaNotes::UpdateButtonPositions¶

Update note positions

void CGameAreaNotes::UpdateButtonPositions();

Remarks