Planeshift
psWorkGameEvent Class Reference

work event class More...

#include <workmanager.h>

Public Member Functions

virtual void DeleteObjectCallback (iDeleteNotificationObject *object)
 
float GetKFactor ()
 pattern Kfactor is based on the current pattern More...
 
psTradeProcessesGetProcess ()
 Return the active process, if any for this event. More...
 
float GetResultQuality ()
 result quality is calculated immediately before the event More...
 
int GetResultQuantity ()
 result quantity is only used when transaction result is zero More...
 
gemObjectGetTargetGem ()
 
psItemGetTranformationItem ()
 
psTradeTransformationsGetTransformation ()
 Return the active transformation, if any for this event. More...
 
INVENTORY_SLOT_NUMBER GetTransformationSlot ()
 slot to perform the transformation More...
 
int GetTransformationType ()
 transformation type More...
 
psItemGetWorkItem ()
 
void Interrupt ()
 
 psWorkGameEvent (WorkManager *mgr, gemActor *worker, int delayticks, int cat, csVector3 &pos, csArray< NearNaturalResource > *natres=NULL, Client *c=NULL, psItem *object=NULL, float repairAmount=0.0F)
 
void SetKFactor (float newFactor)
 
void SetProcess (psTradeProcesses *p)
 Set the active trade process for the event. More...
 
void SetResultQuality (float newQuality)
 
void SetResultQuantity (int newQuantity)
 
void SetTargetGem (gemObject *g)
 
void SetTransformation (psTradeTransformations *t)
 Set the active trade transformation for the event. More...
 
void SetTransformationItem (psItem *i)
 
void SetTransformationSlot (INVENTORY_SLOT_NUMBER curSlot)
 
void SetTransformationType (int t)
 
void SetWorkItem (psItem *w)
 
virtual void Trigger ()
 Abstract event processing function. More...
 
virtual ~psWorkGameEvent ()
 
- Public Member Functions inherited from psGameEvent
virtual bool CheckTrigger ()
 Called right before a Trigger is called. More...
 
const char * GetType ()
 Return the type that this event where created with. More...
 
virtual bool IsValid ()
 Return the valid flag. More...
 
bool operator< (const psGameEvent &other) const
 
bool operator== (const psGameEvent &other) const
 
bool operator> (const psGameEvent &other) const
 
 psGameEvent (csTicks ticks, int offsetticks, const char *newType)
 Construct a new game event. More...
 
void QueueEvent ()
 Publish the game event to the local program. More...
 
virtual void SetValid (bool valid)
 Set the valid flag. More...
 
virtual csString ToString () const
 Return a string with information about the event. More...
 
virtual ~psGameEvent ()
 
- Public Member Functions inherited from iDeleteObjectCallback
virtual ~iDeleteObjectCallback ()
 

Public Attributes

int category
 
Clientclient
 
uint32_t effectID
 The id of the psEffect tied to event. More...
 
gemObjectgemTarget
 
csArray< PublishDestinationmulti
 
csArray< NearNaturalResourcenrr
 
psItemobject
 
csVector3 position
 
psTradeProcessesprocess
 
float repairAmount
 
psTradeTransformationstransformation
 
csWeakRef< gemActorworker
 
WorkManagerworkmanager
 
- Public Attributes inherited from psGameEvent
csTicks delayticks
 delay before the event starts More...
 
int id
 id value combined with ticks ensures uniqueness for tree More...
 
csTicks triggerticks
 ticks value when event should be triggered. More...
 
bool valid
 Set this to false if the trigger should not be fired. More...
 

Additional Inherited Members

- Static Public Attributes inherited from psGameEvent
static EventManagereventmanager
 
static int nextid
 id counter sequence More...
 

Detailed Description

work event class

Definition at line 708 of file workmanager.h.

Constructor & Destructor Documentation

psWorkGameEvent::psWorkGameEvent ( WorkManager mgr,
gemActor worker,
int  delayticks,
int  cat,
csVector3 &  pos,
csArray< NearNaturalResource > *  natres = NULL,
Client c = NULL,
psItem object = NULL,
float  repairAmount = 0.0F 
)
virtual psWorkGameEvent::~psWorkGameEvent ( )
virtual

Member Function Documentation

virtual void psWorkGameEvent::DeleteObjectCallback ( iDeleteNotificationObject object)
virtual

