Category:Pluggy

From the Oblivion ConstructionSet Wiki
Revision as of 15:56, 27 February 2009 by imported>Haama (Notes on recent versions, crashes, and where to get older versions)
Jump to navigation Jump to search



Pluggy
Author(s)

Elys

Current Version Beta 122 (GetPluginVersion returns 122)
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
  • Hud creation (>= v101)
Installation
  • Automated Install:
    1. Run the downloaded .msi file
    2. Point the install folder to the Oblivion install directory (..\Oblivion\, not the ..\Oblivion\Data\ directory)
  • Manual Install:
    1. Browse to the folder Oblivion\Data\obse\plugins
    2. Extract the contents of the downloaded zip into that folder
Download

http://karamail.nerim.net/elys/Pluggy

    • The latest, HUD-containing versions have been found to cause crashes for some users (mostly nVidia users) on interior/exterior crashes. There are some safe, old versions of Pluggy on TESNexus. See this thread for more information.
Source Code

http://karamail.nerim.net/elys/Pluggy

Discussions
OBSE Name "OBSE_Elys_Pluggy"

(for use with IsPluginInstalled/GetPluginVersion)


Introduction

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

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.

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

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.

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.

Subcategories

This category has the following 5 subcategories, out of 5 total.

A

F

H

S