Editing BlockActivation - ObjectReference

[[Category:Scripting]]
[[Category:Papyrus]]
'''Member of:''' [[ObjectReference Script]]

Blocks, or unblocks, normal activation processing for this reference. References with blocked activation will still send [[OnActivate - ObjectReference|OnActivate]] events to scripts attached to them.

== Syntax ==
<syntaxhighlight lang="papyrus">
Function BlockActivation(bool abBlocked = True) native
</syntaxhighlight>

== Parameters ==
*abBlocked: Whether to block or unblock activation.
**'''Default''': True

== Return Value ==
None.

== Examples ==
<syntaxhighlight lang="papyrus">
; Blocks this door from processing activation normally
MyDoor.BlockActivation()
</syntaxhighlight>
<br/>
<syntaxhighlight lang="papyrus">
; Tells the door to handle activation normally
MyDoor.BlockActivation(false)
</syntaxhighlight>

== Notes ==
* If you block activation on a reference, the reference will no longer perform its "normal" activation processing. It won't be picked up, opened, etc. However, the script [[OnActivate - ObjectReference|OnActivate]] block will still run, but only on the same script which has the BlockActivation() function set. All other OnActivate() events in other scripts attached to the same reference will be ignored.

* Because of the way script events work, chances are that the object has already done (or ignored) its default activation processing by the time the script receives the event, so calling BlockActivation() on the object in the [[OnActivate - ObjectReference|OnActivate]] block will not affect the current activation.

* If a script calls [[Activate - ObjectReference|Activate]]() on an object reference which has blocked activation, the [[OnActivate - ObjectReference|OnActivate]] block on that script will run, but the object will not process activation normally. (Unless the default processing only parameter is true)

* BlockActivation does not disable the 'Activate' UI prompt on the object.

* If an ObjectReference which has BlockActivation() applied to it is linked to another ObjectReference which can be activated normally, this linked object will instead be activated (confirmed with a BlockActivation() applied to a note object that is linked to a book object, the book object was instead activated)

* '''IMPORTANT:''' If you call BlockActivation from a ReferenceAlias script for an alias that is pointing to an object, the activation block '''will not''' be automatically removed when the alias stops pointing at the object (such as when the quest ends).

== See Also ==
*[[ObjectReference Script]]
*[[Activate - ObjectReference]]
*[[IsActivationBlocked - ObjectReference]]