the CreationKit Wiki

Difference between revisions of "Race Script"

Race Script (edit)

Revision as of 23:08, 25 October 2013

4,389 bytes added ,  23:08, 25 October 2013
Added SKSE Member/Global Functions
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
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/14695"