Difference between revisions of "Race Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎SKSE Member Functions: Formatting Change)
imported>CraftySentinel
(Added SKSE Member/Global Functions)
Line 23: Line 23:
== Member Functions ==
== Member Functions ==
None
None
== SKSE Global Functions ==
{|class="wikitable" width =100%
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetNumPlayableRaces - Race|Int '''GetNumPlayableRaces'''()]]
|Returns the number of playable races.
|-
|[[GetNthPlayableRace - Race|Race '''GetNthPlayableRace'''(Int ''n'')]]
|Returns the Nth playable race.
|-
|[[GetRace - Race|Race '''GetRace'''(String ''editorId'')]]
|Returns a race by its editorId name.
|-
|}


== SKSE Member Functions ==
== SKSE Member Functions ==
Line 30: Line 51:
!style="text-align:left;"|Description
!style="text-align:left;"|Description
|-
|-
|[[GetSpellCount - Race|Int '''GetSpellCount'''()]]
|[[GetSpellCount - Race|Int '''GetSpellCount'''()]]
|Returns the number of spells for the race.
|Returns the number of spells for the race.
Line 58: Line 80:
|-
|-


|[[GetNumPlayableRaces - Race|Int '''GetNumPlayableRaces'''()]]
|[[GetSkin - Race|Armor '''GetSkin'''()]]
|Returns the number of playable races.
|Returns the race's skin.
|-
 
|[[SetSkin - Race|'''SetSkin'''(Armor ''skin'')]]
|Sets the race's skin.
|-
 
|[[IsPlayable - Race|Bool '''IsPlayable'''()]]
|Returns whether the race is playable.
|-
 
|[[MakePlayable - Race|'''MakePlayable'''()]]
|Sets the race's playable flag to true.
|-
 
|[[MakeUnPlayable - Race|'''MakeUnPlayable'''()]]
|Clears the race's playable flag.
|-
 
|[[IsChildRace - Race|Bool '''IsChildRace'''()]]
|Returns whether this race is a Child race.
|-
 
|[[MakeChildRace - Race|'''MakeChildRace'''()]]
|Sets the race's Child Race flag to true.
|-
 
|[[MakeNonChildRace - Race|'''MakeNonChildRace'''()]]
|Clears the race's Child Race flag.
|-
 
|[[CanFly - Race|Bool '''CanFly'''()]]
|Returns whether or not the race can fly.
|-
 
|[[MakeCanFly - Race|'''MakeCanFly'''()]]
|Sets the race's Flies flag to true.
|-
 
|[[MakeNonFlying - Race|'''MakeNonFlying'''()]]
|Clears the race's Flies flag.
|-
 
|[[CanSwim - Race|Bool '''CanSwim'''()]]
|Returns whether the race can swim or not.
|-
 
|[[MakeCanSwim - Race|'''MakeCanSwim'''()]]
|Sets the race's Swims flag to true.
|-
 
|[[MakeNonSwimming - Race|'''MakeNonSwimming'''()]]
|Clears the race's Swims flag.
|-
 
|[[CanWalk - Race|Bool '''CanWalk'''()]]
|Returns whether the race can walk or not.
|-
 
|[[MakeCanWalk - Race|'''MakeCanWalk'''()]]
|Sets the race's Walks flag to true.
|-
 
|[[MakeNonWalking - Race|'''MakeNonWalking'''()]]
|Clears the race's Walks flag.
|-
|[[IsImmobile - Race|Bool '''IsImmobile'''()]]
|Returns whether the race is immobile or not.
|-
 
|[[MakeImmobile - Race|'''MakeImmobile'''()]]
|Sets the race's Immobile flag to true.
|-
 
|[[MakeMobile - Race|'''MakeMobile'''()]]
|Clears the race's Immobile flag.
|-
 
|[[IsNotPushable - Race|Bool '''IsNotPushable'''()]]
|Returns whether the race is pushable.
|-
 
|[[MakeNotPushable - Race|'''MakeNotPushable'''()]]
|Sets the race's Not Pushable flag to true.
|-
 
