Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Multi-Lock : multiple locks on single object

Author

gaoneng

Submitted / Updated

02-15-2005 / 11-22-2006

Category

Placeable Item

Expansions

Requires Both Expansions (SoU & HotU)

View Code

=====================================
MULTI-LOCK
=====================================
gaoneng             February 15, 2005

This is a simple multi-lock system that will work on any lockable
objects, namely doors and placeables. Players will need to find a
number of keys, pick the lock a couple of times or cast Knock
repeatedly to fully unlock the multi-locked objects.


========
CONTENTS
========

  [i] Installation
 [ii] The Blueprints
[iii] The Scripts
 [iv] The Local Variables
  [v] Miscellaneous


============
INSTALLATION
============

To view the demonstration module, place the file "DEMO - Multi-
Lock.mod" into your modules folder. The demonstration module requires
both expansion packs and patch update v1.65 to function.

To use the Multi-Lock system, place the file "gao_multilock.erf" into
your erf folder. Open an existing module or create a new one and
import all scripts and blueprints in the erf file into your module.
The scripts should now appear under your left-hand script collapse 
and the Generic Multi-Lock Door and the Generic Multi-Lock Placeable
under Special Custom 1 in your respective custom palettes. This 
system should work as long as your toolset allows for the preseting
of local variables - I believe this feature was added in Shadow of 
Undrentide. You should also be able to use the system without this
feature if you set the "locks" local integer in-game.


==============
THE BLUEPRINTS
==============

Two generic blueprints are included. One for door and for placeable.
You can change their appearance, tag, resref, lock/plot, key (doors
only), everything else, and use them just like any normal objects, as
long as the script set remains intact.

So, for example, you can have a door that requires the player to find
six instances of a particular key before it gets unlocked. Neat eh?
This multi-key feature will only work on doors. There is no direct
way to control the state of placeable objects, and indirect ways are
often ugly.


===========
THE SCRIPTS
===========

There are four scripts involved in this system.

"pl_multilock_lk"
this signals the OnLock user defined event

"pl_multilock_sc"
this signals the OnSpellCastAt user defined event if the spell id is
SPELL_KNOCK

"pl_multilock_ulk"
this signals the OnUnLock user defined event

"pl_multilock_ude"
this is the main script behind this system. OnLock, the object will
automatically be relocked to the maximum number of locks as defined
by the initial value of the "locks" integer variable. OnSpellCastAt
and OnUnLock, the object will automatically be relocked until all
locks are unlocked

You can safely add your own events to these scripts as long as the
event numbers and signal event lines are not altered.


===================
THE LOCAL VARIABLES
===================

In the object with the multi-lock, you will find a local integer
variable "locks". This variable has default value of 2, which means
the player will need to pick the lock or cast Knock twice to fully
unlock the object. You can change this number to any other value to
correspond with the number of locks you want.

Additionally, a local integer "maxLOCKS" will be prescribed the first
time a signal event fires to record the maximum number of locks on
the object. You can change this value in-game to change the maximum
number of locks to different values. So for example, you can set it
such that a level 2 rogue's relock will only set "locks" to 2 but a
level 20 rogue's relock will set "locks" to 20!

If you want an object to have, say, maximum 8 locks, but only want it
to be locked 4 times initially, you can preset the variables "locks"
as 4 and "maxLOCKS" as 8 in the toolset or in-game to achieve this.


=============
MISCELLANEOUS
=============

[Acknowledgement]
Lexicon http://www.nwnlexicon.com/
Metapad http://liquidninja.com/metapad/

[Contact]
Try not to email me unless really necessary. Any feedback can be
posted on the message board or be PM'ed to me.

Bioware's forum username : gaoneng
electronic mail : gaoneng [at] yahoo [dot] com

If you like this system and use it your project, please give credit
and feel free to post a link of your finished product. I am not much
of a builder, and I certainly would enjoy seeing these little scripts
of mine in real action somewhere.


"gaoneng" Erick

Select All Text | View Code in separate window

Format

Module and Code

Type

Type - Other (Subtype - Other)

Includes

BioWare Standard

Description

I did a search and am surprised that this hasn't been done yet.

This is a simple multi-lock system that will work on any lockable objects, namely doors and placeables. Players will need to find a number of keys, pick the lock a couple of times or cast Knock repeatedly to fully unlock a multi-locked object.

View attached readme for details.

Files

Name	Type	Size	Downloads
MultiLockv1.00.zipMultiLockv1.00.zip Submitted: 02-15-2005 / Last Updated: 02-15-2005	zip	19.94Kb	335
--

SCORE OUT OF 10

9.5
1 votes
View Stats
Cast Your Vote!

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (3):

Posted by Narph at 2007-12-14 01:13:10 Voted 9.50 on 12/14/07

Good Idea 9
Title & Description on vault 9
Instructions 9
Easy to use 10
Demo Mod 10
No errors 10
Useful 9

66 of 70 possible points equals a average of 9.42

Very Complete Glad you took the time to make it and post.
The only thin I might change is how knock the spell works.
I think it should be able to do more then one lock per door.

Posted by fatalerr0r(newbie scripter) ( 168.184.xxx.xxx ) at 2005-02-25 07:23:00

im making a module that has the most powerful legendary weapon in a temple behind a door thats locked by 6 seals and i have been looking for a multi-lock script like this

Posted by ZeornWarlock at 2005-02-21 16:07:00

Sounds nice,

I may have a use for these scripts in the near future!

Thanks for sharring.

ZW.
_________________________
Retired from module building.

You must be Logged In to post comments in this section.