[][src]Function tes3mp_plugin::plugin::generated::jail

pub fn jail(
    pid: u16,
    jail_days: i16,
    ignore_jail_teleportation: bool,
    ignore_jail_skill_increases: bool,
    jail_progress_text: &str,
    jail_end_text: &str
)

Send a PlayerJail packet about a player.

This is similar to the player being jailed by a guard, but provides extra parameters for
increased flexibility.

It is only sent to the player being jailed, as the other players will be informed of the
jailing's actual consequences via other packets sent by the affected client.

pid The player ID.
jail_days The number of days to spend jailed, where each day affects one skill point.
ignore_jail_teleportation Whether the player being teleported to the nearest jail
marker should be overridden.
ignore_jail_skill_increase Whether the player's Sneak and Security skills should be
prevented from increasing as a result of the jailing,
overriding default behavior.
jail_progress_text The text that should be displayed while jailed.
jail_end_text The text that should be displayed once the jailing period is over.

Returns void