Difference between revisions of "OpenWorkshopSettlementMenuEx - ObjectReference"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added category) |
||
| (2 intermediate revisions by one other user not shown) | |||
| 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 OpenWorkshopSettlementMenuEx(Keyword akActionKW, Message astrConfirm = | Location Function OpenWorkshopSettlementMenuEx(Keyword akActionKW, Message astrConfirm = none, \ | ||
Location aLocToHighlight = | 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 | |||
</source> | </source> | ||
| Line 15: | Line 14: | ||
*akActionKW: Qualifier keyword that will get passed back to scripts to signify how to act on workshop data. | *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. | *astrConfirm : Optional confirm message to show in menu. If None, default message is used. | ||
**'''Default''': | **'''Default''': none | ||
*aLocToHighlight : Optional starting location to highlight. If None, first location in list is highlighted. | *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 | **'''Default''': None | ||
* | *abExcludeZeroPopulation: Optional Qualifier flag that if true will remove workshops with zero population from the list. | ||
**'''Default''': | **'''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 == | == Return Value == | ||
Returns selected location after user has chosen one, or NONE if user exited out without choosing | Returns selected location after user has chosen one, or NONE if user exited out without choosing. | ||
== Examples == | == Examples == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
; Open the workshop caravan menu for Bob | ; Open the workshop caravan menu for Bob, assuming Bob is a workshop NPC | ||
Bob.OpenWorkshopSettlementMenu( WorkshopAssignCaravan_DO, DoItMessage) | Bob.OpenWorkshopSettlementMenu(WorkshopAssignCaravan_DO, DoItMessage) | ||
</source> | </source> | ||
== See Also == | == See Also == | ||
*[[ObjectReference Script]] | *[[ObjectReference Script]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Latent Functions]] | |||
[[Category:User Interface]] | |||
Latest revision as of 21:09, 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 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) 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
- 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[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)