Difference between revisions of "MagicEffect Script"
→SKSE Member Functions
imported>Grimy Bunyip (→Notes) |
imported>Quindraco |
||
| Line 25: | Line 25: | ||
== SKSE Member Functions == | == SKSE Member Functions == | ||
: | :;[[SetAssociatedSkill - MagicEffect|SetAssociatedSkill]](String ''skill'') | ||
:*Set the skill associated with the magic effect (eg. Destruction, Restoration, NONE. ) | :*Set the skill associated with the magic effect (eg. Destruction, Restoration, NONE. ) | ||
:;String [[GetResistance - MagicEffect|GetResistance]]() | |||
: | |||
:*Returns the Resistance that this Magic Effect will be checked against when applied. | :*Returns the Resistance that this Magic Effect will be checked against when applied. | ||
:;[[SetResistance - MagicEffect|SetResistance]](String ''skill'') | |||
: | |||
:*Sets the Resistance that the magic effect will be checked against when applied (eg. MagicResist, PoisonResist or Resist Fire ) | :*Sets the Resistance that the magic effect will be checked against when applied (eg. MagicResist, PoisonResist or Resist Fire ) | ||
:;Bool [[IsEffectFlagSet - MagicEffect|IsEffectFlagSet]](Int ''flag'') | |||
: | |||
:*Checks to see if the specified flag is set (See [[MagicEffect Script#Notes|Notes]] for list of flags) | :*Checks to see if the specified flag is set (See [[MagicEffect Script#Notes|Notes]] for list of flags) | ||
:;[[SetEffectFlag - MagicEffect|SetEffectFlag]](Int ''flag'') | |||
: | |||
:*Sets the specified flag. | :*Sets the specified flag. | ||
:;[[ClearEffectFlag - MagicEffect|ClearEffectFlag]](Int ''flag'') | |||
: | |||
:*Clears the specified flag. | :*Clears the specified flag. | ||
:;Float [[GetCastTime - MagicEffect|GetCastTime]]() | |||
: | |||
:*Returns the casting time of this magic effect. | :*Returns the casting time of this magic effect. | ||
:;[[SetCastTime - MagicEffect|SetCastTime]](Float ''castTime'') | |||
: | |||
:*Sets the casting time of this magic effect. | :*Sets the casting time of this magic effect. | ||
:;Int [[GetSkillLevel - MagicEffect|GetSkillLevel]]() | |||
: | |||
:*Returns the minimum skill level required to use this magic effect. | :*Returns the minimum skill level required to use this magic effect. | ||
:;[[SetSkillLevel - MagicEffect|SetSkillLevel]](Int ''level'') | |||
: | |||
:*Sets the minimum skill level required to use this magic effect | :*Sets the minimum skill level required to use this magic effect | ||
:;Int [[GetArea - MagicEffect|GetArea]]() | |||
: | |||
:*Returns the area of this effect | :*Returns the area of this effect | ||
:;[[SetArea - MagicEffect|SetArea]](Int ''area'') | |||
: | |||
:*Sets the area of this effect | :*Sets the area of this effect | ||
:;Float [[GetSkillUsageMult - MagicEffect|GetSkillUsageMult]]() | |||
: | |||
:*Returns the skill usage multiplier which is used to calculate the amount of experience earned when using this spell. | :*Returns the skill usage multiplier which is used to calculate the amount of experience earned when using this spell. | ||
:;[[SetSkillUsageMult - MagicEffect|SetSkillUsageMult]](Float ''usageMult'') | |||
: | |||
:*Sets the skill usage multiplier to the specified amount. | :*Sets the skill usage multiplier to the specified amount. | ||
:;Float [[GetBaseCost - MagicEffect|GetBaseCost]]() | |||
: | |||
:*Returns the base Magicka cost of the effect. | :*Returns the base Magicka cost of the effect. | ||
:;[[SetBaseCost - MagicEffect|SetBaseCost]](Float ''cost'') | |||
: | |||
:*Sets the base Magicka cost of the effect. | :*Sets the base Magicka cost of the effect. | ||
:;Light [[GetLight - MagicEffect|GetLight]]() | |||
: | |||
:*Returns the light object used while casting the effect. | :*Returns the light object used while casting the effect. | ||
:;[[SetLight - MagicEffect|SetLight]](Light ''obj'') | |||
: | |||
:*Sets the light object used while casting the effect. | :*Sets the light object used while casting the effect. | ||
:;EffectShader [[GetHitShader - MagicEffect|GetHitShader]]() | |||
: | |||
:*Returns the EffectShader that is applied to an Actor when hit. | :*Returns the EffectShader that is applied to an Actor when hit. | ||
:;[[SetHitShader - MagicEffect|SetHitShader]](EffectShader ''obj'') | |||
: | |||
:*Sets the Effectshader used when an Actor is hit. | :*Sets the Effectshader used when an Actor is hit. | ||
:;EffectShader [[GetEnchantShader - MagicEffect|GetEnchantShader]]() | |||
: | |||
:*Returns the EffectShader which is attached to the enchanted object (Only shown for Enchantments) | :*Returns the EffectShader which is attached to the enchanted object (Only shown for Enchantments) | ||
:;[[SetEnchantShader - MagicEffect|SetEnchantShader]](EffectShader ''obj'') | |||
: | |||
:*Sets the EffectShader which is attached to the enchanted object (Only shown for Enchantments) | :*Sets the EffectShader which is attached to the enchanted object (Only shown for Enchantments) | ||
:;Projectile [[GetProjectile- MagicEffect|GetProjectile]]() | |||
: | |||
:*Returns the projectile form which is fired by the effect | :*Returns the projectile form which is fired by the effect | ||
:;[[SetProjectile - MagicEffect|SetProjectile]](Projectile ''obj'') | |||
: | |||
:*Sets the projectile form which is fired by the effect | :*Sets the projectile form which is fired by the effect | ||
:;Explosion [[GetExplosion - MagicEffect|GetExplosion]]() | |||
: | |||
:*Returns the explosion object that is created when the projectile of the effect hits an object | :*Returns the explosion object that is created when the projectile of the effect hits an object | ||
:;[[SetExplosion - MagicEffect|SetExplosion]](Explosion ''obj'') | |||
: | |||
:*Sets the explosion object. | :*Sets the explosion object. | ||
:;Art [[GetCastingArt - MagicEffect|GetCastingArt]]() | |||
: | |||
:*Returns the art that is shown on hands while casting. | :*Returns the art that is shown on hands while casting. | ||
:;[[SetCastingArt - MagicEffect|SetCastingArt]](Art ''obj'') | |||
: | |||
:*Sets the casting art. | :*Sets the casting art. | ||
:;Art [[GetHitEffectArt - MagicEffect|GetHitEffectArt]]() | |||
: | |||
:*Returns the art object that is applied to the target of the effect on impact. | :*Returns the art object that is applied to the target of the effect on impact. | ||
:;[[SetHitEffectArt - MagicEffect|SetHitEffectArt]](Art ''obj'') | |||
: | |||
:*Sets the art object that is applied to the target. | :*Sets the art object that is applied to the target. | ||
:;Art [[GetEnchantArt - MagicEffect|GetEnchantArt]]() | |||
: | |||
:*Returns the art object that is attached to the enchanted object. (Only shown for enchantments) | :*Returns the art object that is attached to the enchanted object. (Only shown for enchantments) | ||
:;[[SetEnchantArt - MagicEffect|SetEnchantArt]](Art ''obj'') | |||
: | |||
:*Sets the art object that is attached to the enchanted object. | :*Sets the art object that is attached to the enchanted object. | ||
:;ImpactDataSet [[GetImpactDataSet - MagicEffect|GetImpactDataSet]]() | |||
: | |||
:*Returns the impact data set that is used by the effect to determine which (if any) decals should be applied. | :*Returns the impact data set that is used by the effect to determine which (if any) decals should be applied. | ||
:;[[SetImpactDataSet - MagicEffect|SetImpactDataSet]](ImpactDataSet ''obj'') | |||
: | |||
:* Sets the impact data set for the effect. | :* Sets the impact data set for the effect. | ||
:;Spell [[GetEquipAbility - MagicEffect|GetEquipAbility]]() | |||
: | |||
:*Returns the Ability-Type spell that is applied to the actor who equips a spell or enchanted item that uses this Magic Effect. | :*Returns the Ability-Type spell that is applied to the actor who equips a spell or enchanted item that uses this Magic Effect. | ||
:;[[SetEquipAbility - MagicEffect|SetEquipAbility]](Spell ''obj'') | |||
: | |||
:*Sets the Equip Ability of this Magic Effect. | :*Sets the Equip Ability of this Magic Effect. | ||
:;ImageSpaceModifier [[GetImageSpaceMod - MagicEffect|GetImageSpaceMod]]() | |||
: | |||
:*Returns the image space modifier that is used by the effect. | :*Returns the image space modifier that is used by the effect. | ||
:;[[SetImageSpaceMod - MagicEffect|SetImageSpaceMod]](ImageSpaceModifier ''obj'') | |||
: | |||
:*Sets the image space modifier that is used by the Effect. | :*Sets the image space modifier that is used by the Effect. | ||
:;Perk [[GetPerk - MagicEffect|GetPerk]]() | |||
: | |||
:*Returns the Perk that is applied to actors who are affected by this active effect. (Only works on the Player, Perks will not be applied to other NPCs). | :*Returns the Perk that is applied to actors who are affected by this active effect. (Only works on the Player, Perks will not be applied to other NPCs). | ||
:;[[SetPerk - MagicEffect|SetPerk]](Perk ''obj'') | |||
: | |||
:*Sets the Perk to be applied to actors who are affected by this active effect. | :*Sets the Perk to be applied to actors who are affected by this active effect. | ||
:;int [[GetCastingType - MagicEffect|GetCastingType]]() | |||
: | |||
:* Constant Effect 0 ; Fire And Forget 1 ; Concentration 2 | :* Constant Effect 0 ; Fire And Forget 1 ; Concentration 2 | ||
:;int [[GetDeliveryType- MagicEffect|GetDeliveryType]]() | |||
: | |||
:* Self 0; Contact 1; Aimed 2; Target Actor 3; Target Location 4 | :* Self 0; Contact 1; Aimed 2; Target Actor 3; Target Location 4 | ||