Sprite

EEex_Sprite_AddMarshalHandlers

Warning

This function is currently undocumented.

EEex_Sprite_AddQuickListCountsResetListener

Warning

This function is currently undocumented.

EEex_Sprite_AddQuickListNotifyRemovedListener

Warning

This function is currently undocumented.

EEex_Sprite_AddQuickListsCheckedListener

Warning

This function is currently undocumented.

EEex_Sprite_AddSpellDisableStateChangedListener

Warning

This function is currently undocumented.

EEex_Sprite_CountAllOfTypeInRange

Instance Name: countAllOfTypeInRange

Summary

Returns the number of creatures that match aiObjectType around sprite in the given range, as per the NumCreature() trigger.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite to search around.
aiObjectType	CAIObjectType		The AI object type used to filter the objects passed to func. Most commonly retrieved from EEex_Object_ParseString(). Remember to call :free().
range	number		The radius to search around sprite. 448 is a sprite’s default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from sprite to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	sprite:virtual_GetVisibleTerrainTable()	The terrain table to use for determining LOS.

Return Values:

Type	Description
number	See summary.

EEex_Sprite_CountAllOfTypeStringInRange

Instance Name: countAllOfTypeStringInRange

Summary

Returns the number of creatures that match aiObjectTypeString around sprite in the given range, as per the NumCreature() trigger.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite to search around.
aiObjectTypeString	string		The AI object type string used to filter the objects added to the return table. Automatically parsed by EEex_Object_ParseString(); the resulting object is freed before return.
range	number		The radius to search around sprite. 448 is a sprite’s default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from sprite to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	sprite:virtual_GetVisibleTerrainTable()	The terrain table to use for determining LOS.

Return Values:

Type	Description
number	See summary.

EEex_Sprite_ForAllOfTypeInRange

Instance Name: forAllOfTypeInRange

Summary

Calls func for every creature that matches aiObjectType around sprite in the given range, as per the NumCreature() trigger.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite to search around.
aiObjectType	CAIObjectType		The AI object type used to filter the objects passed to func. Most commonly retrieved from EEex_Object_ParseString(). Remember to call :free().
range	number		The radius to search around sprite. 448 is a sprite’s default visual range.
func	function		The function to call for every creature in the search area.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from sprite to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	sprite:virtual_GetVisibleTerrainTable()	The terrain table to use for determining LOS.

EEex_Sprite_ForAllOfTypeStringInRange

Instance Name: forAllOfTypeStringInRange

Summary

Calls func for every creature that matches aiObjectTypeString around sprite in the given range, as per the NumCreature() trigger.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite to search around.
aiObjectTypeString	string		The AI object type string used to filter the objects passed to func. Automatically parsed by EEex_Object_ParseString(); the resulting object is freed before return.
range	number		The radius to search around sprite. 448 is a sprite’s default visual range.
func	function		The function to call for every creature in the search area.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from sprite to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	sprite:virtual_GetVisibleTerrainTable()	The terrain table to use for determining LOS.

EEex_Sprite_GetActiveStats

Instance Name: getActiveStats

Summary

Returns the given sprite’s active stats structure. If the creature is in the middle of an effects list process, using this function ensures that the work-in-progress stats structure isn’t used.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite whose stats structure is being fetched.

Return Values:

Type	Description
CDerivedStats	See summary.

EEex_Sprite_GetAllOfTypeInRange

Instance Name: getAllOfTypeInRange

Summary

Returns a table populated by every creature that matches aiObjectType around sprite in the given range, as per the NumCreature() trigger.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite to search around.
aiObjectType	CAIObjectType		The AI object type used to filter the objects passed to func. Most commonly retrieved from EEex_Object_ParseString(). Remember to call :free().
range	number		The radius to search around sprite. 448 is a sprite’s default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from sprite to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	sprite:virtual_GetVisibleTerrainTable()	The terrain table to use for determining LOS.

Return Values:

Type	Description
table	See summary.

EEex_Sprite_GetAllOfTypeStringInRange

Instance Name: getAllOfTypeStringInRange

Summary

Returns a table populated by every creature that matches aiObjectTypeString around sprite in the given range, as per the NumCreature() trigger.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite to search around.
aiObjectTypeString	string		The AI object type string used to filter the objects added to the return table. Automatically parsed by EEex_Object_ParseString(); the resulting object is freed before return.
range	number		The radius to search around sprite. 448 is a sprite’s default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from sprite to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	sprite:virtual_GetVisibleTerrainTable()	The terrain table to use for determining LOS.

Return Values:

Type	Description
table	See summary.

EEex_Sprite_GetAllSelectedIDs

Summary

Returns a table populated with the object ids of all the sprites the player currently has selected and is controlling.

Return Values:

Type	Description
table	See summary.

