Difference between revisions of "MagicEffect Script"

Jump to navigation Jump to search

MagicEffect Script (edit)

Revision as of 01:24, 3 February 2014

5,588 bytes added ,  01:24, 3 February 2014
Added SKSE 1.7.0 functions
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
imported>CraftySentinel
(Added SKSE 1.7.0 functions)
Line 20: Line 20:
== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''String [[GetAssociatedSkill - MagicEffect|GetAssociatedSkill]]()'''
!style="text-align:left;"|Function
:*Obtains the skill that this magic effect is associated with.
!style="text-align:left;"|Description
 
|-
== SKSE Member Functions ==
|[[GetAssociatedSkill - MagicEffect|String '''GetAssociatedSkill'''()]]
 
|Obtains the skill that this magic effect is associated with.
:'''[[SetAssociatedSkill - MagicEffect|GetAssociatedSkill]](String ''skill'')'''
|-
:*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.
 
:'''[[SetResistance - MagicEffect|SetResistance]](String ''skill'')'''
:*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)
 
:'''[[SetEffectFlagSet - MagicEffect|SetEffectFlagSet]](Int ''flag'')'''
:*Sets the specified flag.
 
:'''[[ClearEffectFlagSet - MagicEffect|ClearEffectFlagSet]](Int ''flag'')'''
:*Clears the specified flag.
 
:'''Float [[GetCastTime - MagicEffect|GetCastTime]]()'''
:*Returns the casting time of this magic effect.
 
:'''[[SetCastTime - MagicEffect|SetCastTime]](Float ''castTime'')'''
:*Sets the casting time of this magic effect.
 
:'''Int [[GetSkillLevel - MagicEffect|GetSkillLevel]]()'''
:*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
 
:'''Int [[GetArea - MagicEffect|GetArea]]()'''
:*Returns the area of this effect
 
:'''[[SetArea - MagicEffect|SetArea]](Int ''area'')'''
:*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.
 
:'''[[SetSkillUsageMult - MagicEffect|SetSkillUsageMult]](Float ''usageMult'')'''
:*Sets the skill usage multiplier to the specified amount.
 
:'''Float [[GetBaseCost - MagicEffect|GetBaseCost]]()'''
:*Returns the base Magicka cost of the effect.
 
:'''[[SetBaseCost - MagicEffect|SetBaseCost]](Float ''cost'')'''
:*Sets the base Magicka cost of the effect.
 
:'''Light [[GetLight - MagicEffect|GetLight]]()'''
:*Returns the light object used while casting the effect.
 
:'''[[SetLight - MagicEffect|GetLight]](Light ''obj'')'''
:*Sets the light object used while casting the effect.
 
:'''EffectShader [[GetHitShader - MagicEffect|GetHitShader]]()'''
:*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.
 
:'''EffectShader [[GetEnchantShader - MagicEffect|GetEnchantShader]]()'''
:*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)
 
:'''Projectile [[GetProjectile- MagicEffect|GetProjectile]]()'''
:*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
 
:'''Explosion [[GetExplosion - MagicEffect|GetExplosion]]()'''
:*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.
 
:'''Art [[GetCastingArt - MagicEffect|GetCastingArt]]()'''
:*Returns the art that is shown on hands while casting.
 
:'''[[SetCastingArt - MagicEffect|SetCastingArt]](Art ''obj'')'''
:*Sets the casting art.
 
:'''Art [[GetHitEffectArt - MagicEffect|GetHitEffectArt]]()'''
:*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.
 
:'''Art [[GetEnchantArt - MagicEffect|GetEnchantArt]]()'''
:*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.
 
:'''ImpactDataSet [[GetImpactDataSet - MagicEffect|GetImpactDataSet]]()'''
:*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.
 
:'''Spell [[GetEquipAbility - MagicEffect|GetEquipAbility]]()'''
:*
 
:'''[[SetEquipAbility - MagicEffect|SetEquipAbility]](Spell ''obj'')'''
:*
 
:'''ImageSpaceModifier [[GetImageSpaceMod - MagicEffect|GetImageSpaceMod]]()'''
:*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.
 
:'''Perk [[GetPerk - MagicEffect|GetPerk]]()'''
:*
 
:'''[[SetPerk - MagicEffect|SetPerk]](Perk ''obj'')'''
:*


|}


== Events ==
== Events ==
None
None
== Notes ==
* The following is a list of all available flags for use with SetEffectFlag, ClearEffectFlag, IsEffectFlagSet functions:
<source  lang="papyrus">
Hostile 0x00000001
Recover  0x00000002
Detrimental  0x00000004
NoHitEvent  0x00000010
DispelKeywords  0x00000100
NoDuration  0x00000200
NoMagnitude  0x00000400
NoArea  0x00000800
FXPersist  0x00001000
GloryVisuals  0x00004000
HideInUI  0x00008000
NoRecast  0x00020000
Magnitude  0x00200000
Duration  0x00400000
Painless  0x04000000
NoHitEffect  0x08000000
NoDeathDispel  0x10000000
</source>
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/12887"

Navigation menu