Difference between revisions of "Template:Function Table"

496 bytes removed ,  21:52, 1 December 2021
no edit summary
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Templates]]
[[Category:Papyrus]]
 
'''Member of:''' [[ObjectReference Script]]
'''Member of:''' [[ObjectReference Script]]


Line 6: Line 6:


== Syntax ==
== Syntax ==
<noinclude>
[[Category:Templates|Function-Papyrus]]
</noinclude>
<source lang="papyrus">
<source lang="papyrus">
bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native
bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native
Line 16: Line 19:


== Return Value ==
== Return Value ==
True if default activation processing was performed (and succeeded). Will return false if activation was blocked, or the activation failed for some other reason.
return info


== Examples ==
== Examples ==
Line 30: Line 33:


== Notes ==
== Notes ==
If the object reference has had activation processing blocked, this will still send the [[OnActivate - ObjectReference|OnActivate]] event to scripts attached to the object, but will ignore normal processing (i.e. picking up the object, opening the door, etc). Unless, of course, you have the abDefaultProcessingOnly parameter set to true, in which case ''no'' event is sent, and the block flag is ignored.
Some notes, a reference: [[OnActivate - ObjectReference|OnActivate]]


== See Also ==
== See Also ==
*[[ObjectReference Script]]
*[[ObjectReference Script]]
*[[UseIdleMarker (Procedure)]]
 
*[[Activate]]
<includeonly>
*[[Activate (Procedure)]]
[[Category:Scripting]]
*[[Activator]]
[[Category:Papyrus]]
*[[BlockActivation - ObjectReference]]
[[Category:Papyrus Functions]]
*[[OnActivate - ObjectReference]]
</includeonly>
149

edits