Difference between revisions of "ActorBase Script"

Jump to navigation Jump to search

ActorBase Script (edit)

Revision as of 03:42, 24 October 2013

135 bytes added ,  03:42, 24 October 2013
m
Formatting Change
imported>CraftySentinel
(→‎SKSE Member Functions: Added Latest SKSE Member Functions.)
imported>CraftySentinel
m (Formatting Change)
Line 19: Line 19:
== Global Functions ==
== Global Functions ==
None
None


== Member Functions ==
== Member Functions ==
'''Class Function [[GetClass - ActorBase|GetClass]]()'''
*Returns this actor's class.


'''int Function [[GetDeadCount - ActorBase|GetDeadCount]]()'''
{|class="wikitable" width =100%
*Returns the number of actors that have this base that are dead.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-
|[[GetClass - ActorBase|Class '''GetClass'''()]]
|Returns this actor's class.
|-


'''FormList Function [[GetGiftFilter - ActorBase|GetGiftFilter]]()'''
|[[GetDeadCount - ActorBase|Int '''GetDeadCount'''()]]
*Returns this actor's formlist of keywords to use as a gift filter.
|Returns the number of actors that have this base that are dead.
|-


'''Race Function [[GetRace - ActorBase|GetRace]]()'''
|[[GetGiftFilter - ActorBase|FormList '''GetGiftFilter'''()]]
*Returns this actor's race.
|Returns this actor's formlist of keywords to use as a gift filter.
|-


'''int Function [[GetSex - ActorBase|GetSex]]()'''
|[[GetRace - ActorBase|Race '''GetRace'''()]]
*Returns this actor's sex.
|Returns this actor's race.
|-


'''bool Function [[IsEssential - ActorBase|IsEssential]]()'''
|[[GetSex - ActorBase|Int '''GetSex'''()]]
*Returns if this actor is flagged as essential or not.
|Returns this actor's sex.
|-


'''bool Function [[IsInvulnerable - ActorBase|IsInvulnerable]]()'''
|[[IsEssential - ActorBase|Bool '''IsEssential'''()]]
*Returns if this actor is flagged as invulnerable or not.
|Returns if this actor is flagged as essential or not.
|-


'''bool Function [[IsProtected - ActorBase|IsProtected]]()'''
|[[IsInvulnerable - ActorBase|Bool '''IsInvulnerable'''()]]
*Returns if this actor is flagged as protected or not.
|Returns if this actor is flagged as invulnerable or not.
|-


'''bool Function [[IsUnique - ActorBase|IsUnique]]()'''
|[[IsProtected - ActorBase|Bool '''IsProtected'''()]]
*Returns if this actor is flagged as unique.
|Returns if this actor is flagged as protected or not.
|-


'''Function [[SetEssential - ActorBase|SetEssential]](bool abEssential)'''
|[[IsUnique - ActorBase|Bool '''IsUnique'''()]]
*Flags this actor as essential or not. An actor cannot both be protected and essential.
|Returns if this actor is flagged as unique.
|-


'''Function [[SetInvulnerable - ActorBase|SetInvulnerable]](bool abInvulnerable)'''
|[[SetEssential - ActorBase|'''SetEssential'''(Bool ''abEssential'')]]
*Flags this actor as invulnerable or not.
|Flags this actor as essential or not. An actor cannot both be protected and essential.
|-


'''Function [[SetProtected - ActorBase|SetProtected]](bool abProtected)'''
|[[SetInvulnerable - ActorBase|'''SetInvulnerable'''(Bool ''abInvulnerable'')]]
*Flags this actor as protected or not. An actor cannot both be protected and essential.
|Flags this actor as invulnerable or not.
|-


'''Function [[SetOutfit - ActorBase|SetOutfit]](Outfit akOutfit,bool abSleepOutfit)'''
|[[SetProtected - ActorBase|'''SetProtected'''(Bool ''abProtected'')]]
*Change the default or sleep outfit. Art will be loaded next time this actor is loaded.
|Flags this actor as protected or not. An actor cannot both be protected and essential.
|-
 
|[[SetOutfit - ActorBase|'''SetOutfit'''(Outfit ''akOutfit'', Bool ''abSleepOutfit'')]]
|Change the default or sleep outfit. Art will be loaded next time this actor is loaded.
|-
 
|}


