OpenWorkshopSettlementMenu - 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 OpenWorkshopSettlementMenu(Keyword akActionKW, Message astrConfirm = None, \
  Location aLocToHighlight = None) 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

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