SpawnWorkshopNPC - WorkshopFramework:WSFW_API

Found in:

Workshop Framework

<UNKNOWN_SCRIPT: WorkshopNPCScript>functionSpawnWorkshopNPC(<UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef, boolabBrahmin=false, ActorBaseaActorFormOverride=NONE)Global

Description

Documentation Comment

pawns an NPC at the targeted settlement.

Parameters:
WorkshopScript akWorkshopRef - the settlement workshop to spawn at

Bool abBrahmin - Whether this should be a brahmin or a settler

ActorBase aActorFormOverride - Allows you to spawn a custom NPC. Make sure that the Actor form you are sending has the WorkshopNPCScript attached and configured!

Returns:
Created NPC ref

[DEV SERVER] Loading description...

Caveats

Parameters

<UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef

boolabBrahmin=false

ActorBaseaActorFormOverride=NONE

Examples

Auto-Generated Example

WorkshopScript myWorkshopScript__akWorkshopRef
bool myBool__abBrahmin
ActorBase myActorBase__aActorFormOverride

WorkshopNPCScript returnedValue = WorkshopFramework:WSFW_API.SpawnWorkshopNPC(myWorkshopScript__akWorkshopRef, myBool__abBrahmin, myActorBase__aActorFormOverride)WorkshopScript myWorkshopScript__akWorkshopRef
bool myBool__abBrahmin
ActorBase myActorBase__aActorFormOverride

WorkshopNPCScript returnedValue = WorkshopFramework:WSFW_API.SpawnWorkshopNPC(myWorkshopScript__akWorkshopRef, myBool__abBrahmin, myActorBase__aActorFormOverride)