CreateBatchSettlementObjects function - WorkshopFramework:WSFW_API script

Found in:

Workshop Framework

intfunctionCreateBatchSettlementObjects(<UNKNOWN_SCRIPT: WorldObject>[]PlaceMe, <UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef=NONE, ObjectReferenceakPositionRelativeTo=NONE, boolabStartEnabled=true, FormakRegisterMeForEvent=NONE)Global

Description

Documentation Comment

1.0.5 OBSOLETE - Use CreateSimpleBatchSettlementObjects instead

Parameters

<UNKNOWN_SCRIPT: WorldObject>[]PlaceMe
<UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef=NONE
ObjectReferenceakPositionRelativeTo=NONE
boolabStartEnabled=true
FormakRegisterMeForEvent=NONE

Examples

Auto-Generated Example

WorldObject[] myWorldObjectArray__PlaceMe
WorkshopScript myWorkshopScript__akWorkshopRef
ObjectReference myObjectReference__akPositionRelativeTo
bool myBool__abStartEnabled
Form myForm__akRegisterMeForEvent

int returnedValue = WorkshopFramework:WSFW_API.CreateBatchSettlementObjects(myWorldObjectArray__PlaceMe, myWorkshopScript__akWorkshopRef, myObjectReference__akPositionRelativeTo, myBool__abStartEnabled, myForm__akRegisterMeForEvent)