Background for Starfield
Member of the ObjectReference script
boolfunctionPlayImpactEffect(ImpactDataSetakImpactEffect, stringasNodeName="", floatafPickDirX=0.0, floatafPickDirY=0.0, floatafPickDirZ=-1, floatafPickLength=512.0, boolabApplyNodeRotation=false, boolabUseNodeLocalRotation=false)Native

Description

Wiki Description

Plays an impact effect on the reference.

Documentation Comment

Play the specified impact effect - returns true if it succeeds


Parameters

  1. ImpactDataSetakImpactEffect

    CK Wiki Description

    The ImpactDataSet to use for the impact effect.

  2. stringasNodeName=""

    CK Wiki Description

    The string for the node to be used to determine the pick origin.

  3. floatafPickDirX=0.0

    CK Wiki Description

    The pick direction vector X value.

  4. floatafPickDirY=0.0

    CK Wiki Description

    The pick direction vector Y value.

  5. floatafPickDirZ=-1

    CK Wiki Description

    The pick direction vector Z value.

  6. floatafPickLength=512.0

    CK Wiki Description

    The length to be used for the pick.

  7. boolabApplyNodeRotation=false

    CK Wiki Description

    Whether or not to apply the rotation of the node to the pick direction.

  8. boolabUseNodeLocalRotation=false

    CK Wiki Description

    Whether or not to use the node's local rotation.


Examples

; Play takeoff impact effect on Bob The Dragon's tail.
BobTheDragon.PlayImpactEffect(FXDragonTakeoffImpactSet, "NPC Tail8", 0, 0, -1, 512, true, false)

Auto-Generated Example

ImpactDataSet myImpactDataSet__akImpactEffect
string myString__asNodeName
float myFloat__afPickDirX
float myFloat__afPickDirY
float myFloat__afPickDirZ
float myFloat__afPickLength
bool myBool__abApplyNodeRotation
bool myBool__abUseNodeLocalRotation

bool returnedValue = myObjectReference__toCallFunctionOn.PlayImpactEffect(myImpactDataSet__akImpactEffect, myString__asNodeName, myFloat__afPickDirX, myFloat__afPickDirY, myFloat__afPickDirZ, myFloat__afPickLength, myBool__abApplyNodeRotation, myBool__abUseNodeLocalRotation)

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.