Difference between revisions of "GetActorsInHigh"
Jump to navigation
Jump to search
imported>SJML Bot (Bot creating condition functions pages.) |
imported>Chesko |
||
| Line 1: | Line 1: | ||
Returns the number of actors in "high" memory. These are actors that are close enough to the player to play animations, evaluate and run AI packages, and so on. Actors are swapped in and out of high memory as the player moves about the game world. This function could be used to prevent the execution of computationally or graphically expensive actions (scripts, spawning additional actors, and so on) when more than a certain number of actors are in high memory in order to maintain performance. | |||
As of Skyrim 1.8.151, this condition function is not used in Skyrim or any of its [http://www.uesp.net/wiki/Skyrim:Official_Plug-ins official plug-ins]. | |||
== Example == | |||
This function would return true if the number of actors in high memory were less than 20. | |||
[[File:chesko_confunc_GetActorsInHigh.jpg]] | |||
== Notes == | |||
* The player is '''not''' counted when evaluating GetActorsInHigh. For example, evaluating GetActorsInHigh when the player is in an interior cell with no other actors will return 0. | |||
* Dead actors are counted when evaluating GetActorsInHigh. | |||
[[Category:Console Commands]] | [[Category:Console Commands]] | ||
[[Category:Condition Functions]] | [[Category:Condition Functions]] | ||
Revision as of 15:55, 18 December 2012
Returns the number of actors in "high" memory. These are actors that are close enough to the player to play animations, evaluate and run AI packages, and so on. Actors are swapped in and out of high memory as the player moves about the game world. This function could be used to prevent the execution of computationally or graphically expensive actions (scripts, spawning additional actors, and so on) when more than a certain number of actors are in high memory in order to maintain performance.
As of Skyrim 1.8.151, this condition function is not used in Skyrim or any of its official plug-ins.
Example
This function would return true if the number of actors in high memory were less than 20.
Notes
- The player is not counted when evaluating GetActorsInHigh. For example, evaluating GetActorsInHigh when the player is in an interior cell with no other actors will return 0.
- Dead actors are counted when evaluating GetActorsInHigh.