Difference between revisions of "OpenWorkshopSettlementMenuEx - ObjectReference"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Hannibalektr (Updating to match latest source) |
||
| Line 9: | Line 9: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Location Function OpenWorkshopSettlementMenuEx(Keyword akActionKW, Message astrConfirm = None, \ | Location Function OpenWorkshopSettlementMenuEx(Keyword akActionKW, Message astrConfirm = None, \ | ||
Location aLocToHighlight = None, | Location aLocToHighlight = None, FormList akIncludeKeywordList = None, FormList akExcludeKeywordList = None, bool abExcludeZeroPopulation = false) native | ||
</source> | </source> | ||
| Line 18: | Line 18: | ||
*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 | **'''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''': None | **'''Default''': None | ||
== 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 | ||
Revision as of 12:31, 13 May 2016
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) nativeParameters
- 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: 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)