Editing
Activate - ObjectReference
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
[[Category:Scripting]] [[Category:Papyrus]] '''Member of:''' [[ObjectReference Script]] Activates this item with the specified reference as the activator. == Syntax == <syntaxhighlight lang="papyrus"> bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native </syntaxhighlight> == Parameters == *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 == True if default activation processing was performed (and succeeded). Will return false if activation was blocked, or the activation failed for some other reason. == Examples == <syntaxhighlight lang="papyrus"> ; Have the player 'activate' the door NeatDoor.Activate(Game.GetPlayer()) </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; Have the player 'activate' the door, bypassing any blocked activation and NOT sending an event to any script NeatDoor.Activate(Game.GetPlayer(), true) </syntaxhighlight> == 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. * Even using this function, the player cannot activate a ref whose base form has no name, unless that base form is a [[TalkingActivator]]. Calling this function on such a ref, with the player and ''False'' as the argument, will return ''False''. ** The ref can be activated just fine if its name is non-zero-length, even if it's all-whitespace. It can likewise be activated if it has a name but that name is being hidden using perk entry points. == See Also == *[[ObjectReference Script]] *[[UseIdleMarker (Procedure)]] *[[Activate]] *[[Activate (Procedure)]] *[[Activator]] *[[BlockActivation - ObjectReference]] *[[OnActivate - ObjectReference]]
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Search
Navigation
Landing page
Tutorials
Game Systems
Editor Reference
Scripting Reference
Recent changes
Help
Tools
What links here
Related changes
Special pages
Page information
Page values