[DEV SERVER] Loading description...
Caveats
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
FormListakIncludeKeywordList=NONE
CK Wiki Description
Optional Qualifier formlist of keywords that settlements to include have.
- Default:none
FormListakExcludeKeywordList=NONE
CK Wiki Description
Optional Qualifier formlist of keywords that settlements to exclude have.
- Default:None
boolabExcludeZeroPopulation=false
CK Wiki Description
Optional Qualifier flag that if true will remove workshops with zero population from the list.
- Default:false
boolabOnlyOwnedWorkshops=true
CK Wiki Description
Optional Qualifier flag that if true will only show owned workshops.
- Default:true
boolabTurnOffHeader=false
CK Wiki Description
Optional Qualifier flag that if true will turn off the header text.
- Default:false
boolabOnlyPotentialVassalSettlements=false
CK Wiki Description
Optional Qualifier flag that if true will only show vassal settlements.
- Default:false
boolabDisableReservedByQuests=false
CK Wiki Description
Optional Qualifier flag that if true will only show vassal settlements.
- Default:false
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
FormList myFormList__akIncludeKeywordList
FormList myFormList__akExcludeKeywordList
bool myBool__abExcludeZeroPopulation
bool myBool__abOnlyOwnedWorkshops
bool myBool__abTurnOffHeader
bool myBool__abOnlyPotentialVassalSettlements
bool myBool__abDisableReservedByQuests
Location returnedValue = myObjectReference__toCallFunctionOn.OpenWorkshopSettlementMenuEx(myKeyword__akActionKW, myMessage__astrConfirm, myLocation__aLocToHighlight, myFormList__akIncludeKeywordList, myFormList__akExcludeKeywordList, myBool__abExcludeZeroPopulation, myBool__abOnlyOwnedWorkshops, myBool__abTurnOffHeader, myBool__abOnlyPotentialVassalSettlements, myBool__abDisableReservedByQuests)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki