SetCompanion - Actor

From the Fallout4 CreationKit Wiki
Revision as of 11:25, 1 December 2015 by imported>Plplecuyer (Created page with "Category:Scripting Category:Papyrus '''Member of:''' Actor Script Sets/clears this actor as the current companion. == Syntax == <source lang="papyrus"> Function Set...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: Actor Script

Sets/clears this actor as the current companion.

Syntax[edit | edit source]

Function SetCompanion(bool SetCompanion = true, FillCompanionAlias = true)

Parameters[edit | edit source]

  • SetCompanion: Whether to set or clear this actor as a companion
    • Default: True
  • FillCompanionAlias: Whether to fill the alias with this actor (should almost always be true)
    • Default: True

Return Value[edit | edit source]

None

Examples[edit | edit source]

; Set dogmeat as the companion
Dogmeat.SetCompanion()


; Remove Valentine as companion
Valentine.SetCompanion(false)

See Also[edit | edit source]