SendPlayerToJail - Faction

From the CreationKit Wiki
Revision as of 23:52, 1 December 2021 by Jadkai (talk | contribs) (→‎Parameters: Quest items aren't hidden if the player is sent to fake jail.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Parameters[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)

See Also[edit | edit source]