Difference between revisions of "SendPlayerToJail - Faction"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Scornett
m (Reverted edits by Scornett-Bot (talk) to last revision by Rhavlovick)
 
imported>Lisselli
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 = true)
PoliceFactionProperty.SendPlayerToJail(abRealJail = false)
</source>
</source>


== See Also ==
== See Also ==
*[[Faction Script]]
*[[Faction Script]]

Revision as of 12:28, 2 August 2017

Member of: Faction Script

Sends the player to jail, optionally removing his inventory, and sending him to "real" jail.

Syntax

Function SendPlayerToJail(bool abRemoveInventory = True, bool abRealJail = True) native

Parameters

  • abRemoveInventory: Whether to remove everything from the player's inventory or not.
    • Default: True
  • abRealJail: Whether to send the player to "real" jail or not.
    • Default: True

Return Value

None.

Examples

; 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)

See Also