LocationfunctionOpenWorkshopSettlementMenu(KeywordakActionKW, MessageastrConfirm=NONE, LocationaLocToHighlight=NONE)Native
Description
Wiki Description
If this is a workshop NPC, opens up the Workshop Caravan submenu, which allows you to send this NPC to another workshop settlement.
Documentation Comment
If this is a workshop NPC, opens up the Workshop Caravan submenu, which allows you to send this NPC to another workshop settlement.
Returns selected location after user has chosen one, or NONE if user exited out without choosing
Parameters
KeywordakActionKW
CK Wiki Description
Qualifier keyword that will get passed back to scripts to signify how to act on workshop data.
MessageastrConfirm=NONE
CK Wiki Description
Optional confirm message to show in menu. If None, default message is used.
- Default:None
LocationaLocToHighlight=NONE
CK Wiki Description
Optional starting location to highlight. If None, first location in list is highlighted.
- Default:None
Examples
; Open the workshop caravan menu for Bob (assuming Bob is a workshop NPC)
Bob.OpenWorkshopSettlementMenu( WorkshopAssignCaravan_DO, DoItMessage)Auto-Generated Example
Keyword myKeyword__akActionKW
Message myMessage__astrConfirm
Location myLocation__aLocToHighlight
Location returnedValue = myObjectReference__toCallFunctionOn.OpenWorkshopSettlementMenu(myKeyword__akActionKW, myMessage__astrConfirm, myLocation__aLocToHighlight)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki