Difference between revisions of "Template:Function Table"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
[[Category: | [[Category:Templates]] | ||
'''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 == | ||
return info | |||
== Examples == | == Examples == | ||
| Line 30: | Line 33: | ||
== Notes == | == Notes == | ||
Some notes, a reference: [[OnActivate - ObjectReference|OnActivate]] | |||
== See Also == | == See Also == | ||
*[[ObjectReference Script]] | *[[ObjectReference Script]] | ||
<includeonly> | |||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Papyrus Functions]] | |||
</includeonly> | |||
Latest revision as of 21:52, 1 December 2021
Member of: ObjectReference Script
Activates this item with the specified reference as the activator.
Syntax[edit source]
bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) nativeParameters[edit source]
- akActivator: Who will activate this object.
- abDefaultProcessingOnly: If true, no OnActivate event will be sent to any scripts and the object will ignore the blocked flag.
- Default: False
Return Value[edit source]
return info
Examples[edit source]
; Have the player 'activate' the door
NeatDoor.Activate(Game.GetPlayer())
; Have the player 'activate' the door, bypassing any blocked activation and NOT sending an event to any script
NeatDoor.Activate(Game.GetPlayer(), true)Notes[edit source]
Some notes, a reference: OnActivate
See Also[edit source]