AddKeyIfNeeded - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Checks this object's inventory for a key used by the parameter ObjectWithNeededKey. If this object does not have the key, it creates it and adds it to its inventory.

Syntax

Function AddKeyIfNeeded(ObjectReference ObjectWithNeededKey)
	key NeededKey = ObjectWithNeededKey.GetKey()
	if NeededKey != None
		if GetItemCount(NeededKey) == 0
			AddItem(NeededKey)
		EndIf
	EndIf
EndFunction

Parameters

  • ObjectWithNeededKey: The reference that is locked with a key. It will create a key to this object and add it to the calling object if the calling object doesn't already have one.

Return Value

None.

Examples

; Creates a key to BobsDoorRef and puts it in BobRef's inventory if BobRef doesn't already have that key in his inventory.
BobRef.AddKeyIfNeeded(BobsDoorRef)

See Also