Difference between revisions of "ActorBase Script"
Jump to navigation
Jump to search
imported>Qazaaq (Crosslinked to editor reference) |
imported>Qazaaq (Undo revision 9322 by Scrivener07 (talk)) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
<BR/> | |||
'''Editor:''' [[Actor]] | '''Editor:''' [[Actor]] | ||
Script for the manipulation of actor base objects. [[Actor Script | Script for the manipulation of actor base objects. [[Actor Script]]s are references of this. | ||
== Definition == | == Definition == | ||
| Line 15: | Line 12: | ||
== Properties == | == Properties == | ||
None | None | ||
== F4SE Structs == | |||
*Struct [[BodyWeight Struct - ActorBase|BodyWeight]] | |||
**A structure containing an actors body weight information. | |||
== Global Functions == | == Global Functions == | ||
| Line 52: | Line 53: | ||
*Function [[SetOutfit - ActorBase|SetOutfit]](Outfit akOutfit,bool abSleepOutfit) | *Function [[SetOutfit - ActorBase|SetOutfit]](Outfit akOutfit,bool abSleepOutfit) | ||
**Change the default or sleep outfit. Art will be loaded next time this actor is loaded. | **Change the default or sleep outfit. Art will be loaded next time this actor is loaded. | ||
== F4SE Member Functions == | |||
*BodyWeight Function [[GetBodyWeight - ActorBase|GetBodyWeight]]() | |||
**Returns this actors body weight information. | |||
*HeadPart[] Function [[GetHeadParts - ActorBase|GetHeadParts]](bool bOverlays) | |||
**Returns the head part array from either the overlay list or original list. | |||
*Outfit Function [[GetOutfit - ActorBase|GetOutfit]](bool bSleepOutfit) | |||
**Get the Outfit of the actor. | |||
*ActorBase Function [[GetTemplate - ActorBase|GetTemplate]](bool bTopMost) | |||
**Gets the template of the ActorBase, topmost will return the highest parent. | |||
*bool Function [[HasHeadPartOverlays - ActorBase|HasHeadPartOverlays]]() | |||
**Returns whether this ActorBase has any overlay head parts. | |||
*Function [[SetBodyWeight - ActorBase|SetBodyWeight]](BodyWeight weight) | |||
**Modifies this actors body weight information. | |||
== Events == | == Events == | ||
| Line 59: | Line 74: | ||
* Any changes made to a leveled actor's leveled (or 'temporary') base will be lost when the actor re-levels. | * Any changes made to a leveled actor's leveled (or 'temporary') base will be lost when the actor re-levels. | ||
* Any changes made to a leveled actor's non-leveled (or editor) base will not show up on the actor until the actor re-levels. | * Any changes made to a leveled actor's non-leveled (or editor) base will not show up on the actor until the actor re-levels. | ||
== See Also == | |||
*[[Actor]] | |||
*[[:Category:Actor|Actor Category]] | |||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:Actor]] | |||
Latest revision as of 22:54, 20 January 2018
Extends: Form Script
Editor: Actor
Script for the manipulation of actor base objects. Actor Scripts are references of this.
Definition[edit | edit source]
ScriptName ActorBase extends Form Native HiddenProperties[edit | edit source]
None
F4SE Structs[edit | edit source]
- Struct BodyWeight
- A structure containing an actors body weight information.
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Class Function GetClass()
- Returns this actor's class.
- int Function GetDeadCount()
- Returns the number of actors that have this base that are dead.
- FormList Function GetGiftFilter()
- Returns this actor's formlist of keywords to use as a gift filter.
- int Function GetLevel()
- Returns this actor's level.
- int Function GetLevelExact() native
- Returns this actor's level unmodified by the player's level.
- Race Function GetRace()
- Returns this actor's race.
- int Function GetSex()
- Returns this actor's gender.
- Actor Function GetUniqueActor()
- Get the actor for this unique NPC if it currently exists.
- bool Function IsEssential()
- Returns if this actor is flagged as essential or not.
- bool Function IsInvulnerable()
- Returns if this actor is flagged as invulnerable or not.
- bool Function IsProtected()
- Returns if this actor is flagged as protected or not.
- bool Function IsUnique()
- Returns if this actor is flagged as unique.
- Function SetEssential(bool abEssential)
- Flags this actor as essential or not. An actor cannot both be protected and essential.
- Function SetInvulnerable(bool abInvulnerable)
- Flags this actor as invulnerable or not.
- Function SetProtected(bool abProtected)
- Flags this actor as protected or not. An actor cannot both be protected and essential.
- Function SetOutfit(Outfit akOutfit,bool abSleepOutfit)
- Change the default or sleep outfit. Art will be loaded next time this actor is loaded.
F4SE Member Functions[edit | edit source]
- BodyWeight Function GetBodyWeight()
- Returns this actors body weight information.
- HeadPart[] Function GetHeadParts(bool bOverlays)
- Returns the head part array from either the overlay list or original list.
- Outfit Function GetOutfit(bool bSleepOutfit)
- Get the Outfit of the actor.
- ActorBase Function GetTemplate(bool bTopMost)
- Gets the template of the ActorBase, topmost will return the highest parent.
- bool Function HasHeadPartOverlays()
- Returns whether this ActorBase has any overlay head parts.
- Function SetBodyWeight(BodyWeight weight)
- Modifies this actors body weight information.
Events[edit | edit source]
None
Notes[edit | edit source]
- Any changes made to a leveled actor's leveled (or 'temporary') base will be lost when the actor re-levels.
- Any changes made to a leveled actor's non-leveled (or editor) base will not show up on the actor until the actor re-levels.