Background for Fallout 4
Member of the WorkshopFramework:WSFW_API script
intfunctionRemoveSettlementObject(ObjectReferenceakRemoveRef, FormakRegisterMeForEvent=NONE)Global

Description

Documentation Comment

This effectively scraps an object, with everything except the provision of resourced. It handles all of the other required background activity to remove a settlement object safely. Done via thread engine.

Parameters:
ObjectReference akRemoveRef - The objectreference to remove.

Form akRegisterMeForEvent [Optional] - The object or quest you would like to receive the WorkshopFramework:PlaceObjectManager.ObjectRemoved events. If you don't need to track the items, leave this field as None.


Parameters

  1. ObjectReferenceakRemoveRef

  2. FormakRegisterMeForEvent=NONE


Examples

Auto-Generated Example

ObjectReference myObjectReference__akRemoveRef
Form myForm__akRegisterMeForEvent

int returnedValue = WorkshopFramework:WSFW_API.RemoveSettlementObject(myObjectReference__akRemoveRef, myForm__akRegisterMeForEvent)
Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.