OpenWorkshopSettlementMenuEx - ObjectReference

Member of: ObjectReference Script

If this is a workshop NPC, opens up the Workshop Caravan submenu, which allows you to send this NPC to another workshop settlement.

Syntax

Location Function OpenWorkshopSettlementMenuEx(Keyword akActionKW, Message astrConfirm = none, \
  Location aLocToHighlight = none, FormList akIncludeKeywordList = none, FormList akExcludeKeywordList = none, \
  bool abExcludeZeroPopulation = false, bool abOnlyOwnedWorkshops= true, bool abTurnOffHeader= false, \
  bool abOnlyPotentialVassalSettlements= false, bool abDisableReservedByQuests = false) Native

Parameters

• akActionKW: Qualifier keyword that will get passed back to scripts to signify how to act on workshop data.
• astrConfirm : Optional confirm message to show in menu. If None, default message is used.
  • Default: none
• aLocToHighlight : Optional starting location to highlight. If None, first location in list is highlighted.
  • Default: none
• akIncludeKeywordList: Optional Qualifier formlist of keywords that settlements to include have.
  • Default: none
• akExcludeKeywordList: Optional Qualifier formlist of keywords that settlements to exclude have.
  • Default: None
• abExcludeZeroPopulation: Optional Qualifier flag that if true will remove workshops with zero population from the list.
  • Default: false
• abOnlyOwnedWorkshops: Optional Qualifier flag that if true will only show owned workshops.
  • Default: true
• abTurnOffHeader: Optional Qualifier flag that if true will turn off the header text.
  • Default: false
• abOnlyPotentialVassalSettlements: Optional Qualifier flag that if true will only show vassal settlements.
  • Default: false
• abDisableReservedByQuests: Optional Qualifier flag that if true will only show vassal settlements.
  • Default: false

Return Value

Returns selected location after user has chosen one, or NONE if user exited out without choosing.

Examples

; Open the workshop caravan menu for Bob, assuming Bob is a workshop NPC
Bob.OpenWorkshopSettlementMenu(WorkshopAssignCaravan_DO, DoItMessage)

See Also

• ObjectReference Script