Skip to content
root-cause edited this page Apr 18, 2020 · 1 revision

Welcome to the AreaLibrary wiki!

AreaLibrary is a Script Hook V .NET library that aims to simplify distance checking in Script Hook V .NET projects by providing areas and raising events when needed.


Features

  • Event based

    • AreaLibrary raises events when the player ped/a tracked entity enters/leaves a defined area. (Example: AreaExample.cs)
  • Area data

  • Entity tracking

  • Extensible

    • Scripters can implement custom areas/shapes by inheriting AreaBase class.

Using in a project

  1. Make sure your project has Script Hook V .NET v2.10.12 as a reference.
  2. Download the latest stable version from here.
  3. Add the .dll to your project as a reference.
  4. Import by adding using AreaLib; to your code.

IMPORTANT: Script developers should not redistribute AreaLibrary.dll as it might cause people to have outdated versions in the future, it's better to send people to the releases page.


Documentation & Examples

For now, refer to AreaLibrary.xml (inside AreaLibrary.zip) and example scripts.

More example scripts might be added in the future.