SetPlayerExpelled - Faction

From the CreationKit Wiki
Revision as of 16:27, 18 October 2011 by imported>Rhavlovick (1 revision: Clobber re-import by Henning)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: Faction Script

Sets or clears the expelled flag from this faction for the player.

Syntax[edit | edit source]

Function SetPlayerExpelled(bool abIsExpelled = true) native

Parameters[edit | edit source]

  • abIsExpelled: True if the player should be expelled, false if the player should be let back in.
    • Default: True

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Expell the player from the cool kids faction
CoolKidsProperty.SetPlayerExpelled()


; Let the player back in to the cool kids faction
CoolKidsProperty.SetPlayerExpelled(false)

See Also[edit | edit source]