Difference between revisions of "EncounterZone Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Qazaaq
m (line break)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
<BR/>
'''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 Member Functions ==
*Location Function [[GetLocation - EncounterZone|GetLocation]]()
** Gets the location for this encounter zone.
*int Function [[GetMaxLevel - EncounterZone|GetMaxLevel]]()
** Gets the maximum level for this encounter zone.
*int Function [[GetMinLevel - EncounterZone|GetMinLevel]]()
** Gets the minimum level for this encounter zone.
*int Function [[GetRank - EncounterZone|GetRank]]()
** Gets the rank for this encounter zone.
*bool Function [[IsNeverResetable - EncounterZone|IsNeverResetable]]()
** 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 [[SetLocation - EncounterZone|SetLocation]](Location akLoc)
** Sets the location for this encounter zone.
*Function [[SetMaxLevel - EncounterZone|SetMaxLevel]](int level)
** Sets the maximum level for this encounter zone.
*Function [[SetMinLevel - EncounterZone|SetMinLevel]](int level)
** Sets the minimum level for this encounter zone.
*Function [[SetNeverResetable - EncounterZone|SetNeverResetable]](bool resetable)
** Sets whether this encounter zone can be reset or not.
*Function [[SetRank - EncounterZone|SetRank]](int rank)
** Sets the rank for this encounter zone.
*Function [[SetWorkshop - EncounterZone|SetWorkshop]](bool ws)
** Sets whether this encounter zone has workshop enabled or not.


== Events ==
== Events ==
None
None
== See Also ==
*[[Location]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

Latest revision as of 23:57, 6 November 2017

Extends: Form Script
Editor: Encounter Zone

Script for the manipulation of encounter zones.

Definition[edit | edit source]

ScriptName EncounterZone extends Form Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • 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 Member Functions[edit | edit source]

  • Location Function GetLocation()
    • Gets the location for this encounter zone.
  • int Function GetMaxLevel()
    • Gets the maximum level for this encounter zone.
  • int Function GetMinLevel()
    • Gets the minimum level for this encounter zone.
  • int Function GetRank()
    • Gets the rank for this encounter zone.
  • bool Function IsNeverResetable()
    • Gets whether this encounter zone can be reset or not.
  • bool Function IsWorkshop()
    • Gets whether this encounter zone has workshop enabled or not.
  • Function SetLocation(Location akLoc)
    • Sets the location for this encounter zone.
  • Function SetMaxLevel(int level)
    • Sets the maximum level for this encounter zone.
  • Function SetMinLevel(int level)
    • Sets the minimum level for this encounter zone.
  • Function SetNeverResetable(bool resetable)
    • Sets whether this encounter zone can be reset or not.
  • Function SetRank(int rank)
    • Sets the rank for this encounter zone.
  • Function SetWorkshop(bool ws)
    • Sets whether this encounter zone has workshop enabled or not.

Events[edit | edit source]

None

See Also[edit | edit source]