C# Class FFACETools.FFACE.NPCTools

Wrapper class for NPC information from FFACE
Show file Open project: golfandsurf/Campah Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
ClaimedID ( int id ) : int

Server ID of the person who first claimed the mob

Distance ( int id ) : double

NPC's distance from player

GetPosition ( int id ) : Position

Gets the position of the NPC

HPPCurrent ( int id ) : short

NPC's current hit point percent

IsActive ( int id ) : bool

Whether the NPC is active or not

IsClaimed ( int id ) : bool

Whether the NPC is claimed or not

NPCBit ( int id ) : byte

If the NPC is rendered on the screen

NPCTools ( int instanceID ) : System

Constructor

NPCType ( int id ) : NPCType

Type of NPC

Name ( int id ) : string

Name of the NPC

PetID ( int id ) : int

Uses player index to get PetID

PosH ( int id ) : float

H position of the NPC

PosX ( int id ) : float

X position of the NPC

PosY ( int id ) : float

Y position of the NPC

PosZ ( int id ) : float

Z position of the NPC

Status ( int id ) : Status

NPC's status

TPCurrent ( int id ) : short

NPC's current TP

Method Details

ClaimedID() public method

Server ID of the person who first claimed the mob
public ClaimedID ( int id ) : int
id int
return int

Distance() public method

NPC's distance from player
public Distance ( int id ) : double
id int
return double

GetPosition() public method

Gets the position of the NPC
public GetPosition ( int id ) : Position
id int
return Position

HPPCurrent() public method

NPC's current hit point percent
public HPPCurrent ( int id ) : short
id int
return short

IsActive() public method

Whether the NPC is active or not
public IsActive ( int id ) : bool
id int
return bool

IsClaimed() public method

Whether the NPC is claimed or not
public IsClaimed ( int id ) : bool
id int
return bool

NPCBit() public method

If the NPC is rendered on the screen
public NPCBit ( int id ) : byte
id int
return byte

NPCTools() public method

Constructor
public NPCTools ( int instanceID ) : System
instanceID int Instance ID generated from FFACE
return System

NPCType() public method

Type of NPC
public NPCType ( int id ) : NPCType
id int
return NPCType

Name() public method

Name of the NPC
public Name ( int id ) : string
id int
return string

PetID() public method

Uses player index to get PetID
public PetID ( int id ) : int
id int
return int

PosH() public method

H position of the NPC
public PosH ( int id ) : float
id int
return float

PosX() public method

X position of the NPC
public PosX ( int id ) : float
id int
return float

PosY() public method

Y position of the NPC
public PosY ( int id ) : float
id int
return float

PosZ() public method

Z position of the NPC
public PosZ ( int id ) : float
id int
return float

Status() public method

NPC's status
public Status ( int id ) : Status
id int
return Status

TPCurrent() public method

NPC's current TP
public TPCurrent ( int id ) : short
id int
return short