furn2 Namespace Reference


Classes

struct  UUID128
 A little class to represent UUIDs. More...
struct  POINT2
 Basic x,y coordinate structure. More...
struct  F2VERSION
 Version structure. More...
struct  PLAYERINFO
 Describes the player. More...
struct  MONSTERINFO
 Describes a monster. More...
struct  MODULEINFO
 Describes a loaded module. More...
struct  RENDERPARAMS
 Describes a render target. More...
struct  WNDPROCPARAMS
 Describes a windows message. More...

Enumerations

enum  Revision { REV_DRAFT, REV_REVISING, REV_FINAL }
 The network revision pass. More...
enum  Module_Event {
  MOD_EVENT_START, MOD_EVENT_STOP, MOD_EVENT_ENABLE, MOD_EVENT_DISABLE,
  MOD_EVENT_TOUCH, MOD_EVENT_MSG
}
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
}
enum  World_Event {
  WO_EVENT_CONNECTED, WO_EVENT_DISCONNECTED, WO_EVENT_LOGGEDIN, WO_EVENT_PLAYERINFO,
  WO_EVENT_MONSTER
}
enum  { MOD_DISABLED = 0x0, MOD_ENABLED = 0x1 }
enum  { MONSTER_HASPROFILE = 0x1, MONSTER_UNK1 = 0x2, MONSTER_UNK2 = 0x4 }
enum  { FROM_SERVER = 0, FROM_CLIENT = 0, FROM_GENERATED = 1 }
enum  Connection_Level { CONNLVL_DISCONNECTED = 0, CONNLVL_CONNECTED = 32, CONNLVL_MOTDEND = 64, CONNLVL_LOGGEDIN = 128 }
enum  Client_Screen { SCREEN_TITLE, SCREEN_PICKEM, SCREEN_BORDER, SCREEN_MARBLED }
 Different client screens. More...
enum  Script_Error {
  SCRIPT_OK, SCRIPT_BADARG, SCRIPT_FAILED, SCRIPT_BADSID,
  SCRIPT_NOTUNIQUE
}
 Error codes returned by script functions. More...
enum  Script_RunFlags { SCRIPT_RUN_UNIQUE = 0x1, SCRIPT_RUN_REPLACE = 0x2, SCRIPT_RUN_LATE = 0x4 }
 Run flags for scripts. More...
enum  Hide_Flags {
  HIDE_FILTERS = 0x1, HIDE_SCRIPTS = 0x2, HIDE_MODULES = 0x4, HIDE_WORLD = 0x8,
  HIDE_CLIENT = 0x10, HIDE_ALL = 0x1F
}
 Network hide flags. More...

Functions

F2LINK void *F2CALL f2_hookapi (const char *lib, const char *name, void *hook, bool by_ordinal)
 Hooks an API symbol by name or ordinal.
F2LINK HWND F2CALL f2_getwnd ()
 Retrieve the window handle of the main window.
F2LINK void F2CALL f2_setcurdialog (HWND dlg)
 Set the active dialog window.
F2LINK void F2CALL f2_command (const char *command, bool noecho=false)
 Send a command line command through furnarchy.
F2LINK void F2CALL f2_name_push (const char *name)
 Adds/refreshes a name in the autocomplete list.
F2LINK int F2CALL f2_name_complete (char *name, std::size_t size, int iter)
 Completes a name.
F2LINK void F2CALL f2_makeshortname (const char *name, char *buf)
 Converts a player name into a shortname.
F2LINK Connection_Level F2CALL f2_connlvl ()
 Retrieve the current game connection level.
F2LINK void F2CALL f2_netout (const char *buf, std::size_t size)
 Sends some bytes to the server.
F2LINK size_t F2CALL f2_netoutline (const char *line, std::size_t len)
 Sends a line to the server.
F2LINK size_t F2CALL f2_netoutcount ()
 Returns the next outbound line number to be assigned.
F2LINK void F2CALL f2_netin (const char *buf, std::size_t size)
 Sends some bytes to the client.
F2LINK size_t F2CALL f2_netinline (const char *line, std::size_t len)
 Sends a line to the client.
F2LINK size_t F2CALL f2_netincount ()
 Returns the next inbound line number to be assigned.
F2LINK void F2CALL f2_reviseline (const char *line)
 Modifies the current line being revised.
F2LINK void F2CALL f2_cancelline ()
 Cancels the current line.
F2LINK void F2CALL f2_hideline (int hide_flags)
 Prevents the current line from being processed by further handlers/listeners in specific subsystems.
F2LINK int F2CALL f2_hideflags ()
 Retrieves the hide flags for the current line.
F2LINK void F2CALL f2_speak (const char *line)
 Prints a line of text to the chat buffer.
F2LINK void F2CALL f2_errspeak (const char *line)
 Prints an error line to the chat buffer.
F2LINK void F2CALL f2_errlog (const char *line)
 Appends some text to the error log.
F2LINK bool F2CALL f2_buildok ()
 Checks if the furnarchy2 memlocs are valid for this client build.
F2LINK unsigned int F2CALL f2_clcrc ()
 Retrieves the Furcadia client's CRC32.