|[[MakePushable - Race|'''MakePushable'''()]]
|Clears the race's Not Pushable flag.
|-
 
|[[NoKnockdowns - Race|Bool '''NoKnockdowns'''()]]
|Returns whether the race can be knocked down or not.
|-
 
|[[MakeNoKnockdowns - Race|'''MakeNoKnockdowns'''()]]
|Sets the race's No Knockdowns flag to true.
|-
 
|[[ClearNoKnockdowns - Race|'''ClearNoKnockdowns'''()]]
|Clears the race's No Knockdowns flag.
|-
 
|[[NoCombatInWater - Race|Bool '''NoCombatInWater'''()]]
|Returns whether the race can fight while swimming or not.
|-
 
|[[SetNoCombatInWater - Race|'''SetNoCombatInWater'''()]]
|Sets the race's No Combat In Water flag to true.
|-
 
|[[ClearNoCombatInWater - Race|'''ClearNoCombatInWater'''()]]
|Clears the race's No Combat In Water flag.
|-
 
|[[AvoidsRoads - Race|Bool '''AvoidsRoads'''()]]
|Returns whether the race avoids roads or not.
|-
 
|[[SetAvoidsRoads - Race|'''SetsAvoidsRoads'''()]]
|Sets the race's Avoids Roads flag to true.
|-
 
|[[ClearsAvoidsRoads - Race|'''ClearsAvoidsRoads'''()]]
|Clears the race's Avoid Roads flag.
|-
 
|[[AllowPickpocket - Race|Bool '''AllowPickpocket'''()]]
|Returns whether the player can be Pickpocket this race.
|-
 
|[[SetAllowPickpocket - Race|'''SetAllowPickpocket'''()]]
|Sets the race's Allow Pickpocket flag to true.
|-
 
|[[ClearAllowPickpocket - Race|'''ClearAllowPickpocket'''()]]
|Clears the race's Allow Pickpocket flag.
|-
 
|[[AllowPCDialogue - Race|Bool '''AllowPCDialogue'''()]]
|Returns whether or not the player is allowed to talk to actors of this race.
|-
 
|[[SetAllowPCDialogue - Race|'''SetAllowPCDialogue'''()]]
|Sets the race's Allow PC Dialogue flag to true.
|-
 
|[[ClearAllowPCDialogue - Race|'''ClearAllowPCDialogue'''()]]
|Clears the race's Allow PC Dialogue flag.
|-
 
|[[CantOpenDoors - Race|Bool '''CantOpenDoors'''()]]
|Returns whether the race cannot open doors.
|-
 
|[[SetCantOpenDoors - Race|'''SetCantOpenDoors'''()]]
|Sets the race's Cant Open Doors flag to true.
|-
 
|[[ClearCantOpenDoors - Race|'''ClearCantOpenDoors'''()]]
|Clears the race's Cant Open Doors flag.
|-
|-


|[[GetNthPlayableRace - Race|Race '''GetNthPlayableRace'''(Int ''n'')]]
|[[NoShadow - Race|Bool '''NoShadow'''()]]
|Returns the Nth playable race.
|Returns whether the race casts a shadow or not.
|-
|-


|[[GetRace - Race|Race '''GetRace'''(String ''editorId'')]]
|[[SetNoShadow - Race|'''SetNoShadow'''()]]
|Returns a race by its editorId name.
|Sets the race's No Shadow flag to true.
|-
|-


|[[ClearNoShadow - Race|'''ClearNoShadow'''()]]
|Clears the race's No Shadow flag.
|-
|}
|}


== Events ==
== Events ==
None
None

Revision as of 23:08, 25 October 2013


Extends: Form Script

Script for the manipulation of a character's race.

Definition

ScriptName Race extends Form

Properties

None

SKSE Properties

Global Functions

None

Member Functions

None

SKSE Global Functions

Function Description
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

Function Description
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

Retrieved from "https://ck.uesp.net/w/index.php?title=Race_Script&oldid=14695"