Area

EEex_Area_CountAllOfTypeInRange

Instance Name: countAllOfTypeInRange

Summary

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

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area to search.
centerX	number		The x coordinate to use as the center of the search radius.
centerY	number		The y coordinate to use as the center of the search radius.
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 (centerX, centerY). 448 is a sprite's default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from (centerX, centerY) to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	CGameObject.DEFAULT_VISIBLE_TERRAIN_TABLE	The terrain table to use for determining LOS.

Return Values:

Type	Description
number	See summary.

EEex_Area_CountAllOfTypeStringInRange

Instance Name: countAllOfTypeStringInRange

Summary

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

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area to search.
centerX	number		The x coordinate to use as the center of the search radius.
centerY	number		The y coordinate to use as the center of the search radius.
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 (centerX, centerY). 448 is a sprite's default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from (centerX, centerY) to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	CGameObject.DEFAULT_VISIBLE_TERRAIN_TABLE	The terrain table to use for determining LOS.

Return Values:

Type	Description
number	See summary.

EEex_Area_CreateVisualEffect

Warning

This function is currently undocumented.

EEex_Area_ForAllOfTypeInRange

Instance Name: forAllOfTypeInRange

Summary

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

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area to search.
centerX	number		The x coordinate to use as the center of the search radius.
centerY	number		The y coordinate to use as the center of the search radius.
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 (centerX, centerY). 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 (centerX, centerY) to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	CGameObject.DEFAULT_VISIBLE_TERRAIN_TABLE	The terrain table to use for determining LOS.

EEex_Area_ForAllOfTypeStringInRange

Instance Name: forAllOfTypeStringInRange

Summary

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

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area to search.
centerX	number		The x coordinate to use as the center of the search radius.
centerY	number		The y coordinate to use as the center of the search radius.
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 (centerX, centerY). 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 (centerX, centerY) to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	CGameObject.DEFAULT_VISIBLE_TERRAIN_TABLE	The terrain table to use for determining LOS.

EEex_Area_GetAllOfTypeInRange

Instance Name: getAllOfTypeInRange

Summary

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

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area to search.
centerX	number		The x coordinate to use as the center of the search radius.
centerY	number		The y coordinate to use as the center of the search radius.
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 (centerX, centerY). 448 is a sprite's default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from (centerX, centerY) to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	CGameObject.DEFAULT_VISIBLE_TERRAIN_TABLE	The terrain table to use for determining LOS.

Return Values:

Type	Description
table	See summary.

EEex_Area_GetAllOfTypeStringInRange

Instance Name: getAllOfTypeStringInRange

Summary

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

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area to search.
centerX	number		The x coordinate to use as the center of the search radius.
centerY	number		The y coordinate to use as the center of the search radius.
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 (centerX, centerY). 448 is a sprite's default visual range.
bCheckForLineOfSight	boolean	true	Determines whether LOS is required from (centerX, centerY) to considered objects.
bCheckForNonSprites	boolean	false	Determines whether non-sprite objects in the main objects list are considered.
terrainTable	Array<byte,16>	CGameObject.DEFAULT_VISIBLE_TERRAIN_TABLE	The terrain table to use for determining LOS.

Return Values:

Type	Description
table	See summary.

EEex_Area_GetNearestOpenPosition

Warning

This function is currently undocumented.

EEex_Area_GetVariableInt

Instance Name: getVariableInt

Summary

Returns the integer value of the variableName Global scoped to area. If no variable named variableName exists, returns 0.

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area that the variable being fetched is scoped to.
variableName	string		The name of the variable to fetch.

Return Values:

Type	Description
number	See summary.

EEex_Area_GetVariableString

Instance Name: getVariableString

Summary

Returns the string value of the variableName Global scoped to area. If no variable named variableName exists, returns "".

Note

Global string values can only be accessed through EEex functions.

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area that the variable being fetched is scoped to.
variableName	string		The name of the variable to fetch.

Return Values:

Type	Description
string	See summary.

EEex_Area_GetVisible

Summary

Returns the currently-visible CGameArea, or nil if the worldscreen is not initialized.

Return Values:

Type	Description
CGameArea | nil	See summary.

EEex_Area_SetVariableInt

Instance Name: setVariableInt

Summary

Sets the integer value of the variableName Global scoped to area to value.

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area that the variable being set is scoped to.
variableName	string		The name of the variable to set.
value	number		The value to set the variable to.

EEex_Area_SetVariableString

Instance Name: setVariableString

Summary

Sets the string value of the variableName Global scoped to area to value.

Note

Global string values can only be accessed through EEex functions.

Warning

Global string values can be a maximum of 32 characters. Attempting to set a value that is longer than 32 characters will result in the value being truncated.

Parameters:

Name	Type	Default Value	Description
area	CGameArea		The area that the variable being set is scoped to.
variableName	string		The name of the variable to set.
value	string		The value to set the variable to.