Difference between revisions of "EncounterZone Script"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added f4se script) |
||
| Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | |||
[[ | |||
''' | '''Editor:''' [[Encounter Zone]] | ||
Script for the manipulation of encounter zones. | Script for the manipulation of encounter zones. | ||
| Line 25: | Line 23: | ||
*Function [[Reset - EncounterZone|Reset]]() | *Function [[Reset - EncounterZone|Reset]]() | ||
**Flags this encounter zone for reset on next load. | **Flags this encounter zone for reset on next load. | ||
== F4SE Functions == | |||
*Location Function [[GetLocation - EncounterZone|GetLocation]]() | |||
** Gets the location for this encounter zone. | |||
*Function [[SetLocation - EncounterZone|SetLocation]](Location akLoc) | |||
** Sets the location for this encounter zone. | |||
*int Function [[GetRank - EncounterZone|GetRank]]() | |||
** Gets the rank for this encounter zone. | |||
*Function [[SetRank - EncounterZone|SetRank]](int rank) | |||
** Sets the rank for this encounter zone. | |||
*int Function [[GetMinLevel - EncounterZone|GetMinLevel]]() | |||
** Gets the minimum level for this encounter zone. | |||
*Function [[SetMinLevel - EncounterZone|SetMinLevel]](int level) | |||
** Sets the minimum level for this encounter zone. | |||
*int Function [[GetMaxLevel - EncounterZone|GetMaxLevel]]() | |||
** Gets the maximum level for this encounter zone. | |||
*Function [[SetMaxLevel - EncounterZone|SetMaxLevel]](int level) | |||
** Sets the maximum level for this encounter zone. | |||
*bool Function [[IsNeverResetable - EncounterZone|IsNeverResetable]]() | |||
** Sets whether this encounter zone can be reset or not. | |||
*Function [[SetNeverResetable - EncounterZone|SetNeverResetable]](bool resetable) | |||
** Gets whether this encounter zone can be reset or not. | |||
*bool Function [[IsWorkshop - EncounterZone|IsWorkshop]]() | |||
** Gets whether this encounter zone has workshop enabled or not. | |||
*Function [[SetWorkshop - EncounterZone|SetWorkshop]](bool ws) | |||
** Sets whether this encounter zone has workshop enabled or not. | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
Revision as of 17:39, 21 October 2017
Extends: Form Script
Editor: Encounter Zone
Script for the manipulation of encounter zones.
Definition
ScriptName EncounterZone extends Form Native HiddenProperties
None
Global Functions
None
Member Functions
- int Function CountActors(Keyword apRequiredLinkedRefKeyword, Keyword apExcludeLinkedRefKeyword)
- Counts the number of promoted/persistent actors associated with this encounter zone.
- Actor[] Function GetActors(Keyword apRequiredLinkedRefKeyword, Keyword apExcludeLinkedRefKeyword)
- Gets an array of the promoted/persistent actors associated with this encounter zone.
- Function Reset()
- Flags this encounter zone for reset on next load.
F4SE Functions
- Location Function GetLocation()
- Gets the location for this encounter zone.
- Function SetLocation(Location akLoc)
- Sets the location for this encounter zone.
- int Function GetRank()
- Gets the rank for this encounter zone.
- Function SetRank(int rank)
- Sets the rank for this encounter zone.
- int Function GetMinLevel()
- Gets the minimum level for this encounter zone.
- Function SetMinLevel(int level)
- Sets the minimum level for this encounter zone.
- int Function GetMaxLevel()
- Gets the maximum level for this encounter zone.
- Function SetMaxLevel(int level)
- Sets the maximum level for this encounter zone.
- bool Function IsNeverResetable()
- Sets whether this encounter zone can be reset or not.
- Function SetNeverResetable(bool resetable)
- Gets whether this encounter zone can be reset or not.
- bool Function IsWorkshop()
- Gets whether this encounter zone has workshop enabled or not.
- Function SetWorkshop(bool ws)
- Sets whether this encounter zone has workshop enabled or not.
Events
None