PlayerKnows - Form

From Creation Kit
Jump to: navigation, search

Member of: Form Script

Is the "Known" flag set for this form? This is used for Magic Effects, Words of Power, and Enchantments.

Syntax

bool Function PlayerKnows() native

Parameters

None

Return Value

Whether or not the Known flag is set on the form.

Examples

; Does the player know this effect?
if CoolMagicEffect.PlayerKnows()
  Debug.Trace("Player knows the cool effect")
endIf

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