Difference between revisions of "StoreInWorkshop - ObjectReference"
Jump to navigation
Jump to search
imported>Illyism (→Notes) |
imported>Qazaaq (Move categories to bottom of page and added links to the page.) |
||
| Line 1: | Line 1: | ||
'''Member of:''' [[ObjectReference Script]] | '''Member of:''' [[ObjectReference Script]] | ||
If the reference is a Workshop, stores the given object with an optional count. | If the reference is a [[Workshop Container]], stores the given object with an optional count. | ||
== Syntax == | == Syntax == | ||
| Line 11: | Line 9: | ||
== Parameters == | == Parameters == | ||
*akBaseItem: The | *akBaseItem: The [[Base Object]] of the item to store. | ||
*aiCount: How many of the | *aiCount: How many of the [[Base Object]] to store. (Must be at least 1) | ||
**'''Default''': 1 | **'''Default''': 1 | ||
| Line 25: | Line 23: | ||
== Notes == | == Notes == | ||
If the | *If the [[Base Object]] is not buildable by the [[Player]] because the player doesn't meet the [[Constructible Object|recipe's]] conditions, this function won't force it to show in the build menu. It will show up once the player passes the conditions. | ||
*This will not trigger [[OnWorkshopObjectDestroyed - ObjectReference|OnWorkshopObjectDestroyed]] for scripted object cleanup. | |||
This will not trigger [[OnWorkshopObjectDestroyed - ObjectReference|OnWorkshopObjectDestroyed]] for scripted object cleanup. | |||
== See Also == | == See Also == | ||
*[[Workshop]] | |||
*[[Workshop Container]] | |||
*[[Constructible Object]] | |||
*[[ObjectReference Script]] | *[[ObjectReference Script]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
Revision as of 18:27, 7 March 2020
Member of: ObjectReference Script
If the reference is a Workshop Container, stores the given object with an optional count.
Syntax
Function StoreInWorkshop(Form akBaseItem, int aiCount = 1) nativeParameters
- akBaseItem: The Base Object of the item to store.
- aiCount: How many of the Base Object to store. (Must be at least 1)
- Default: 1
Return Value
None.
Examples
; Store 10 widgets in our Workshop
MyWorkshop.StoreInWorkshop( WidgetForm, 10 )Notes
- If the Base Object is not buildable by the Player because the player doesn't meet the recipe's conditions, this function won't force it to show in the build menu. It will show up once the player passes the conditions.
- This will not trigger OnWorkshopObjectDestroyed for scripted object cleanup.