CCursor Class Reference

< Private type which specifies the cursor-type More...

#include <cursor.h>

List of all members.

Public Member Functions
	CCursor ()
Public Attributes
std::string	Ident
	Identifier to reference it.
int	HotX
	Hot point x.
int	HotY
	Hot point y.
int	SpriteFrame
	Current displayed cursor frame.
int	FrameRate
	Rate of changing the frames.
CGraphic *	G
	Cursor sprite image.

---

Detailed Description

< Private type which specifies the cursor-type

#include "cursor.h"

This structure contains all informations about a cursor. The cursor changes depending of the current user input state. A cursor can have transparent areas and color cycle animated.

The cursor-type structure members:

CCursor::Ident

Unique identifier of the cursor, used to reference it in config files and during startup. Don't use this in game, use instead the pointer to this structure.

CCursor::HotX CCursor::HotY

Hot spot of the cursor in pixels. Relative to the sprite origin (0,0). The hot spot of a cursor is the point to which Stratagus refers in tracking the cursor's position.

CCursor::SpriteFrame

Current displayed cursor frame. From 0 to CCursor::G::NumFrames.

CCursor::FrameRate

Rate of changing the frames. The "rate" tells the engine how many milliseconds to hold each frame of the animation.

Note:

This is the first time that for timing ms are used! I would change it to display frames.

CCursor::G

Contains the sprite of the cursor, loaded from CCursor::File. This can be a multicolor image with alpha or transparency.

Definition at line 115 of file cursor.h.

---

Constructor & Destructor Documentation

CCursor::CCursor

(

)

[inline]

Definition at line 117 of file cursor.h.

---

Member Data Documentation

std::string CCursor::Ident

Identifier to reference it.

Definition at line 120 of file cursor.h.

int CCursor::HotX

Hot point x.

Definition at line 122 of file cursor.h.

Referenced by DrawCursor(), and HideCursor().

int CCursor::HotY

Hot point y.

Definition at line 123 of file cursor.h.

Referenced by DrawCursor(), and HideCursor().

int CCursor::SpriteFrame

Current displayed cursor frame.

Definition at line 125 of file cursor.h.

Referenced by CursorAnimate(), and DrawCursor().

int CCursor::FrameRate

Rate of changing the frames.

Definition at line 126 of file cursor.h.

Referenced by CursorAnimate().

CGraphic* CCursor::G

Cursor sprite image.

Definition at line 130 of file cursor.h.

Referenced by CursorAnimate(), and DrawCursor().

---

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

• cursor.h