ISForageAction Class Reference

Inheritance diagram for ISForageAction:

Public Member Functions
boolean	isValid ()
boolean	waitToStart ()
void	update ()
void	stop ()
void	start ()
void	perform ()
void	forage ()
boolean	complete ()
number	getDuration ()
	ISForageAction (IsoPlayer character, ISForageIcon icon, ItemContainer targetContainer, boolean discardItems, string itemType)
Public Member Functions inherited from ISBaseTimedAction
boolean	isValidStart ()
void	isValid ()
boolean	isUsingTimeout ()
void	update ()
void	forceComplete ()
void	forceStop ()
void	forceCancel ()
number	getJobDelta ()
unknown	resetJobDelta ()
boolean	waitToStart ()
void	start ()
boolean	isStarted ()
void	stop ()
void	perform ()
number	getDuration ()
void	create ()
void	begin ()
void	setCurrentTime (number time)
void	setTime (number time)
number	adjustMaxTime (number maxTime)
void	setActionAnim (CharacterActionAnims|string _action, nil _displayItemModels)
void	setOverrideHandModels (InventoryItem _primaryHand, InventoryItem _secondaryHand, boolean _resetModel)
void	setOverrideHandModelsString (string _primaryHand, string _secondaryHand, boolean _resetModel)
void	overrideWeaponType ()
void	restoreWeaponType ()
void	setAnimVariable (string _key, string _val)
ISBaseTimedAction	addAfter (ISBaseTimedAction action)
void	beginAddingActions ()
boolean	endAddingActions ()
void	getDeltaModifiers (MoveDeltaModifiers deltas)
	ISBaseTimedAction (IsoPlayer character)
Public Member Functions inherited from ISBaseObject
void	initialise ()
ISBaseObject	derive (string type)
void	addEventListener (string _event, function _callback, unknown _target)
void	removeEventListener (string _event, function _callback)
void	triggerEvent (string _event, unknown ...)
void	clearEventListeners ()
	ISBaseObject ()

Public Attributes
integer	itemCount
ItemContainer	targetContainer
boolean	discardItems
ISForageIcon	icon
string	iconID
string	itemType
ISSearchManager	manager
ISForageIcon	forageIcon
umbrella::Foraging::ZoneData	zoneData
umbrella::Foraging::ItemDefinition	itemDef
number	maxTime
number	currentTime
boolean	started
Public Attributes inherited from ISBaseTimedAction
number	maxTime
LuaTimedActionNew	action
boolean	_isAddingActions
number	_numAddedActions
IsoPlayer	character
boolean	stopOnWalk
boolean	stopOnRun
boolean	stopOnAim
number	caloriesModifier
boolean	useProgressBar
boolean	forceProgressBar
boolean	loopedAction
Path	path
string	name
NetTimedAction	netAction
Public Attributes inherited from ISBaseObject
string	Type
table< string, table< function, unknown > >	__eventListeners

Constructor & Destructor Documentation

ISForageAction()

ISForageAction::ISForageAction	(	IsoPlayer	character,
		ISForageIcon	icon,
		ItemContainer	targetContainer,
		boolean	discardItems,
		string	itemType )

Member Function Documentation

complete()

boolean ISForageAction::complete

(

)

forage()

void ISForageAction::forage

(

)

getDuration()

number ISForageAction::getDuration

(

)

isValid()

boolean ISForageAction::isValid

(

)

perform()

void ISForageAction::perform

(

)

start()

void ISForageAction::start

(

)

stop()

void ISForageAction::stop

(

)

update()

void ISForageAction::update

(

)

waitToStart()

boolean ISForageAction::waitToStart

(

)

Member Data Documentation

currentTime

number ISForageAction::currentTime

discardItems

boolean ISForageAction::discardItems

forageIcon

ISForageIcon ISForageAction::forageIcon

icon

ISForageIcon ISForageAction::icon

iconID

string ISForageAction::iconID

itemCount

integer ISForageAction::itemCount

itemDef

umbrella::Foraging::ItemDefinition ISForageAction::itemDef

itemType

string ISForageAction::itemType

manager

ISSearchManager ISForageAction::manager

maxTime

number ISForageAction::maxTime

started

boolean ISForageAction::started

targetContainer

ItemContainer ISForageAction::targetContainer

zoneData

umbrella::Foraging::ZoneData ISForageAction::zoneData

---

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

• shared/Foraging/ISForageAction.yml