Difference between revisions of "OpenWorkshopSettlementMenu - ObjectReference"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added category) |
||
| Line 1: | Line 1: | ||
'''Member of:''' [[ObjectReference Script]] | '''Member of:''' [[ObjectReference Script]] | ||
| Line 8: | Line 5: | ||
== Syntax == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Location Function OpenWorkshopSettlementMenu(Keyword akActionKW, Message astrConfirm = | Location Function OpenWorkshopSettlementMenu(Keyword akActionKW, Message astrConfirm = none, \ | ||
Location aLocToHighlight = none) Native | |||
</source> | </source> | ||
| Line 30: | Line 27: | ||
== See Also == | == See Also == | ||
*[[ObjectReference Script]] | *[[ObjectReference Script]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Latent Functions]] | |||
[[Category:User Interface]] | |||
Latest revision as of 20:50, 11 February 2018
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[edit | edit source]
Location Function OpenWorkshopSettlementMenu(Keyword akActionKW, Message astrConfirm = none, \
Location aLocToHighlight = none) NativeParameters[edit | edit source]
- 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[edit | edit source]
Returns selected location after user has chosen one, or NONE if user exited out without choosing
Examples[edit | edit source]
; Open the workshop caravan menu for Bob (assuming Bob is a workshop NPC)
Bob.OpenWorkshopSettlementMenu( WorkshopAssignCaravan_DO, DoItMessage)