F2LINK void F2CALL f2_version (F2VERSION *out)
 Retrieves Furnarchy's version.
F2LINK bool F2CALL f2_singleusermode ()
 Checks whether Furnarchy is running in single user mode.
F2LINK const char *F2CALL f2_root ()
 Retrieves Furnarchy's program directory.
F2LINK const char *F2CALL f2_dataroot ()
 Retrieves Furnarchy's data directory.
F2LINK const char *F2CALL f2_docroot ()
 Retrieves Furnarchy's document directory.
F2LINK const char *F2CALL f2_clroot ()
 Retrieves the client's program directory.
F2LINK const char *F2CALL f2_cldataroot ()
 Retrieves the client's data directory.
F2LINK const char *F2CALL f2_cldocroot ()
 Retrieves the client's document directory.
F2LINK bool F2CALL f2_createdirs (const char *path)
 Creates a directory hierarchy.
F2LINK std::size_t F2CALL f2_modcount ()
 Counts the number of loaded modules.
F2LINK const char *F2CALL f2_modroot (unsigned int mod)
 Retrieves a module's program directory.
F2LINK const char *F2CALL f2_moddataroot (unsigned int mod)
 Retrieves a module's data directtory.
F2LINK const char *F2CALL f2_moddocroot (unsigned int mod)
 Retrieves a module's documents directtory.
F2LINK const char *F2CALL f2_modname (unsigned int mod)
 Retrieves a module's name.
F2LINK const char *F2CALL f2_modfancyname (unsigned int mod)
 Retrieves a module's fancy name, as opposed to its "real name." This is the name set in the module's module.ini file.
F2LINK const char *F2CALL f2_modthumb (unsigned int mod)
 Retrieves a module's thumbnail image path.
F2LINK unsigned long F2CALL f2_modstate (unsigned int mod)
 Retrieves a module's state.
F2LINK void F2CALL f2_modenable (unsigned int mod, bool onoff)
 Enables or disables a module.
F2LINK unsigned int F2CALL f2_modfind (const UUID128 *uuid)
 Looks for a module by UUID.
F2LINK void F2CALL f2_modtouch (unsigned int mod)
 Sends a module a touch event.
F2LINK int F2CALL f2_modmsg (unsigned int mod, void *data)
 Sends a module a message.
F2LINK void F2CALL f2_myplayerinfo (PLAYERINFO *out)
 Gets information on the (host) player.
F2LINK void F2CALL f2_monsterinfo (unsigned int guid, MONSTERINFO *out)
 Gets information on a monster (avatar).
F2LINK void F2CALL f2_monsterinfo_byname (const char *name, MONSTERINFO *out, bool by_shortname=false)
 Gets information on a monster (avatar) with a name.
F2LINK unsigned int F2CALL f2_monsters_enum (unsigned int *guids, unsigned int len)
 Retrieves the GUIDs of all existing monsters.
F2LINK bool F2CALL f2_monstervisible (unsigned int guid)
 Check if a monster is visible.
F2LINK void F2CALL f2_badge_cancel ()
 Cancels the last badge/specitag from being displayed.
F2LINK int F2CALL f2_desctag_reg ()
 Registers a desctag slot.
F2LINK bool F2CALL f2_desctag_unreg (int tag_id)
 Unregisters a desctag slot.
F2LINK bool F2CALL f2_desctag_set (int tag_id, const char *tag)
 Sets the contents of a desctag slot.
F2LINK void F2CALL f2__setplayerinfo (const char *name, const char *pw, const char *color, const char *desc, const unsigned int *guid)
 Sets internal player information.
F2LINK void F2CALL f2__setmainsocket (SOCKET socket)
 Replaces the client's main connection socket handle.
F2LINK void F2CALL f2__pushchatbox (const char *line)
 Pushes a line of text into the chat buffer.
F2LINK bool F2CALL f2__ignore_add (const char *name)
 Adds an ignore.
F2LINK bool F2CALL f2__ignore_rm (const char *name)
 Removes an ignore.
F2LINK bool F2CALL f2__ignore_test (const char *name)
 Tests if a name is ignored.
F2LINK const char *F2CALL f2__playermenu_name ()
 Retrieves the player shortname associated with the last player menu popup.
F2LINK unsigned int F2CALL f2_script_enum (unsigned int *sids, unsigned int len)
 Enumerates the script ids of all running scripts.
F2LINK unsigned int F2CALL f2_script_argv (unsigned int sid, const char **argv, unsigned int len, int *flags)
 Retrieves the run arguments and flags for a running script.
F2LINK Script_Error F2CALL f2_script_run (const char **argv, unsigned int len, int flags, unsigned int *sid)
 Runs a script.
F2LINK Script_Error F2CALL f2_script_kill (unsigned int sid)
 Kills a running script.
F2LINK bool F2CALL f2_playermenu_set (unsigned int mod, HMENU menu)
 Sets a module's submenu in the player's popup menu.
F2LINK bool F2CALL f2_playermenu_unset (unsigned int mod)
 Unsets a module's submenu in the player's popup menu.


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