World Functions.
[API Functions]

Query and manipulate the game world. More...


Modules

 Desctags Functions.
 Manipulate description tags.

Functions

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.

Detailed Description

Query and manipulate the game world.


Function Documentation

F2LINK void F2CALL furn2::f2_badge_cancel (  ) 

Cancels the last badge/specitag from being displayed.

Remarks:
You should call this whenever you cancel chat text that typically has a badge displayed before it (speech, whispers, etc.), or if you want to make sure no badge is displayed before the current text.

F2LINK void F2CALL furn2::f2_monsterinfo ( unsigned int  guid,
MONSTERINFO *  out 
)

Gets information on a monster (avatar).

Parameters:
[in] guid Monster GUID.
[out] out MONSTERINFO structure to be filled with player data.
Warning:
The strings returned in out have an indefinite lifespan and should be copied somewhere if you intend to refer to them at a later time.
Remarks:
If successful, the guid contained in out will be non-zero.
See also:
MONSTERINFO

F2LINK void F2CALL furn2::f2_monsterinfo_byname ( const char *  name,
MONSTERINFO *  out,
bool  by_shortname = false 
)

Gets information on a monster (avatar) with a name.

Parameters:
[in] name Monster name.
[out] out MONSTERINFO structure to be filled with player data.
[in] by_shortname true if searching by shortname.
Warning:
The strings returned in out have an indefinite lifespan and should be copied somewhere if you intend to refer to them at a later time.
Remarks:
The name search is done in a case-sensitive manner.

If successful, the guid contained in out will be non-zero.

See also:
MONSTERINFO

F2LINK unsigned int F2CALL furn2::f2_monsters_enum ( unsigned int *  guids,
unsigned int  len 
)

Retrieves the GUIDs of all existing monsters.

Parameters:
[out] guids Integer array to be filled with GUIDs. May be NULL.
[in] len Length of the guids array.
Returns:
The number of guids copied to guids.
Remarks:
If guids is NULL, nothing is copied and the total number of existing monsters is returned.
See also:
f2_monsterinfo()

F2LINK bool F2CALL furn2::f2_monstervisible ( unsigned int  guid  ) 

Check if a monster is visible.

Parameters:
[in] guid GUID of the monster to check.
Returns:
true if the monster is visible. false if not visible or doesn't exist.
Remarks:
A monster is visible if an "avatar show" server command has been received. An "avatar hide" server command will mark the monster invisible.
See also:
f2_monsterinfo()

F2LINK void F2CALL furn2::f2_myplayerinfo ( PLAYERINFO *  out  ) 

Gets information on the (host) player.

Parameters:
[out] out PLAYERINFO structure to be filled with player data.
Warning:
The strings returned in out have an indefinite lifespan and should be copied somewhere if you intend to refer to them at a later time.
See also:
PLAYERINFO


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