GameObject¶
EEex_GameObject_ApplyEffect¶
Instance Name: applyEffect
Summary
Applies an effect to the given object
based on the args
table.
Parameters:
Name |
Type |
Default Value |
Description |
---|---|---|---|
object |
CGameObject |
The object to apply the effect to. |
|
args |
table |
The table that describes the effect to apply. |
Valid keys for the args
table are as follows:
Name |
Default Value |
Description |
---|---|---|
diceSize |
|
As per offset [+0x3C] of .EFF v2.0. |
duration |
|
As per offset [+0x28] of .EFF v2.0. |
durationType |
|
As per offset [+0x24] of .EFF v2.0. |
dwFlags |
|
As per offset [+0x20] of .EFF v2.0. |
effectAmount |
|
As per offset [+0x1C] of .EFF v2.0. |
effectID |
|
As per offset [+0x10] of .EFF v2.0. |
effectList |
|
If 1, adds the effect to the sprite’s timed list. |
immediateResolve |
|
Determines whether the engine immediately applies the effect during the |
m_casterLevel |
|
As per offset [+0xC8] of .EFF v2.0. |
m_effectAmount2 |
|
As per offset [+0x60] of .EFF v2.0. |
m_effectAmount3 |
|
As per offset [+0x64] of .EFF v2.0. |
m_effectAmount4 |
|
As per offset [+0x68] of .EFF v2.0. |
m_effectAmount5 |
|
As per offset [+0x6C] of .EFF v2.0. |
m_flags |
|
As per offset [+0x5C] of .EFF v2.0. |
m_maxLevel |
|
As per offset [+0x58] of .EFF v2.0. |
m_minLevel |
|
As per offset [+0x54] of .EFF v2.0. |
m_projectileType |
|
As per offset [+0xA0] of .EFF v2.0. |
m_res2 |
|
As per offset [+0x70] of .EFF v2.0. |
m_res3 |
|
As per offset [+0x78] of .EFF v2.0. |
m_school |
|
As per offset [+0x4C] of .EFF v2.0. |
m_scriptName |
|
As per offset [+0xA8] of .EFF v2.0. |
m_secondaryType |
|
As per offset [+0xD0] of .EFF v2.0. |
m_slotNum |
|
As per offset [+0xA4] of .EFF v2.0. |
m_sourceFlags |
|
As per offset [+0x9C] of .EFF v2.0. |
m_sourceRes |
|
As per offset [+0x94] of .EFF v2.0. |
m_sourceType |
|
As per offset [+0x90] of .EFF v2.0. |
noSave |
|
If true, the effect bypasses any immunities the sprite might have to its application. |
numDice |
|
As per offset [+0x38] of .EFF v2.0. |
probabilityLower |
|
As per offset [+0x2E] of .EFF v2.0. |
probabilityUpper |
|
As per offset [+0x2C] of .EFF v2.0. |
res |
|
As per offset [+0x30] of .EFF v2.0. |
saveMod |
|
As per offset [+0x44] of .EFF v2.0. |
savingThrow |
|
As per offset [+0x40] of .EFF v2.0. |
sourceID |
|
The object id of the effect’s source, as per |
sourceTarget |
|
The object id of the source’s target, as per |
sourceX |
|
As per offset [+0x80] of .EFF v2.0. |
sourceY |
|
As per offset [+0x84] of .EFF v2.0. |
special |
|
As per offset [+0x48] of .EFF v2.0. |
spellLevel |
|
As per offset [+0x18] of .EFF v2.0. |
targetType |
|
As per offset [+0x14] of .EFF v2.0. |
targetX |
|
As per offset [+0x88] of .EFF v2.0. |
targetY |
|
As per offset [+0x8C] of .EFF v2.0. |
EEex_GameObject_CastUserType¶
Aliases: EEex_GameObject_CastUT
Summary
Takes the given object
and returns a cast userdata that represents object
’s true type.
Most EEex functions will call this function before passing an object to the modder API.
Parameters:
Name |
Type |
Default Value |
Description |
---|---|---|---|
object |
CGameObject |
The object to cast. |
Return Values:
Type |
Description |
---|---|
CGameAIArea | CGameAIBase | CGameAIGame | CGameContainer | CGameDoor | CGameFireball3d | CGameSound | |
See summary. |
EEex_GameObject_Get¶
Summary
Returns the object associated with objectID
, or nil
if objectID
is invalid.
Parameters:
Name |
Type |
Default Value |
Description |
---|---|---|---|
objectID |
number |
The id of the object to fetch. |
Return Values:
Type |
Description |
---|---|
CGameAIArea | CGameAIBase | CGameAIGame | CGameContainer | CGameDoor | CGameFireball3d | CGameSound | |
See summary. |
EEex_GameObject_GetAllSelectedIDs¶
Warning
Deprecated: Use EEex_Sprite_GetAllSelectedIDs()
instead.
EEex_GameObject_GetClass¶
Instance Name: getClass
Summary
Returns the given object
’s class.
Parameters:
Name |
Type |
Default Value |
Description |
---|---|---|---|
object |
CGameObject |
The object whose class is being fetched. |
Return Values:
Type |
Description |
---|---|
number |
See summary. |
EEex_GameObject_GetSelected¶
Warning
Deprecated: Use EEex_Sprite_GetSelected()
instead.
EEex_GameObject_GetSelectedID¶
Warning
Deprecated: Use EEex_Sprite_GetSelectedID()
instead.
EEex_GameObject_GetUnderCursor¶
Summary
Returns the interactable object currently under the cursor, or nil
if none exists.
Return Values:
Type |
Description |
---|---|
CGameContainer | CGameDoor | CGameSprite | CGameTrigger | nil |
See summary. |
EEex_GameObject_GetUnderCursorID¶
Summary
Returns the id of the interactable object currently under the cursor, or -1
if none exists.
Return Values:
Type |
Description |
---|---|
number |
See summary. |
EEex_GameObject_IsSprite¶
Instance Name: isSprite
Summary
Returns whether the given object
is a sprite.
Parameters:
Name |
Type |
Default Value |
Description |
---|---|---|---|
object |
CGameObject |
The object to check. |
|
allowDead |
boolean |
|
Determines whether |
Return Values:
Type |
Description |
---|---|
boolean |
See summary. |
EEex_GameObject_IsSpriteID¶
Summary
Returns whether the given objectID
is associated with a sprite.
Parameters:
Name |
Type |
Default Value |
Description |
---|---|---|---|
objectID |
number |
The object id to check. |
|
allowDead |
boolean |
|
Determines whether the sprite associated with |
Return Values:
Type |
Description |
---|---|
boolean |
See summary. |
EEex_GameObject_IterateSelected¶
Warning
Deprecated: Use EEex_Sprite_IterateSelected()
instead.
EEex_GameObject_IterateSelectedIDs¶
Warning
Deprecated: Use EEex_Sprite_IterateSelectedIDs()
instead.