Category:Pluggy

From The Elder Scrolls Construction Set Wiki

Pluggy
Author(s)	Elys
Current Version	Beta 89 (GetPluginVersion returns 89)
Description	Pluggy is a multifunction plugin for OBSE. Its main features include: Single-dimension array support String variables The ability to save strings to text files True INI file support, both reading and writing values
Installation	Automated Install: Simply run the downloaded .msi file Manual Install: Browse to the folder Oblivion\Data\obse\plugins Extract the contents of the downloaded zip into that folder
Download	http://karamail.nerim.net/elys/Pluggy
Source Code	http://karamail.nerim.net/elys/Pluggy
Discussions	[WIP] Pluggy [WIP/BETA] Pluggy #2 [WIP/BETA] Pluggy #3 [WIP/BETA] Pluggy #4 [WIP/BETA] Pluggy #5
OBSE Name	"OBSE_Elys_Pluggy" (for use with IsPluginInstalled/GetPluginVersion)

[edit] Introduction

See the following pages to get an overview of the various Pluggy capabilities:

• Introduction to Pluggy Arrays
• Introduction to Pluggy Strings
• Introduction to Pluggy INI Files

[edit] Data Storage

• The arrays/strings are stored in files with the extension .pluggy in "My Documents\My Games\Oblivion\Saves"
• A .pluggy file is created whenever the game is saved and there are arrays/strings in use.
• Each .pluggy file's name corresponds to its associated save file, e.g. "autosave.pluggy" corresponds with "autosave.ess".
• If all arrays/strings are destroyed, or all mods that were using arrays/strings are deactivated, the .pluggy file will not be created at the next save.

[edit] Memory Usage

• Memory (in-game) - 4 bytes per empty array index and 6 bytes per filled array index or string character
• HDD space - 6 bytes per filled array index or string character

[edit] Function Speed

• Not fully tested, but running 900 Pluggy "Find" calls only took half a second while 900 GetInventoryObject calls took 10 seconds. In short, these are incredibly fast functions.

[edit] Notes

• Many Pluggy functions can be used to both return and set a value. This is determined by an optional flag - if it's left empty the value will be returned and if it's filled the value will be set to that flag.
• All files used by Pluggy functions must be located under "...\My Documents\My Games\Oblivion\Pluggy\User Files". This includes INI files, plain text files, and files that are saved/created by a script.