Difference between revisions of "Category:Pluggy"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(Placed Name into box)
imported>Haama
(Updated TESNexus link)
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{| border="2" cellpadding="5" cellspacing="0" width="80%" align="center"
 
|-
{{OBSE Plugin
!style="background:#ffdead;" colspan="2"|<font size="3">Pluggy Beta v56</font>
|Version=Beta 124
|-
|InternalVer=124
!style="background:#ffdead;"|Author
|Name=Pluggy
|style="background:#ffeded;"|[http://www.bethsoft.com/bgsforums/index.php?showuser=410736 Elys]
|Author=[http://www.bethsoft.com/bgsforums/index.php?showuser=410736 Elys], [http://www.bethsoft.com/bgsforums/index.php?showuser=299036 haama], Leandro Conde
|-
|Description=
!style="background:#ffdead;"|Description
|style="background:#ffeded;"|
Pluggy is a multifunction plugin for OBSE.  Its main features include:
Pluggy is a multifunction plugin for OBSE.  Its main features include:
*Single-dimension array support
*Single-dimension array support
Line 14: Line 12:
*The ability to save strings to text files
*The ability to save strings to text files
*True INI file support, both reading and writing values
*True INI file support, both reading and writing values
|-
*Hud creation (>= v101), both surface/image and text HUDs
!style="background:#ffdead;"|Installation
|Install=
|style="background:#ffeded;"|
#Browse to the folder Oblivion\Data\obse\plugins
*'''Automated Install:'''
#Extract the contents of the downloaded zip into that folder
*#Simply run the downloaded .msi file
|Download=[http://tesnexus.com/downloads/file.php?id=23979 TESNexus]
*'''Manual Install:'''
|Source=[http://tesnexus.com/downloads/file.php?id=23979 TESNexus]
*#Browse to the folder Oblivion\Data\obse\plugins
|Discussions=
*#Extract the contents of the downloaded zip into that folder
*[http://www.bethsoft.com/bgsforums/index.php?showtopic=853089 <nowiki>[WIP/BETA]</nowiki> Pluggy #5]
|-
*[http://www.bethsoft.com/bgsforums/index.php?showtopic=873139 <nowiki>[WIP/BETA]</nowiki> Pluggy #6]
!style="background:#ffdead;"|Download
*[http://www.bethsoft.com/bgsforums/index.php?showtopic=930549 Pluggy v122 Crash - A Report, An attempt to gain Elys' attention...]
|style="background:#ffeded;"|http://karamail.nerim.net/elys/Pluggy
*[http://www.bethsoft.com/bgsforums/index.php?showtopic=955774 Pluggy-related Crashes]
|-
*[http://www.bethsoft.com/bgsforums/index.php?showtopic=978991 <nowiki>[Relz/eWIP]</nowiki> Pluggy #7]
!style="background:#ffdead;"|Bethedsa Forums Discussions
|OBSEname=OBSE_Elys_Pluggy
|style="background:#ffeded;"|
}}
*[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]
|-
!style="background:#ffdead;"|Name and Current Version for [[IsPluginInstalled]]/[[GetPluginVersion]] check
|style="background:#ffeded;"|OBSE_Elys_Pluggy
56
|}


==Introduction==
==Introduction==
Line 47: Line 37:
*A .pluggy file is created whenever the game is saved and there are arrays/strings in use.
*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".
*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.
*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 Usage==
Line 58: Line 48:
==Notes==
==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.
*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.


 
[[Category: Functions|Z]]
[[Category: OBSE Plug-Ins]]
[[Category: Functions]]
[[Category: Functions (OBSE)]]
[[Category: Functions (OBSE)]]

Latest revision as of 19:15, 23 April 2009



Pluggy
Author(s)

Elys, haama, Leandro Conde

Current Version Beta 124 (GetPluginVersion returns 124)
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), both surface/image and text HUDs
Installation
  1. Browse to the folder Oblivion\Data\obse\plugins
  2. Extract the contents of the downloaded zip into that folder
Download

TESNexus

Source Code

TESNexus

Discussions
OBSE Name "OBSE_Elys_Pluggy"

(for use with IsPluginInstalled/GetPluginVersion)


Introduction[edit | edit source]

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

Data Storage[edit | edit source]

  • 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[edit | edit source]

  • 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[edit | edit source]

  • 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[edit | edit source]

  • 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