Client Events
[Furnarchy 2]

Furcadia client events. More...

Enumerations

enum  Client_Event {
  CL_EVENT_WNDCREATED, CL_EVENT_SCRLOAD, CL_EVENT_SETMAINSOCKET, CL_EVENT_PRERENDER,
  CL_EVENT_RENDER, CL_EVENT_POSTRENDER, CL_EVENT_TICK, CL_EVENT_CHATBOX,
  CL_EVENT_PLAYERMENUSHOW, CL_EVENT_SCRIPT
}

Detailed Description

Furcadia client events.

These events are received through a module's on_client() event handler. The event determines the type and meaning of on_client()'s param parameter and return value.

See also:
on_client

Enumeration Type Documentation

enum Client_Event

Enumerator:
CL_EVENT_WNDCREATED  The main client window was created.

Parameters:
[in] param HWND of the created window.
Returns:
Return 0 always.
Remarks:
After this message is received, f2_getwnd() will also return the window handle.
See also:
f2_getwnd()
CL_EVENT_SCRLOAD  The client is about to change screens.

Parameters:
[in] param A Client_Screen indicating the new screen.
Returns:
Return 0 always.
Remarks:
Furnarchy monitors file access to determine when screen changes occur.
See also:
Client_Screen
CL_EVENT_SETMAINSOCKET  The main connection socket is being set.

Parameters:
[in] param The new SOCKET handle.
Returns:
Return 0 always.
Remarks:
The socket is set when the client initially attempts to establish a connection to the game server. Modules may also trigger this event when they call f2__setmainsocket().
See also:
f2__setmainsocket()
CL_EVENT_PRERENDER  Furnarchy is rendering its lowest z-order elements.

Parameters:
[in] param const RENDERPARAMS*
Returns:
Return 0 always.
Remarks:
Furnarchy guarantees the device context provided in param will be in the format of a 24-bit top-down DIB section, for compatibility with SDL and easier direct manipulation. Be sure to call GdiFlush() if you wish to read/modify the DIB's bits directly.
See also:
RENDERPARAMS, CL_EVENT_RENDER, CL_EVENT_POSTRENDER
CL_EVENT_RENDER  Furnarchy is rendering its medium/normal z-order elements.

Parameters:
[in] param const RENDERPARAMS*
Returns:
Return 0 always.
Remarks:
Furnarchy guarantees the device context provided in param will be in the format of a 24-bit top-down DIB section, for compatibility with SDL and easier direct manipulation. Be sure to call GdiFlush() if you wish to read/modify the DIB's bits directly.
See also:
RENDERPARAMS, CL_EVENT_PRERENDER, CL_EVENT_POSTRENDER
CL_EVENT_POSTRENDER  Furnarchy is rendering its highest z-order elements.

Parameters:
[in] param const RENDERPARAMS*
Returns:
Return 0 always.
Remarks:
Furnarchy guarantees the device context provided in param will be in the format of a 24-bit top-down DIB section, for compatibility with SDL and easier direct manipulation. Be sure to call GdiFlush() if you wish to read/modify the DIB's bits directly.
See also:
RENDERPARAMS, CL_EVENT_PRERENDER, CL_EVENT_RENDER
CL_EVENT_TICK  A regular Furnarchy tick event occurred.

Parameters:
[in] param unsigned int, the number of milliseconds since the last tick event.
Returns:
Return 0 always.
Remarks:
This gives modules an opportunity to perform timed events. CL_EVENT_TICK has a resolution of about 160ms.
CL_EVENT_CHATBOX  A line is being pushed onto the chat buffer.

Parameters:
[in] param const char*
Returns:
Return non-zero to prevent the line from being pushed.
Remarks:
This event depends on the client build and memlocs.
CL_EVENT_PLAYERMENUSHOW  The player popup menu is being shown.

Parameters:
[in] param A const char*, the name of the player.
Remarks:
This event is build-dependent. You'll only receive it if f2_buildok() returns true.
CL_EVENT_SCRIPT  The running scripts have changed.

Parameters:
[in] param Not used.
Remarks:
This is triggered whenever a script is run or exited/killed.


Generated on Tue Jun 24 12:24:07 2008 for Furnarchy Module by  doxygen 1.5.5