Description
Wiki Description
Checks to see if the specified keyword is attached to this form.
Documentation Comment
Returns if this form has the specified keyword attached
Caveats
CK Wiki - Notes
- If run on a Spell, this function checks all attached magic effects, and returns true if at least one magic effect has a specified keyword.
- If run on an Ingredient or a Potion, this function does not checks attached magic effects, only the record itself.
Parameters
Examples
ScriptName ExampleScript Extends ObjectReference
Keyword Property DoomKeywordProperty Auto
Event OnItemAdded(Form akBaseItem, Int aiItemCount, ObjectReference akFormReference, ObjectReference akSourceContainer)
If akBaseItem.HasKeyword(DoomKeywordProperty) ; Does the added object have a doom keyword?
Debug.Trace("The added sword is a doom sword")
EndIf
EndEvent
;Check if the current location has a keyword.
Keyword property LocTypeHouse auto
Bool Function CurrentLocationHasKeyword(ObjectReference akRef, Keyword akKeyword)
Location kCurrentLoc = akRef.GetCurrentLocation()
if (kCurrentLoc == none)
return false
endif
if kCurrentLoc.HasKeyword(akKeyword)
return true
else
return false
endif
EndFunction
debug.trace("Is this location a house?: " +CurrentLocationHasKeyword(Game.GetPlayer(), LocTypeHouse))Auto-Generated Example
Keyword myKeyword__akKeyword
bool returnedValue = myForm__toCallFunctionOn.HasKeyword(myKeyword__akKeyword)