Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

NxwItemWrapper Class Reference

#include <set.h>

Inheritance diagram for NxwItemWrapper:

NxwSerialWrapper NxwWrapper List of all members.

Public Methods

 NxwItemWrapper ()
 Constructor.

 NxwItemWrapper (const NxwItemWrapper &that)
 ~NxwItemWrapper ()
 Destructor.

P_ITEM getItem ()
 Get the current item.

void insertItem (P_ITEM pi)
 Insert a new item.

void fillItemsInContainer (P_ITEM pi, LOGICAL bIncludeSubContained=true, LOGICAL bIncludeOnlyFirstSubcont=false)
void fillItemWeared (P_CHAR pc, LOGICAL bIncludeLikeHair=false, LOGICAL bIncludeProtectedLayer=false, LOGICAL bExcludeIllegalLayer=true)
 Fills a set with a list of item worn by given char.

void fillItemsAtXY (UI16 x, UI16 y, SI32 type=-1, SI32 id=-1)
 Fills with a list of item at given location.

void fillItemsAtXY (Location location, SI32 type=-1, SI32 id=-1)
 Fills with a list of item at given location.

void fillItemsNearXYZ (UI16 x, UI16 y, int nDistance=VISRANGE, LOGICAL bExcludeNotMovableItems=true)
 Fills with a list of item near given location.

void fillItemsNearXYZ (Location location, int nDistance=VISRANGE, LOGICAL bExcludeNotMovableItems=true)
 Fills with a list of item near given location.

void fillGuilds (SERIAL guild, int options=0)
 Fills a set with a list of all guilds or guild political.

void fillHousesOwned (SERIAL chr)
 Fills a set with a list of all houses a given char owns.

void fillItemsInsideHouse (SERIAL house, SI32 scriptID=-1)
 Fills with a list of items inside the given house.

void fillItemsOutsideHouse (SERIAL house, SI32 scriptID=-1)
 Fills with a list of items inside the given house.

Constructor & Destructor Documentation

NxwItemWrapper::NxwItemWrapper (    ) 
 

Constructor.

NxwItemWrapper::NxwItemWrapper (  const NxwItemWrapper &    that ) 
 

NxwItemWrapper::~NxwItemWrapper (    ) 
 

Destructor.

Member Function Documentation

void NxwItemWrapper::fillGuilds (  SERIAL    guild,
int    options = 0
) 
 

Fills a set with a list of all guilds or guild political.

Author:
Endymion
Parameters:
guild  INVALID for all or specific for use guild options
options 
Warning:
this function ADD new char to current list

void NxwItemWrapper::fillHousesOwned (  SERIAL    chr ) 
 

Fills a set with a list of all houses a given char owns.

Author:
Wintermute
Parameters:
guild  INVALID for all or specific for use guild options
options 
Warning:
this function ADD new char to current list

void NxwItemWrapper::fillItemsAtXY (  Location    location,
SI32    type = -1,
SI32    id = -1
) 
 

Fills with a list of item at given location.

Author:
Endymion
Parameters:
location  the location
type  if not INVALID only add item with this type
id  if not INVALID only add item with this id
Warning:
this function ADD new char to current list

void NxwItemWrapper::fillItemsAtXY (  UI16    x,
UI16    y,
SI32    type = -1,
SI32    id = -1
) 
 

Fills with a list of item at given location.

Author:
Endymion
Parameters:
x  the x location
y  the y location
type  if not INVALID only add item with this type
id  if not INVALID only add item with this id
Warning:
this function ADD new char to current list

void NxwItemWrapper::fillItemsInContainer (  P_ITEM    pi,
LOGICAL    bIncludeSubContained = true,
LOGICAL    bIncludeOnlyFirstSubcont = false
) 
 

\bref Fills with item in a container

Author:
Endymion
Parameters:
pi  the container
bIncludeSubContained  if true recurse subcontainers
bIncludeOnlyFirstSubcont  if true only recurse first sub container

void NxwItemWrapper::fillItemsInsideHouse (  SERIAL    house,
SI32    type = -1
) 
 

Fills with a list of items inside the given house.

Author:
Wintermute
Parameters:
house  the house
scriptID:  filter for items only with given scriptID

void NxwItemWrapper::fillItemsNearXYZ (  Location    location,
int    nDistance = VISRANGE,
LOGICAL    bExcludeNotMovableItems = true
) 
 

Fills with a list of item near given location.

Author:
Endymion
Parameters:
location  the location
nDistance  only add item in distance range
bExcludeNotMovableItems  if true exluce not movable items
Warning:
this function ADD new char to current list

void NxwItemWrapper::fillItemsNearXYZ (  UI16    x,
UI16    y,
int    nDistance = VISRANGE,
LOGICAL    bExcludeNotMovableItems = true
) 
 

Fills with a list of item near given location.

Author:
Endymion
Parameters:
x  the x location
y  the y location
nDistance  only add item in distance range
bExcludeNotMovableItems  if true exluce not movable items
Warning:
this function ADD new char to current list

void NxwItemWrapper::fillItemsOutsideHouse (  SERIAL    house,
SI32    type = -1
) 
 

Fills with a list of items inside the given house.

Author:
Wintermute
Parameters:
house  the house
scriptID:  filter for items only with given scriptID

void NxwItemWrapper::fillItemWeared (  P_CHAR    pc,
LOGICAL    bIncludeLikeHair = false,
LOGICAL    bIncludeProtectedLayer = false,
LOGICAL    bExcludeIllegalLayer = true
) 
 

Fills a set with a list of item worn by given char.

Author:
Endymion
Parameters:
pc  the char
bExcludeIllegalLayer  if true layer like backpack, trade are excluded
bIncludeLikeHair  if true add also hair, beard ecc
bIncludeProtectedLayer  if true add also protected layer
Warning:
this function ADD new char to current list

P_ITEM NxwItemWrapper::getItem (    ) 
 

Get the current item.

Author:
Endymion
Returns:
the current item

void NxwItemWrapper::insertItem (  P_ITEM    pi ) 
 

Insert a new item.

Author:
Endymion
Parameters:
pi  the item

The documentation for this class was generated from the following files: SourceForge.net Logo