Difference between revisions of "User talk:CraftySentinel"
Jump to navigation
Jump to search
imported>CraftySentinel m (Blanked the page) |
imported>CraftySentinel |
||
| Line 1: | Line 1: | ||
=Activate - ObjectReference= | |||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
'''Member Function of:''' [[ObjectReference Script]] | |||
Activates this item with the specified reference as the activator. | |||
== Definition == | |||
<source lang="papyrus"> | |||
bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native | |||
</source> | |||
<br /> | |||
=== Parameters === | |||
{| class="wikitable" | |||
! Parameters || Description || | |||
|- | |||
|<source lang="papyrus"> | |||
ObjectReference akActivator | |||
</source> || The ObjectReference to activate this Object. | |||
|- | |||
|<source lang="papyrus"> | |||
bool abDefaultProcessingOnly = false | |||
</source> ||If true, no OnActivate event will be sent to any scripts and the object will ignore the blocked flag.(Default Value: False) | |||
|} | |||
=== Return Value === | |||
:;Type - bool | |||
::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 == | |||
<source lang="papyrus"> | |||
; Have the player 'activate' the door | |||
NeatDoor.Activate(Game.GetPlayer()) | |||
</source> | |||
<br> | |||
<source 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) | |||
</source> | |||
<br /> | |||
== 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. | |||
== See Also == | |||
{|class="mw-collapsible wikitable" align="right" font-size:85%;" | |||
! colspan = "2"| | |||
|- | |||
! rowspan ="5"|[[ObjectReference Script| ObjectReference]] | |||
|- | |||
! [[Events Reference| Events]] | |||
|- | |||
|[[OnActivate - ObjectReference | OnActivate]], [[OnAttachedToCell - ObjectReference|OnAttachedToCell]], [[OnCellAttach - ObjectReference|OnCellAttach]], [[OnCellDetach - ObjectReference|OnCellDetach]], [[OnCellLoad - ObjectReference|OnCellLoad]], [[OnClose - ObjectReference|OnClose]], [[OnContainerChanged - ObjectReference|OnContainerChanged]], [[OnDestructionStageChanged - ObjectReference|OnDestructionStageChanged]], [[OnDetachedFromCell - ObjectReference|OnDetachedFromCell]], [[OnEquipped - ObjectReference|OnEquipped]], [[OnGrab - ObjectReference|OnGrab]], [[OnHit - ObjectReference|OnHit]] | |||
|- | |||
![[Function Reference | Functions]] | |||
|- | |||
|[[BlockActivation - ObjectReference| BlockActivation]], [[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]], [[AddItem - ObjectReference|AddItem]], [[AddToMap - ObjectReference|AddToMap]], [[ApplyHavokImpulse - ObjectReference|ApplyHavokImpulse]], [[BlockActivation - ObjectReference|BlockActivation]], [[CalculateEncounterLevel - ObjectReference|CalculateEncounterLevel]], [[CanFastTravelToMarker - ObjectReference|CanFastTravelToMarker]], [[ClearDestruction - ObjectReference|ClearDestruction]], [[CountLinkedRefChain - ObjectReference|CountLinkedRefChain]], [[CreateDetectionEvent - ObjectReference|CreateDetectionEvent]] | |||
|- | |||
|} | |||
Revision as of 23:48, 22 August 2013
Activate - ObjectReference
Member Function of: ObjectReference Script
Activates this item with the specified reference as the activator.
Definition
bool Function Activate(ObjectReference akActivator, bool abDefaultProcessingOnly = false) native
Parameters
| Parameters | Description | |
|---|---|---|
ObjectReference akActivator |
The ObjectReference to activate this Object. | |
bool abDefaultProcessingOnly = false |
If true, no OnActivate event will be sent to any scripts and the object will ignore the blocked flag.(Default Value: False) |
Return Value
- Type - bool
- 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
; 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
- If the object reference has had activation processing blocked, this will still send the 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.