Race Script

From the CreationKit Wiki
Revision as of 22:52, 2 February 2014 by imported>CraftySentinel (Reverted to List)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Extends: Form Script

Script for the manipulation of a character's race.


Definition

ScriptName Race extends Form


SKSE Properties


Global Functions

None


Member Functions

None

SKSE Global Functions

Int GetNumPlayableRaces()
  • Returns the number of playable races.
Race GetNthPlayableRace(Int n)
  • Returns the Nth playable race.
Race GetRace(String editorId)
  • Returns a race by its editorId name.


SKSE Member Functions

Int GetSpellCount()
  • Returns the number of spells for the race.
Spell GetNthSpell(Int n)
  • Returns the specified spell from the race.
Bool IsRaceFlagSet(Int n)
  • Returns whether the specified race flag is set.
SetRaceFlag(Int n)
  • Sets the specified race flag.
ClearRaceFlag(Int n)
  • Clears the specified race flag.
VoiceType GetDefaultVoiceType()
  • Returns the race's default voice type.
SetDefaultVoiceType(VoiceType voice)
  • Sets the race's default voice type.
Armor GetSkin()
  • Returns the race's skin.
SetSkin(Armor skin)
  • Sets the race's skin.
Bool IsPlayable()
  • Returns whether the race is playable.
MakePlayable()
  • Sets the race's playable flag to true.
MakeUnPlayable()
  • Clears the race's playable flag.
Bool IsChildRace()
  • Returns whether this race is a Child race.
MakeChildRace()
  • Sets the race's Child Race flag to true.
MakeNonChildRace()
  • Clears the race's Child Race flag.
Bool CanFly()
  • Returns whether or not the race can fly.
MakeCanFly()
  • Sets the race's Flies flag to true.
MakeNonFlying()
  • Clears the race's Flies flag.
Bool CanSwim()
  • Returns whether the race can swim or not.
MakeCanSwim()
  • Sets the race's Swims flag to true.
MakeNonSwimming()
  • Clears the race's Swims flag.
Bool CanWalk()
  • Returns whether the race can walk or not.
MakeCanWalk()
  • Sets the race's Walks flag to true.
MakeNonWalking()
  • Clears the race's Walks flag.
Bool IsImmobile()
  • Returns whether the race is immobile or not.
MakeImmobile()
  • Sets the race's Immobile flag to true.
MakeMobile()
  • Clears the race's Immobile flag.
Bool IsNotPushable()
  • Returns whether the race is pushable.
MakeNotPushable()
  • Sets the race's Not Pushable flag to true.
MakePushable()
  • Clears the race's Not Pushable flag.
Bool NoKnockdowns()
  • Returns whether the race can be knocked down or not.
MakeNoKnockdowns()
  • Sets the race's No Knockdowns flag to true.
ClearNoKnockdowns()
  • Clears the race's No Knockdowns flag.
Bool NoCombatInWater()
  • Returns whether the race can fight while swimming or not.
SetNoCombatInWater()
  • Sets the race's No Combat In Water flag to true.
ClearNoCombatInWater()
  • Clears the race's No Combat In Water flag.
Bool AvoidsRoads()
  • Returns whether the race avoids roads or not.
SetsAvoidsRoads()
  • Sets the race's Avoids Roads flag to true.
ClearsAvoidsRoads()
  • Clears the race's Avoid Roads flag.
Bool AllowPickpocket()
  • Returns whether the player can be Pickpocket this race.
SetAllowPickpocket()
  • Sets the race's Allow Pickpocket flag to true.
ClearAllowPickpocket()
  • Clears the race's Allow Pickpocket flag.
Bool AllowPCDialogue()
  • Returns whether or not the player is allowed to talk to actors of this race.
SetAllowPCDialogue()
  • Sets the race's Allow PC Dialogue flag to true.
ClearAllowPCDialogue()
  • Clears the race's Allow PC Dialogue flag.
Bool CantOpenDoors()
  • Returns whether the race cannot open doors.
SetCantOpenDoors()
  • Sets the race's Cant Open Doors flag to true.
ClearCantOpenDoors()
  • Clears the race's Cant Open Doors flag.
Bool NoShadow()
  • Returns whether the race casts a shadow or not.
SetNoShadow()
  • Sets the race's No Shadow flag to true.
ClearNoShadow()
  • Clears the race's No Shadow flag.


Events

None