Difference between revisions of "Race Script"
Reverted to List
imported>CraftySentinel (Added SKSE Member/Global Functions) |
imported>CraftySentinel (Reverted to List) |
||
Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Script for the manipulation of a character's race. | Script for the manipulation of a character's race. | ||
== Definition == | == Definition == | ||
Line 12: | Line 9: | ||
</source> | </source> | ||
== SKSE Properties == | == SKSE Properties == | ||
*[[Race Flags - Race|List of Race Flags]] | *[[Race Flags - Race|List of Race Flags]] | ||
== Global Functions == | == Global Functions == | ||
None | None | ||
== Member Functions == | == Member Functions == | ||
Line 26: | Line 23: | ||
== SKSE Global Functions == | == SKSE Global Functions == | ||
:'''Int [[GetNumPlayableRaces - Race|GetNumPlayableRaces]]()''' | |||
:*Returns the number of playable races. | |||
:'''Race [[GetNthPlayableRace - Race|GetNthPlayableRace]](Int ''n'')''' | |||
:*Returns the Nth playable race. | |||
:'''Race [[GetRace - Race|GetRace]](String ''editorId'')''' | |||
:*Returns a race by its editorId name. | |||
== SKSE Member Functions == | |||
:'''Int [[GetSpellCount - Race|GetSpellCount]]()''' | |||
:*Returns the number of spells for the race. | |||
:'''Spell [[GetNthSpell - Race|GetNthSpell]](Int ''n'')''' | |||
:*Returns the specified spell from the race. | |||
:'''Bool [[IsRaceFlagSet - Race|IsRaceFlagSet]](Int ''n'')''' | |||
:*Returns whether the specified race flag is set. | |||
:'''[[SetRaceFlag - Race|SetRaceFlag]](Int ''n'')''' | |||
:*Sets the specified race flag. | |||
:'''[[ClearRaceFlag - Race|ClearRaceFlag]](Int ''n'')''' | |||
:*Clears the specified race flag. | |||
:'''VoiceType [[GetDefaultVoiceType - Race|GetDefaultVoiceType]]()''' | |||
:*Returns the race's default voice type. | |||
:'''[[SetDefaultVoiceType - Race|SetDefaultVoiceType]](VoiceType ''voice'')''' | |||
:*Sets the race's default voice type. | |||
:'''Armor [[GetSkin - Race|GetSkin]]()''' | |||
:*Returns the race's skin. | |||
:'''[[SetSkin - Race|SetSkin]](Armor ''skin'')''' | |||
:*Sets the race's skin. | |||
:'''Bool [[IsPlayable - Race|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. | |||
:'''Bool [[IsChildRace - Race|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. | |||
:'''Bool [[CanFly - Race|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. | |||
:'''Bool [[CanSwim - Race|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. | |||
:'''Bool [[CanWalk - Race|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. | |||
:'''Bool [[IsImmobile - Race|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. | |||
:'''Bool [[IsNotPushable - Race|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. | |||
:'''Bool [[NoKnockdowns - Race|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. | |||
:'''Bool [[NoCombatInWater - Race|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. | |||
:'''Bool [[AvoidsRoads - Race|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. | |||
:'''Bool [[AllowPickpocket - Race|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. | |||
:'''Bool [[AllowPCDialogue - Race|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. | |||
:'''Bool [[CantOpenDoors - Race|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. | |||
:'''Bool [[NoShadow - Race|NoShadow]]()''' | |||
:*Returns whether the race casts a shadow or not. | |||
:'''[[SetNoShadow - Race|SetNoShadow]]()''' | |||
:*Sets the race's No Shadow flag to true. | |||
:'''[[ClearNoShadow - Race|ClearNoShadow]]()''' | |||
:*Clears the race's No Shadow flag. | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] |