Difference between revisions of "Category:Pluggy"

Revision as of 22:10, 26 March 2008

Pluggy Beta v56 is a multifunction plugin for OBSE. It includes support for:

Single-dimension arrays
Strings, which may be saved to text files
INI files, for storing settings

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 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.
When using IsPluginInstalled or GetPluginVersion, the plugin name is "OBSE_Elys_Pluggy".

Links

Download

Discussions

All discussion threads are on the Bethesda Forums.

Subcategories

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

Pages in category "Pluggy"

The following 8 pages are in this category, out of 8 total.

D

DXtoToken

I

P

S

StringToken

@@ Line 1: / Line 1: @@
-'''Pluggy''' (latest version is Beta v56) is a plugin for OBSE that provides functions to create, store, and manipulate single-dimension arrays.
+'''Pluggy''' Beta v56 is a multifunction plugin for OBSE.  It includes support for:
+*Single-dimension arrays
+*Strings, which may be saved to text files
+*INI files, for storing settings
-==Download and Discussion Thread==
+==Introduction==
-*[http://karamail.nerim.net/elys/Pluggy Download Page]
+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]]
+==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 will not be created at the next save.
-*[http://www.bethsoft.com/bgsforums/index.php?showtopic=778904 Discussion Thread #1 (Bethesda Forums)]
+==Memory Usage==
-*[http://www.bethsoft.com/bgsforums/index.php?showtopic=813793 Discussion Thread #2 (Bethesda Forums)]
+*Memory (in-game) - 4 bytes per empty array index and 6 bytes per filled array index or string character
-*[http://www.bethsoft.com/bgsforums/index.php?showtopic=820323 Current Discussion Thread (Bethesa Forums)]
+*HDD space - 6 bytes per filled array index or string character
-==What is an array?==
+==Function Speed==
-You can think of a single-dimension array as an expandable piece of lined paper. Each line contains a bit of information. In Oblivion's case, the line can either be empty, a [[Reference_Variables|reference]], an [[Long Integer|integer (long)]], or a [[Floating Point|float]]. Each line is called an index, and they start with 0.
+*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.
-An example array:
+==Notes==
-{| border="2" cellpadding="5" cellspacing="0"
+*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.
-|-
+*When using [[IsPluginInstalled]] or [[GetPluginVersion]], the plugin name is "OBSE_Elys_Pluggy".
-!style="background:#ffdead;" |Index
-|style="background:#ffeded;" |Info in index
-|style="background:#ffeded;" |Type of info in index
-|-
-!style="background:#ffdead;" |Index 0
-|style="background:#ffeded;" |---
-|style="background:#ffeded;" |Empty
-|-
-!style="background:#ffdead;" |Index 1
-|style="background:#ffeded;" |0000000F (Gold)
-|style="background:#ffeded;" |Reference
-|-
-!style="background:#ffdead;" |Index 2
-|style="background:#ffeded;" |658
-|style="background:#ffeded;" |Long
-|-
-!style="background:#ffdead;" |Index 3
-|style="background:#ffeded;" |4.563
-|style="background:#ffeded;" |Float
-|}
-==Where are the arrays stored?==
+==Links==
-*The arrays are stored in separate .pluggy files.
+===[http://karamail.nerim.net/elys/Pluggy Download]===
-*A .pluggy file is created whenever the game is saved and there are arrays in use.
-*Each .pluggy file corresponds to it's save game file.
-*If all arrays are destroyed, or all mods that use the arrays are deactivated, the .pluggy file will be deleted.
-*The files are incredibly small - only 9 '''bytes''' per non-empty array index.
-==How much space and memory do the arrays take?==
+===Discussions===
-*Memory (in-game) - 4 bytes per empty array index and 9 bytes per filled array index
+All discussion threads are on the Bethesda Forums.
-*HDD space - 9 bytes per filled array index
+*[http://www.bethsoft.com/bgsforums/index.php?showtopic=778904 Discussion Thread #1]
+*[http://www.bethsoft.com/bgsforums/index.php?showtopic=813793 Discussion Thread #2]
+*[http://www.bethsoft.com/bgsforums/index.php?showtopic=820323 Current Discussion Thread]
-==How fast are the functions?==
-*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.
-==Some peculiarities (compared to other Oblivion functions)==
-*Most 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.
-**For example, '''ArraySize 0''' will return the size of Array 0 while '''ArraySize 0 10''' will set Array 0's size to 10 indexes.
-*Each array is associated with a mod (either Esp or Esm). If the mod is removed then the array will be removed once the player saves.
-**There is also a system to prevent other mods from accidentally modifying your arrays and to prevent other mods from modifying your arrays.
-**#To modify an array from another mod the modder will need to include a special Global flag to their function.
-**#If you want to prevent any other mod from modifying your arrays, add a special Protection flag when you create it or set it later with [[ArrayProtect]]
-**#Note that other mods will be able to look at your array regardless of Protection or Global flags.
-**#The corresponding mod for each array can be changed with [[ArrayEsp]].
-*Each array has its own ID which is a [[Long]] number from 0 up. For instance, the first array you create will have an ID of 0, and the second one will have an ID of 1. The ID is returned when you create the array (either via [[CreateArray]] or [[CopyArray]]).
-**You can store the ID in a [[Long]] variable, scripted effect (with [[SetNthEffectItemMagnitude]]), etc., and it behaves exactly like any other number.
-**If you wish to test a variable for a valid ArrayID, use the function [[ArrayCount]].
-***While various Pluggy functions are capable of checking the validity of an ArrayID, [[ArrayCount]] is recommended since it does not have the potential to alter the array if used incorrectly.
-*Arrays have indexes from 0 to (array size - 1). The array size is set when you first create the array and can be modified with [[ArraySize]], or when inserting data with the '''SetInArray''' functions.
-*There are 3 '''SetInArray''' and '''FindInArray''' functions: one for integers, one for floats, and one for references.
-*When using [[IsPluginInstalled]] or [[GetPluginVersion]], the plugin name is "OBSE_Elys_Pluggy".
 [[Category: OBSE Plug-Ins]]
 [[Category: Functions]]
 [[Category: Functions (OBSE)]]