Difference between revisions of "SendPlayerToJail - Faction"
Jump to navigation
Jump to search
imported>Scornett m (Reverted edits by Scornett-Bot (talk) to last revision by Rhavlovick) |
(→Parameters: Quest items aren't hidden if the player is sent to fake jail.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 12: | Line 12: | ||
== Parameters == | == Parameters == | ||
*abRemoveInventory: Whether to remove everything from the player's inventory or not. | *abRemoveInventory: Whether to remove everything from the player's inventory or not. Note that quest items are only hidden if the player is sent to "real" jail. | ||
**'''Default''': True | **'''Default''': True | ||
*abRealJail: Whether to send the player to "real" jail or not. | *abRealJail: Whether to send the player to "real" jail or not. | ||
| Line 28: | Line 28: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
; Send the player to "fake" jail, removing all their inventory | ; Send the player to "fake" jail, removing all their inventory | ||
PoliceFactionProperty.SendPlayerToJail(abRealJail = | PoliceFactionProperty.SendPlayerToJail(abRealJail = false) | ||
</source> | </source> | ||
== See Also == | == See Also == | ||
*[[Faction Script]] | *[[Faction Script]] | ||
Latest revision as of 22:52, 1 December 2021
Member of: Faction Script
Sends the player to jail, optionally removing his inventory, and sending him to "real" jail.
Syntax[edit | edit source]
Function SendPlayerToJail(bool abRemoveInventory = True, bool abRealJail = True) nativeParameters[edit | edit source]
- abRemoveInventory: Whether to remove everything from the player's inventory or not. Note that quest items are only hidden if the player is sent to "real" jail.
- Default: True
- abRealJail: Whether to send the player to "real" jail or not.
- Default: True
Return Value[edit | edit source]
None.
Examples[edit | edit source]
; Send the player to "real" jail, removing all inventory
PoliceFactionProperty.SendPlayerToJail()
; Send the player to "fake" jail, removing all their inventory
PoliceFactionProperty.SendPlayerToJail(abRealJail = false)