Difference between revisions of "Race Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>CraftySentinel
m (→‎SKSE Member Functions: Formatting Change)
Line 25: Line 25:


== SKSE Member Functions ==
== SKSE Member Functions ==
'''Int Function [[GetSpellCount - Race|GetSpellCount]]()'''
*Returns the number of spells for the race.


'''Spell Function [[GetNthSpell - Race|GetNthSpell]](int n)'''
{|class="wikitable" width =100%
*Returns the specified spell from the race.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetSpellCount - Race|Int '''GetSpellCount'''()]]
|Returns the number of spells for the race.
|-


'''Bool Function [[IsRaceFlagSet - Race|IsRaceFlagSet]](int n)'''
|[[GetNthSpell - Race|Spell '''GetNthSpell'''(Int ''n'')]]
*Returns whether the specified race flag is set.
|Returns the specified spell from the race.
|-


'''Function [[SetRaceFlag - Race|SetRaceFlag]](int n)'''
|[[IsRaceFlagSet - Race|Bool '''IsRaceFlagSet'''(Int ''n'')]]
*Sets the specified race flag.
|Returns whether the specified race flag is set.
|-


'''Function [[ClearRaceFlag - Race|ClearRaceFlag]](int n)'''
|[[SetRaceFlag - Race|'''SetRaceFlag'''(Int ''n'')]]
*Clears the specified race flag.
|Sets the specified race flag.
|-


'''VoiceType Function [[GetDefaultVoiceType - Race|GetDefaultVoiceType]]()'''
|[[ClearRaceFlag - Race|'''ClearRaceFlag'''(Int ''n'')]]
*Returns the race's default voice type.
|Clears the specified race flag.
|-


'''Function [[SetDefaultVoiceType - Race|SetDefaultVoiceType]](VoiceType voice)'''
|[[GetDefaultVoiceType - Race|VoiceType '''GetDefaultVoiceType'''()]]
*Sets the race's default voice type.
|Returns the race's default voice type.
|-


'''int Function [[GetNumPlayableRaces - Race|GetNumPlayableRaces]]()'''
|[[SetDefaultVoiceType - Race|'''SetDefaultVoiceType'''(VoiceType ''voice'')]]
*Returns the number of playable races.
|Sets the race's default voice type.
|-


'''Race Function [[GetNthPlayableRace - Race|GetNthPlayableRace]](int n)'''
|[[GetNumPlayableRaces - Race|Int '''GetNumPlayableRaces'''()]]
*Returns the Nth playable race.
|Returns the number of playable races.
|-


'''Race Function [[GetRace - Race|GetRace]](string editorId)'''
|[[GetNthPlayableRace - Race|Race '''GetNthPlayableRace'''(Int ''n'')]]
*Returns a race by its editorId name.
|Returns the Nth playable race.
|-
 
|[[GetRace - Race|Race '''GetRace'''(String ''editorId'')]]
|Returns a race by its editorId name.
|-
 
|}


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

Revision as of 06:24, 24 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 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.
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.

Events

None

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