EEex_Sprite_GetCasterLevelForSpell

Warning

This function is currently undocumented.

EEex_Sprite_GetCastTimer

Warning

This function is currently undocumented.

EEex_Sprite_GetCastTimerPercentage

Warning

This function is currently undocumented.

EEex_Sprite_GetContingencyTimer

Warning

This function is currently undocumented.

EEex_Sprite_GetContingencyTimerPercentage

Warning

This function is currently undocumented.

EEex_Sprite_GetExtendedStat

Instance Name: getExtendedStat .. warning:

**Deprecated:** Use ``EEex_Sprite_GetStat()`` instead.

Summary

Returns the value of the extended stat on the given sprite.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite whose extended stat value is being fetched.

Return Values:

Type	Description
number	See summary.

EEex_Sprite_GetInPortrait

Summary

Returns the sprite of the party member in the given portraitIndex, or nil if none exists.

Parameters:

Name	Type	Default Value	Description
portraitIndex	number		The portrait index of the sprite to fetch; valid values are [0-5].

Return Values:

Type	Description
CGameSprite | nil	See summary.

EEex_Sprite_GetInPortraitID

Summary

Returns the object id of the party member in the given portraitIndex, or -1 if none exists.

Parameters:

Name	Type	Default Value	Description
portraitIndex	number		The portrait index of the sprite to fetch; valid values are [0-5].

Return Values:

Type	Description
number	See summary.

EEex_Sprite_GetKnownInnateSpellsIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetKnownInnateSpellsWithAbilityIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetKnownMageSpellsIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetKnownMageSpellsWithAbilityIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetKnownPriestSpellsIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetKnownPriestSpellsWithAbilityIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetLauncher

Warning

This function is currently undocumented.

EEex_Sprite_GetLocalInt

Warning

This function is currently undocumented.

EEex_Sprite_GetLocalString

Warning

This function is currently undocumented.

EEex_Sprite_GetModalState

Warning

This function is currently undocumented.

EEex_Sprite_GetModalTimer

Warning

This function is currently undocumented.

EEex_Sprite_GetModalTimerPercentage

Warning

This function is currently undocumented.

EEex_Sprite_GetName

Warning

This function is currently undocumented.

EEex_Sprite_GetNumCharacters

Summary

Returns the number of characters currently in the party.

Return Values:

Type	Description
number	See summary.

EEex_Sprite_GetPortraitIndex

Instance Name: getPortraitIndex

Summary

Returns the given sprite’s portrait index, or -1 if it isn’t a party member.

Parameters:

Name	Type	Default Value	Description
sprite	CGameSprite		The sprite whose portrait index is being fetched.

Return Values:

Type	Description
number	See summary.

EEex_Sprite_GetSelected

Summary

Returns the sprite that is the “leader” of the sprites the player currently has selected and is controlling.

The leader is the party member with the highest portrait slot, (lowest index), or the creature that was selected first.

If no creatures are currently selected, returns nil.

Return Values:

Type	Description
CGameSprite | nil	See summary.

EEex_Sprite_GetSelectedID

Summary

Returns the object id associated with the “leader” of the sprites the player currently has selected and is controlling.

The leader is the party member with the highest portrait slot, (lowest index), or the creature that was selected first.

If no creatures are currently selected, returns -1.

Return Values:

Type	Description
number	See summary.

EEex_Sprite_GetSpellButtonDataIteratorFrom2DA

Warning

This function is currently undocumented.

EEex_Sprite_GetSpellState

Warning

This function is currently undocumented.

EEex_Sprite_GetSpellsWithAbilityIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetStat

Warning

This function is currently undocumented.

EEex_Sprite_GetState

Warning

This function is currently undocumented.

EEex_Sprite_GetValidKnownInnateSpellsIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetValidKnownMageSpellsIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetValidKnownPriestSpellsIterator

Warning

This function is currently undocumented.

EEex_Sprite_GetValidSpellsWithAbilityIterator

Warning

This function is currently undocumented.

EEex_Sprite_IterateSelected

Summary

Calls func for every sprite the player currently has selected and is controlling, (passing the sprite). Return true from func to stop iteration.

Parameters:

Name	Type	Default Value	Description
func	function		The function to call.

EEex_Sprite_IterateSelectedIDs

Summary

Calls func for every sprite the player currently has selected and is controlling, (passing the sprite’s object id). Return true from func to stop iteration.

Parameters:

Name	Type	Default Value	Description
func	function		The function to call.

EEex_Sprite_LuaHook_OnSpellDisableStateChanged

Warning

This function is currently undocumented.

EEex_Sprite_OpenOp214Interface

Warning

This function is currently undocumented.

EEex_Sprite_SetLocalInt

Warning

This function is currently undocumented.

EEex_Sprite_SetLocalString

Warning

This function is currently undocumented.