Background for Starfield
Member of the RefCollectionAlias script
boolfunctionLinkCollectionTo(RefCollectionAliasLinkedRefCollectionAlias, KeywordLinkKeyword=NONE, boolWrapLinks=false)

Description

Wiki Description

LinkRefs each index of the RefCollectionAlias to the same index of the target RefCollectionAlias using the keyword specified. Can be set to wrap to the top of the target RefCollectionAlias if it runs out of indexes before the colleciton this is called on.

Documentation Comment

Link this RefCollectionAlias to another refCollectionAlias with this keyword.
Limited by the number of objects in the refCollectionAlias it is called on
If wrapLinks == true : this will not be limited by the link target, but will wrap around to the top of that list


Parameters

  1. RefCollectionAliasLinkedRefCollectionAlias

    CK Wiki Description

    The ObjectReference to add to this alias

  2. KeywordLinkKeyword=NONE

    CK Wiki Description

    The Keyword type of LinkedRef to use

    • Default:None
  3. boolWrapLinks=false

    CK Wiki Description

    Whether to start back at index 0 of LinkedRefCollectionAlias if it runs out of indexes before the refCollectionAlias this function is called on.

    • Default:False

Examples

; Give my refCollectionAlias of actors linkRefs of type DMP_Combat_HoldPosition256 to the corresponding indexes
; of CombatTargetCollectionAlias
MyActorCollectionAlias.LinkCollectionTo(CombatTargetCollectionAlias, DMP_Combat_HoldPosition256, wrapLinks = true)

Auto-Generated Example

RefCollectionAlias myRefCollectionAlias__LinkedRefCollectionAlias
Keyword myKeyword__LinkKeyword
bool myBool__WrapLinks

bool returnedValue = myRefCollectionAlias__toCallFunctionOn.LinkCollectionTo(myRefCollectionAlias__LinkedRefCollectionAlias, myKeyword__LinkKeyword, myBool__WrapLinks)

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.