Difference between revisions of "PlayerKnows - Form"
Jump to navigation
Jump to search
imported>Rhavlovick m (1 revision: Clobber re-import by Henning) |
imported>Egocarib (added Enchantments as a valid type for function) |
||
| Line 3: | Line 3: | ||
'''Member of:''' [[Form Script]] | '''Member of:''' [[Form Script]] | ||
Is the "Known" flag set for this form? This is used for [[MagicEffect Script|Magic Effects]] | Is the "Known" flag set for this form? This is used for [[MagicEffect Script|Magic Effects]], [[WordOfPower Script|Words of Power]], and [[Enchantment Script|Enchantments]]. | ||
== Syntax == | == Syntax == | ||
| Line 23: | Line 23: | ||
endIf | endIf | ||
</source> | </source> | ||
== Notes == | |||
*When using this function on an Enchantment, keep in mind that the actual enchantment that is known by the player is usually only the "Base" version of the Enchantment - and it is this Base Enchantment that must be tested for this function to return the correct value. | |||
== See Also == | == See Also == | ||
*[[Form Script]] | *[[Form Script]] | ||
Latest revision as of 15:42, 16 November 2013
Member of: Form Script
Is the "Known" flag set for this form? This is used for Magic Effects, Words of Power, and Enchantments.
Syntax[edit | edit source]
bool Function PlayerKnows() nativeParameters[edit | edit source]
None
Return Value[edit | edit source]
Whether or not the Known flag is set on the form.
Examples[edit | edit source]
; Does the player know this effect?
if CoolMagicEffect.PlayerKnows()
Debug.Trace("Player knows the cool effect")
endIfNotes[edit | edit source]
- When using this function on an Enchantment, keep in mind that the actual enchantment that is known by the player is usually only the "Base" version of the Enchantment - and it is this Base Enchantment that must be tested for this function to return the correct value.