Implements iDeleteObjectCallback.

float psWorkGameEvent::GetKFactor ( )
inline

pattern Kfactor is based on the current pattern

Definition at line 773 of file workmanager.h.

psTradeProcesses* psWorkGameEvent::GetProcess ( )
inline

Return the active process, if any for this event.

Definition at line 747 of file workmanager.h.

float psWorkGameEvent::GetResultQuality ( )
inline

result quality is calculated immediately before the event

Definition at line 763 of file workmanager.h.

int psWorkGameEvent::GetResultQuantity ( )
inline

result quantity is only used when transaction result is zero

Definition at line 753 of file workmanager.h.

gemObject* psWorkGameEvent::GetTargetGem ( )
inline

Definition at line 810 of file workmanager.h.

psItem* psWorkGameEvent::GetTranformationItem ( )
inline

Definition at line 792 of file workmanager.h.

psTradeTransformations* psWorkGameEvent::GetTransformation ( )
inline

Return the active transformation, if any for this event.

Definition at line 735 of file workmanager.h.

INVENTORY_SLOT_NUMBER psWorkGameEvent::GetTransformationSlot ( )
inline

slot to perform the transformation

Definition at line 783 of file workmanager.h.

int psWorkGameEvent::GetTransformationType ( )
inline

transformation type

Definition at line 820 of file workmanager.h.

psItem* psWorkGameEvent::GetWorkItem ( )
inline

Definition at line 801 of file workmanager.h.

void psWorkGameEvent::Interrupt ( )
void psWorkGameEvent::SetKFactor ( float  newFactor)
inline

Definition at line 777 of file workmanager.h.

void psWorkGameEvent::SetProcess ( psTradeProcesses p)
inline

Set the active trade process for the event.

Definition at line 741 of file workmanager.h.

void psWorkGameEvent::SetResultQuality ( float  newQuality)
inline

Definition at line 767 of file workmanager.h.

void psWorkGameEvent::SetResultQuantity ( int  newQuantity)
inline

Definition at line 757 of file workmanager.h.

void psWorkGameEvent::SetTargetGem ( gemObject g)
inline

Definition at line 814 of file workmanager.h.

void psWorkGameEvent::SetTransformation ( psTradeTransformations t)
inline

Set the active trade transformation for the event.

Definition at line 729 of file workmanager.h.

void psWorkGameEvent::SetTransformationItem ( psItem i)
inline

Definition at line 796 of file workmanager.h.

void psWorkGameEvent::SetTransformationSlot ( INVENTORY_SLOT_NUMBER  curSlot)
inline

Definition at line 787 of file workmanager.h.

void psWorkGameEvent::SetTransformationType ( int  t)
inline

Definition at line 824 of file workmanager.h.

void psWorkGameEvent::SetWorkItem ( psItem w)
inline

Definition at line 805 of file workmanager.h.

virtual void psWorkGameEvent::Trigger ( )
virtual

Abstract event processing function.

Implements psGameEvent.

Member Data Documentation

int psWorkGameEvent::category

Definition at line 834 of file workmanager.h.

Client* psWorkGameEvent::client

Definition at line 832 of file workmanager.h.

uint32_t psWorkGameEvent::effectID

The id of the psEffect tied to event.

Definition at line 841 of file workmanager.h.

gemObject* psWorkGameEvent::gemTarget

Definition at line 833 of file workmanager.h.

csArray<PublishDestination> psWorkGameEvent::multi

Definition at line 842 of file workmanager.h.

csArray<NearNaturalResource> psWorkGameEvent::nrr

Definition at line 831 of file workmanager.h.

psItem* psWorkGameEvent::object

Definition at line 836 of file workmanager.h.

csVector3 psWorkGameEvent::position

Definition at line 835 of file workmanager.h.

psTradeProcesses* psWorkGameEvent::process

Definition at line 838 of file workmanager.h.

float psWorkGameEvent::repairAmount

Definition at line 839 of file workmanager.h.

psTradeTransformations* psWorkGameEvent::transformation

Definition at line 837 of file workmanager.h.

csWeakRef<gemActor> psWorkGameEvent::worker

Definition at line 830 of file workmanager.h.

WorkManager* psWorkGameEvent::workmanager

Definition at line 829 of file workmanager.h.


The documentation for this class was generated from the following file: