Background for Fallout 4
Member of the ObjectReference script
voidfunctionSetAttractionActive(KeywordapKeyword, boolabActive=true)Native

Description

Wiki Description

This function sets whether this ObjectReference should send attraction-object story manager events to actors with the specified attraction keyword.

Documentation Comment

Sets whether this ref should send attraction-object story manager events for the specified keyword.


Caveats

CK Wiki - Notes

This change will be saved and loaded in saved games, but will be cleared when the reference unloads.


Parameters

KeywordapKeyword

CK Wiki Description

Attraction keyword (one that already exists on this reference) to enable or disable from sending story manager attraction-object events to actors with that keyword.

boolabActive=true

CK Wiki Description

If true, allow this reference to send story manager attraction-object to actors with this keyword (note that this is allowed by default). If false, disable sending story manager attraction-object events to actors with this keyword.

  • Default:true

Examples

; Stop sending Attraction Object events to actors with the AO_RadioWaves keyword.
SecretSubmarine.SetAttractionActive(AO_RadioWaves, false)
; Resume sending Attraction Object events to actors with the AO_RadioWaves keyword
SecretSubmarine.SetAttractionActive(AO_RadioWaves)

Auto-Generated Example

Keyword myKeyword__apKeyword
bool myBool__abActive

myObjectReference__toCallFunctionOn.SetAttractionActive(myKeyword__apKeyword, myBool__abActive)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.