== SKSE Member Functions ==
== SKSE Member Functions ==
'''CombatStyle Function [[GetCombatStyle - ActorBase|GetCombatStyle]]()'''
*Returns the combat style of this actor.


'''Function [[SetCombatStyle - ActorBase|SetCombatStyle]](CombatStyle cs)'''
{|class="wikitable" width =100%
*Sets the combat style of this actor.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-
|[[GetCombatStyle - ActorBase|CombatStyle '''GetCombatStyle'''()]]
|Returns the combat style of this actor.
|-
 
|[[SetCombatStyle - ActorBase|'''SetCombatStyle'''(CombatStyle ''cs'')]]
|Sets the combat style of this actor.
|-


'''Outfit Function [[GetOutfit - ActorBase|GetOutfit]](bool bSleepOutfit = false)'''
|[[GetOutfit - ActorBase|Outfit '''GetOutfit'''(Bool ''bSleepOutfit'')]]
*Returns the default or sleep outfit of this actor.
|Returns the default or sleep outfit of this actor.
|-


'''Function [[SetClass - ActorBase|SetClass]](Class c)'''
|[[SetClass - ActorBase|'''SetClass'''(Class ''c'')]]
*Changes the class of this actor.
|Changes the class of this actor.
|-


'''float Function [[GetHeight - ActorBase|GetHeight]]()'''
|[[GetHeight - ActorBase|Float '''GetHeight'''()]]
*Returns the height of this actor.
|Returns the height of this actor.
|-


'''Function [[SetHeight - ActorBase|SetHeight]](float height)'''
|[[SetHeight - ActorBase|'''SetHeight'''(Float ''height'')]]
*Sets the height of this actor to the specified amount.
|Sets the height of this actor to the specified amount.
|-


'''float Function [[GetWeight - ActorBase|GetWeight]]()'''
|[[GetWeight - ActorBase|Float '''GetWeight'''()]]
*Returns the weight of this actor.
|Returns the weight of this actor.
|-


'''Function [[SetWeight - ActorBase|SetWeight]](float weight)'''
|[[SetWeight - ActorBase|'''SetWeight'''(Float ''weight'')]]
*Changes the weight of this actor.
|Changes the weight of this actor.
|-


'''int Function [[GetNumHeadParts - ActorBase|GetNumHeadParts]]()'''
|[[GetNumHeadParts - ActorBase|Int '''GetNumHeadParts'''()]]
*Returns the number of head parts of this actor.
|Returns the number of head parts of this actor.
|-


'''HeadPart Function [[GetNthHeadPart - ActorBase|GetNthHeadPart]](int slotPart)'''
|[[GetNthHeadPart - ActorBase|HeadPart '''GetNthHeadPart'''(Int ''slotPart'')]]
*Returns the specified head part of this actor.
|Returns the specified head part of this actor.
|-


'''Function [[SetNthHeadPart - ActorBase|SetNthHeadPart]](HeadPart headPart, int slotPart)'''
|[[SetNthHeadPart - ActorBase|'''SetNthHeadPart'''(HeadPart ''headPart'', Int ''slotPart'')]]
*Changes the specified head part of this actor.
|Changes the specified head part of this actor.
|-


'''float Function [[GetFaceMorph - ActorBase|GetFaceMorph]](int index)'''
|[[GetFaceMorph - ActorBase|Float '''GetFaceMorph'''(Int ''index'')]]
* Returns the specified head morph value of this actor.
| Returns the specified head morph value of this actor.
|-


'''Function [[SetFaceMorph - ActorBase|SetFaceMorph]](float value, int index)'''
|[[SetFaceMorph - ActorBase|'''SetFaceMorph'''(Float ''value'', Int ''index'')]]
* Changes the specified face morph value of this actor.
| Changes the specified face morph value of this actor.
|-


'''int Function [[GetFacePreset - ActorBase|GetFacePreset]](int index)'''
|[[GetFacePreset - ActorBase|Int '''GetFacePreset'''(Int ''index'')]]
*Returns the face preset of this actor.
|Returns the face preset of this actor.
|-


'''Function [[SetFacePreset - ActorBase|SetFacePreset]](int value, int index)'''
|[[SetFacePreset - ActorBase|'''SetFacePreset'''(Int ''value'', Int ''index'')]]
*Changes the face preset of this actor.
|Changes the face preset of this actor.
|-


'''ColorForm Function [[GetHairColor - ActorBase|GetHairColor]]()'''
|[[GetHairColor - ActorBase|ColorForm '''GetHairColor'''()]]
*Returns the ColorForm of this actor's hair.
|Returns the ColorForm of this actor's hair.
|-


'''Function [[SetHairColor - ActorBase|SetHairColor]](ColorForm color)'''
|[[SetHairColor - ActorBase|'''SetHairColor'''(ColorForm ''color'')]]
*Changes the ColorForm of this actor's hair.
|Changes the ColorForm of this actor's hair.
|-


'''Int Function [[GetSpellCount - ActorBase|GetSpellCount]]()'''
|[[GetSpellCount - ActorBase|Int '''GetSpellCount'''()]]
*Returns the number of spells defined in the base actor form.
|Returns the number of spells defined in the base actor form.
|-


'''Spell Function [[GetNthSpell - ActorBase|GetNthSpell]](int n)'''
|[[GetNthSpell - ActorBase|Spell '''GetNthSpell'''(Int ''n'')]]
*Returns the specified spell defined in the base actor form.
|Returns the specified spell defined in the base actor form.
|-


'''TextureSet Function [[GetFaceTextureSet - ActorBase|GetFaceTextureSet]]()'''
|[[GetFaceTextureSet - ActorBase|TextureSet '''GetFaceTextureSet'''()]]
*Returns the face TextureSet of the actor.
|Returns the face TextureSet of the actor.
|-


'''Function [[SetFaceTextureSet - ActorBase|SetFaceTextureSet]](TextureSet textures)'''
|[[SetFaceTextureSet - ActorBase|'''SetFaceTextureSet'''(TextureSet ''textures'')]]
*Sets the face TextureSet of the actor.
|Sets the face TextureSet of the actor.
|-


'''VoiceType Function [[GetVoiceType - ActorBase|GetVoiceType]]()'''
|[[GetVoiceType - ActorBase|VoiceType '''GetVoiceType'''()]]
*Returns the Actor's voicetype.
|Returns the Actor's voicetype.
|-


'''Function [[SetVoiceType - ActorBase|SetVoiceType]](VoiceType nVoice)'''
|[[SetVoiceType - ActorBase|'''SetVoiceType'''(VoiceType ''nVoice'')]]
*Sets the Actor's voicetype.
|Sets the Actor's voicetype.
|-


'''Armor Function [[GetSkin - ActorBase|GetSkin]]()'''
|[[GetSkin - ActorBase|Armor '''GetSkin'''()]]
*Returns the skin of the actorbase.
|Returns the skin of the actorbase.
|-


'''Function [[SetSkin - ActorBase|SetSkin]](Armor skin)'''
|[[SetSkin - ActorBase|'''SetSkin'''(Armor ''skin'')]]
*Sets the skin of the actorbase.
|Sets the skin of the actorbase.
|-


'''Armor Function [[GetSkinFar - ActorBase|GetSkinFar]]()'''
|[[GetSkinFar - ActorBase|Armor '''GetSkinFar'''()]]
*Returns the far away skin of the actorbase.
|Returns the far away skin of the actorbase.
|-


'''Function [[SetSkinFar - ActorBase|SetSkinFar]](Armor skin)'''
|[[SetSkinFar - ActorBase|'''SetSkinFar'''(Armor ''skin'')]]
*Sets the far away skin of the actorbase.
|Sets the far away skin of the actorbase.
|-


'''ActorBase Function [[GetTemplate - ActorBase|GetTemplate]]()'''
|[[GetTemplate - ActorBase|ActorBase '''GetTemplate'''()]]
*Returns the root template of the actorbase.
|Returns the root template of the actorbase.
|-


|}
== Events ==
== Events ==
None
None
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/6364"

Navigation menu