The WorkshopFramework:WSFW_API script is a part of Fallout 4’s Papyrus scripting ecosystem. This script is not present in the vanilla game, but can be found in modded sources like Workshop Framework (Workshop Framework).
For this script, the Papyrus index knows about:
- 19 functions
Inheritance Tree
No indexed scripts extend this script.
Structs
The Papyrus Index is still under construction. Structs have not been implemented yet.
Properties
No properties found.
Events
No events found.
Functions
- Found in:
- Workshop Framework
ObjectReferencefunctionCreateSettlementObject(<UNKNOWN_SCRIPT: WorldObject>PlaceMe, <UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef=NONE, ObjectReferenceakPositionRelativeTo=NONE, boolabStartEnabled=true)GlobalCreates a settlement object as if the player built it in workshop mode, and returns the reference, or None if it failed.
Parameters:
PlaceMe - Your objects should be in an array of structs per the WorldObject definition found in Library:DataStructures.akWorkshopRef [Optional] - The objectreference of the settlement workbench cast as WorkshopScript. If this is not sent, the object will not be linked to the workshop. The Link is what allows several gameplay elements: Player Scrapping, Crafting Stations to share resources, Assignable objects to be assignable, and more.
akPositionRelativeTo [Optional] - It the positions in your PlaceMe data are offsets from a specific reference, send that reference (note that this increases the processing time by about 40%, so sending world coordinates is definitely preferred)
abStartEnabled [Optional] - If you would like to handle enabling the objects yourself, set this to false
- Found in:
- Workshop Framework
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.
- Found in:
- Workshop Framework
<UNKNOWN_SCRIPT: WorkshopNPCScript>functionSpawnWorkshopNPC(<UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef, boolabBrahmin=false, ActorBaseaActorFormOverride=NONE)Globalpawns an NPC at the targeted settlement.
Parameters:
WorkshopScript akWorkshopRef - the settlement workshop to spawn atBool 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- Found in:
- Workshop Framework
voidfunctionRegisterResourceProductionType(LeveledItemaProduceMe, ActorValueaResourceAV, KeywordaTargetContainerKeyword=NONE)GlobalRegisters a Resource type ActorValue to produce a certain resource each day based on how much of that resource exists in a settlement. Similar to how Food and Water values cause settlements to create extra crops and water in the Workbench each day
Parameters:
LeveledItem aProduceMe - The leveleditem to produce. Note that 1 will be produced for each point of the resource found.ActorValue aResourceAV - The ActorValue to check the settlement for. If you want workshop objects to be able to provide this resource, ensure the ActorValue you use/create is of the Resource type (it's a drop down menu on the Actor Value edit window in the CK), then on the workshop object add that actor value and the amount you want it to produce. You also need to add the ActorValue WorkshopResourceObject with a value of 1, which is how the game knows to grab that item when calculating total resources for the settlement.
Keyword aTargetContainerKeyword - [Optional] If you want to flag your produced items as a particular type, for example as food, set the matching container keyword (see the documentation regarding the Workshop Container system). You can also use this to force your items to be sorted into a particular container type in the Workshop Container system, assuming players are using said containers.
- Found in:
- Workshop Framework
Reverse a RegisterResourceProductionType call
- Found in:
- Workshop Framework
voidfunctionRegisterResourceConsumptionType(FormaConsumeMe, ActorValueaResourceAV, KeywordaSearchContainerKeyword=NONE, boolabIsComponentFormList=false)GlobalDescription: Registers a Resource type ActorValue to be consumed each day based on how much of that resource exists in a settlement. This allows adding costs to virtually anything. For example, you could define a fuel resource actor value and assign it to generators so they consumed gasoline each day.
Notes: There is no inherit penalty if a settlement fails to have enough resources to be consumed each day, you will have to define that penalty. During each day's consumption, if anything is missing, a custom event will be fired you can watch for and act on. The event is called "NotEnoughResources" and will come from the WorkshopFramework:WorkshopProductionManager quest.
Parameters:
Form aConsumeMe - The Form to consume. Note that 1 will be consumed for each point of the resource found. This Form can be any of the following: Keyword - will consume anything with an object type matching that keyword, FormList - will consume anything found on that formlist, Component or MiscItem or Weapon or Ammo or Armor or WeaponMod - will consume that specific thing.ActorValue aResourceAV - The ActorValue to check the settlement for. If you want workshop objects to be able to consume this resource, ensure the ActorValue you use/create is of the Resource type (it's a drop down menu on the Actor Value edit window in the CK), then on the workshop object add that actor value and the amount you want it to consume. You also need to add the ActorValue WorkshopResourceObject with a value of 1, which is how the game knows to grab that item when calculating total resources for the settlement.
Keyword aSearchContainerKeyword - [Optional] If you want to search a particular container keyword (see the documentation regarding the Workshop Container system). You can also use this to check that container type specifically, otherwise it will just check the workbench.
Bool abIsComponentFormList - If you used a Formlist of components as aConsumeMe, change this to true. This will ensure the game correctly breaks down junk and consumes the pieces.
- Found in:
- Workshop Framework
Reverse a RegisterConsumptionResourceType call
- Found in:
- Workshop Framework
- Found in:
- Workshop Framework
Grabs closest WorkshopScript reference - with some exceptions. If the object is linked to a settlement, it will grab that workshop. If an object is in a workshop's location, it will grab that. Lastly, it will search in a radius to find the closest.
- Found in:
- Workshop Framework
boolfunctionShowMessage(MessageaMessageToShow, floatafArg1=0.0, floatafArg2=0.0, floatafArg3=0.0, floatafArg4=0.0, floatafArg5=0.0, floatafArg6=0.0, floatafArg7=0.0, floatafArg8=0.0, floatafArg9=0.0, ReferenceAliasaRefAlias=NONE, ObjectReferenceakObjectToAlias=NONE, LocationAliasaLocAlias=NONE, LocationakLocationToAlias=NONE, boolabAutoClearAliases=true)GlobalVersion: Added 1.0.8
Send messages through these to allow the player's setting to dictate whether or not they are displayed at the given moment. This allows the player to queue pop-ups and notifications for non-time sensitive things during combat, dialogue, etc. The player's settings will then determine if the queue is auto played, or if they have to access it manually via holotape (or some other interface)
Parameters:
Message aMessageToShow - The Message form.Float afArg1 [... afArg9] - [Optional] Floats to be replaced in the message, this is the same as the vanilla Show function for Messages
ReferenceAlias aRefAlias - [Optional; Requires akObjectToAlias] If you are using text replacement, this would be the quest alias you need an object placed in. (You can read more about text replacement here: ObjectReference.AddTextReplacementData(...))
ObjectReference akObjectToAlias - [Optional] The object reference to fill into aRefAlias
LocationAlias aLocAlias - [Optional; Requires akLocationToAlias] If you are using text replacement, this would be the quest alias you need a location placed in. (You can read more about text replacement here: ObjectReference.AddTextReplacementData(...))
Location akLocationToAlias - [Optional] The location to fill into aLocAlias
Bool abAutoClearAliases - If true, the filled aliases will be cleared after the message is sent. (Note: The aliases are filled immediately before sending the message based on the parameters sent - while the message is in queue, the aliases aren't touched)
Returns:
True if the message was sent immediately, false if the message was queued upTODO: Add support for the quest objectives as well
- Found in:
- Workshop Framework
- Found in:
- Workshop Framework
intfunctionCreateSimpleBatchSettlementObjects(<UNKNOWN_SCRIPT: WorldObject>[]PlaceMe, <UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef=NONE, ObjectReferenceakPositionRelativeTo=NONE, boolabStartEnabled=true, FormakRegisterMeForEvent=NONE)GlobalCreates a batch of settlement objects through the thread manager and returns the batch ID to expect via custom event. This will be much faster than creating indivdual objects, but requires planning for batch-based event handling.
Prepare to receive CustomEvent WorkshopFramework:PlaceObjectManager.SimpleObjectBatchCreated (which your akRegisterMeForEvent will be automatically registered for if you sent it). Object refs will be sent via that event in batches. The Var contents will be as follows:
Int kArgs[0] = iBatchID, Bool kArgs[1] = Whether or not to expect additional events, kArgs[1 through 127] = ObjectReferences of your created objects.When receiving the event you should confirm that kArgs[0] as Int == the batch Id return value you received from this function.
Parameters:
PlaceMe - Your objects should be in an array of structs per the WorldObject definition found in Library:DataStructures.akPositionRelativeTo [Optional] - It the positions in your PlaceMe data are offsets from a specific reference
abStartEnabled [Optional] - If you would like to handle enabling the objects yourself, set this to false
akRegisterMeForEvent [Optional] - The object or quest you would like to receive the WorkshopFramework:PlaceObjectManager.SimpleObjectBatchCreated events. If you don't need to track the items, leave this field as None.
- Found in:
- Workshop Framework
Grabs the default AV to expect from the WorkshopFramework:PlaceObjectManager.ObjectBatchCreated event so you can check that the event data matches what your object is expecting
- Found in:
- Workshop Framework
Grabs the map marker from a location
- Found in:
- Workshop Framework
Some locations have multiple map markers within their bounds, this will return them (note this currently only supports 3, additional support would need to be set up on the aliases of the WSFW_FetchLocationData quests.
- Found in:
- Workshop Framework
ObjectReferencefunctionGetLocationCenter(LocationakLocation, boolabGetMapMarkerIfCenterNotFound=false)GlobalGrabs the map marker from a location
- Found in:
- Workshop Framework
Used internally by these functions to get simple access to properties
- Found in:
- Workshop Framework
intfunctionCreateSettlementObject_Threaded(<UNKNOWN_SCRIPT: WorldObject>PlaceMe, <UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef=NONE, ObjectReferenceakPositionRelativeTo=NONE, boolabStartEnabled=true, FormakRegisterMeForEvent=NONE)Global1.0.5 - Obsolete - This function wasn't actually sending the documented events, and the event it will send doesn't make sense for a single item.
- Found in:
- Workshop Framework
intfunctionCreateBatchSettlementObjects(<UNKNOWN_SCRIPT: WorldObject>[]PlaceMe, <UNKNOWN_SCRIPT: WorkshopScript>akWorkshopRef=NONE, ObjectReferenceakPositionRelativeTo=NONE, boolabStartEnabled=true, FormakRegisterMeForEvent=NONE)Global1.0.5 OBSOLETE - Use CreateSimpleBatchSettlementObjects instead