SendPlayerToJail - Faction

From Creation Kit
Jump to: navigation, search

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