https://wiki.sinfar.net/api.php?action=feedcontributions&feedformat=atom&user=LockOnSinfar - User contributions [en]2026-04-09T01:00:54ZUser contributionsMediaWiki 1.40.1https://wiki.sinfar.net/index.php?title=House_Scripts&diff=1095House Scripts2025-12-03T20:54:00Z<p>LockOn: </p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== Tags ==<br />
<br />
=== home_tag ===<br />
{| class="wikitable"<br />
|+Set tags<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set a Placeables Tag<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
| Placeables<br />
| OnHeartbeat<br />
| TAG:String<br />
|-<br />
! colspan="4" |Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:string GetHomeSafeTag(string sOriginalTag); string GetHomeTagByID(string sOriginalTag, int nHomeID)<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevate and Rotate ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
=== g_plc_used_turn ===<br />
{| class="wikitable"<br />
|+Force turn a placeable<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
| Placeable<br />
| OnUsed<br />
| G_TURN_BACK_DELAY : Integer<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
=== bi_p_cbar_hb ===<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
=== g_onclickexamine ===<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
=== bi_p_force_emote ===<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
=== hs_hb_makenboard ===<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
== Shackle Scripts ==<br />
<br />
=== shckle_p_ondeath ===<br />
{| class="wikitable"<br />
|+Bashable shackes<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| The script to allow a PC to bash free of the shackles .<br />
| Placeables<br />
| OnDeath<br />
| NA<br />
|}<br />
<br />
=== shckle_p_talk ===<br />
{| class="wikitable"<br />
|+Bashable shackes<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Trigger for shackle placeables.<br />
| Trigger<br />
| NA<br />
| NA<br />
|}<br />
<br />
=== yasm_shackle ===<br />
{| class="wikitable"<br />
|+Full shackle system<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
| Placeables<br />
| OnHeartbeat<br />
| CHAIN_LENGTH: Float<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
Misc: Set PLC's Key to Owner's Key<br />
|}<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : StringScript: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
Script: hs_use_wc_video<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1094House Scripts2025-12-03T20:48:29Z<p>LockOn: </p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== Tags ==<br />
<br />
=== home_tag ===<br />
{| class="wikitable"<br />
|+Set tags<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set a Placeables Tag<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
| Placeables<br />
| OnHeartbeat<br />
| TAG:String<br />
|-<br />
! colspan="4" |Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:string GetHomeSafeTag(string sOriginalTag); string GetHomeTagByID(string sOriginalTag, int nHomeID)<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevate and Rotate ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
=== g_plc_used_turn ===<br />
{| class="wikitable"<br />
|+Force turn a placeable<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
| Placeable<br />
| OnUsed<br />
| G_TURN_BACK_DELAY : Integer<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
=== bi_p_cbar_hb ===<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
=== g_onclickexamine ===<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
=== bi_p_force_emote ===<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
=== hs_hb_makenboard ===<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
<br />
<br />
<br />
== Shackle Scripts ==<br />
<br />
=== shckle_p_ondeath ===<br />
{| class="wikitable"<br />
|+Bashable shackes<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| The script to allow a PC to bash free of the shackles .<br />
| Placeables<br />
| OnDeath<br />
| NA<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== shckle_p_talk ===<br />
{| class="wikitable"<br />
|+Bashable shackes<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Trigger for shackle placeables.<br />
| Trigger<br />
| NA<br />
| NA<br />
|}<br />
<br />
<br />
<br />
<br />
<br />
Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1093House Scripts2025-12-03T20:40:00Z<p>LockOn: </p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== Tags ==<br />
<br />
=== home_tag ===<br />
{| class="wikitable"<br />
|+Set tags<br />
|}<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set a Placeables Tag<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
| Placeables<br />
| OnHeartbeat<br />
| TAG:String<br />
|-<br />
! colspan="4" |Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:string GetHomeSafeTag(string sOriginalTag); string GetHomeTagByID(string sOriginalTag, int nHomeID)<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevate and Rotate ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
=== g_plc_used_turn ===<br />
{| class="wikitable"<br />
|+Force turn a placeable<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
| Placeable<br />
| OnUsed<br />
| G_TURN_BACK_DELAY : Integer<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
=== bi_p_cbar_hb ===<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
=== g_onclickexamine ===<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
=== bi_p_force_emote ===<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
=== hs_hb_makenboard ===<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
<br />
<br />
<br />
<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
<br />
<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . <br />
<br />
<br />
Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1092House Scripts2025-12-03T20:17:04Z<p>LockOn: </p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevate and Rotate ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
=== g_plc_used_turn ===<br />
{| class="wikitable"<br />
|+Force turn a placeable<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
| Placeable<br />
| OnUsed<br />
| G_TURN_BACK_DELAY : Integer<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
=== bi_p_cbar_hb ===<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
=== g_onclickexamine ===<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
=== bi_p_force_emote ===<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
=== hs_hb_makenboard ===<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
<br />
<br />
<br />
<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . <br />
<br />
<br />
Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1091House Scripts2025-12-03T19:55:31Z<p>LockOn: </p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevate and Rotate ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+Elevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
=== g_plc_used_turn ===<br />
Force <br />
<br />
Force <br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
| Placeable<br />
| OnUsed<br />
| G_TURN_BACK_DELAY : Integer<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
=== bi_p_cbar_hb ===<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
=== g_onclickexamine ===<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
=== bi_p_force_emote ===<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
=== hs_hb_makenboard ===<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
<br />
<br />
<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . <br />
<br />
<br />
Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1090House Scripts2025-12-03T18:52:06Z<p>LockOn: </p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
=== bi_p_cbar_hb ===<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
=== g_onclickexamine ===<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
=== bi_p_force_emote ===<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
=== hs_hb_makenboard ===<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . <br />
<br />
<br />
Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1089House Scripts2025-12-03T17:42:18Z<p>LockOn: spacing these out to fix for later.</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== hs_tipjar ==<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . <br />
<br />
<br />
Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
Script: hs_use_wc_image<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
Script: hs_use_wc_sound<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1088House Scripts2025-12-03T17:36:19Z<p>LockOn: Moving around some of the scripts that were not labeled properly and have just been cut and pasted into the end of this page.</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_npc ===<br />
{| class="wikitable"<br />
|+Tailor Models<br />
|}<br />
<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
| Placeables<br />
| OnHeartbeat<br />
| HS_SPAWN_NPC_ID<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== hs_tipjar ==<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
Script: Placeable Heartbeat = hs_store_xferspw<br />
<br />
All items put in the inventory of this placeable will be moved to the store identified by the variable HS_STORE_TAG.<br />
<br />
Variable: HS_STORE_TAG : String<br />
<br />
Script: Placeable Heartbeat = hs_store_spawn<br />
<br />
Turn a useable placeable into a merchant NPC. The merchant will open a store identified by the variable HS_STORE_TAG (10 characters max). You can fill that store with the hs_store_xferspw script.<br />
<br />
You can control the cost if the items with the following variables:<br />
<br />
HS_STORE_BONUS_MARK_UP:<br />
<br />
is added to the stores default mark up percentage on items sold (-100 to 100)<br />
<br />
HS_STORE_BONUS_MARK_DOWN:<br />
<br />
added to the stores default mark down percentage on items bought (-100 to 100)<br />
<br />
You can set the properties of the NPC with the following variables:<br />
<br />
HS_STORE_MERCHANT_GENDER:<br />
<br />
1 for female, 0 for male<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE:<br />
<br />
Use the body model to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_HEADV2:<br />
<br />
Use the body model, new heads section, to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE:<br />
<br />
Use the tailoring model to get the value of this variable<br />
<br />
HS_SPAWN_VFX_0 - HS_SPAWN_VFX_5:<br />
<br />
Visual effects (horns, eyes, hat…), from the visualeffects.2da file.<br />
<br />
You can control what the NPC say with the following variables:<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND: Sound resref to play when the dialog start.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION: Animation to play when the dialog start. Use the !EINFO command to find out the value of this variable.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT<br />
<br />
Notes: - You can use the web client to copy the values spoken by the body or tailoring models. - You can't get the gold of your sales. This is a non-profit script. If you want to get gold from you items, you have to sell them yourself.<br />
<br />
HS_SPAWN_VFX_0 : Integer<br />
<br />
HS_SPAWN_VFX_1 : Integer<br />
<br />
HS_SPAWN_VFX_2 : Integer<br />
<br />
HS_SPAWN_VFX_3 : Integer<br />
<br />
HS_SPAWN_VFX_4 : Integer<br />
<br />
HS_SPAWN_VFX_5 : Integer<br />
<br />
HS_STORE_BONUS_MARK_DOWN : Integer<br />
<br />
HS_STORE_BONUS_MARK_UP : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND : String<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT : String<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_GENDER : Integer<br />
<br />
HS_STORE_MERCHANT_HEADV2 : String<br />
<br />
HS_STORE_TAG : String<br />
Tailor NPCs<br />
<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=Dungeon_Running&diff=1025Dungeon Running2025-07-20T16:54:36Z<p>LockOn: Sub title change on the christenholme dungeon</p>
<hr />
<div>Dungeon running in Sinfar is a long-established and deep game-play experience on Sinfar. There are multiple dungeons with unique rewards available to dungeon runners who play through them.<br />
<br />
Below is a brief overview of the various dungeons available on the server.<br />
<br />
=== Shard Runs ===<br />
Shard Run dungeons are considered the premium dungeon experience in Sinfar. These dungeons require specific builds and tactics to be run efficiently and are considered the top tier dungeons on our Servers.<br />
{| class="wikitable"<br />
|+<br />
!Name<br />
!Abbreviation<br />
|-<br />
|Searing Chasm<br />
|SC<br />
|-<br />
|Heaven vs Hell<br />
|HvH<br />
|-<br />
|Crystal Archon Complex<br />
|CAC<br />
|-<br />
|Dark Matter Dimension<br />
|DMD<br />
|-<br />
|Path of Elements<br />
|PoE<br />
|-<br />
|The Witch's Menagerie<br />
|Witch<br />
|-<br />
|Bards Haunted Mansion<br />
|BHM<br />
|-<br />
|Corrupted Town<br />
|CT<br />
|}<br />
<br />
=== Non-Shard Runs ===<br />
{| class="wikitable"<br />
|+<br />
!Name<br />
!Abbreviation<br />
|-<br />
|Christenholme<br />
|None I know of?<br />
|}<br />
<br />
=== Crystal Key Fragments ===<br />
There are dungeons scattered on Main Server where you need to kill a set of 6 difference bosses which do drop Crystal Key Fragmets which can be used to open CAC or SC (But SC has also Glacier Keys so the Fragment Keys are used in 99% of time only for CAC).<br />
<br />
# The Lord of Terror can be found in the Icenfar cathedral deep in the forest, on the main floor of the cathedral near the pentagram. <br />
# The Blight can be found underneath the cathedral by circling around it and using the entrance in the back. <br />
# The Blighted King is in the burial grounds west of Icenfar town. Find a small hill with 2 opposing entrances, one of these is the entrance, the other the exit.<br />
# The Ice Drake is in a cave at the top of the Icenfar mountain. <br />
# The Frost Giant King is inside said mountain. Approach the mountain from the south, go east 1 map and head north to find the entrance cave near a spawn of feral bears. Inside the mountain, head straight till you find a cave entrance guarded by ice themed monsters. <br />
# The Ender of Fate can be found close to the dwarven kingdom inside the Icenfar mountain. In the town of Icenfar is a building guarded by a single NPC, enter and then enter the hole in the ground. Make your way through the long path and you'll approach the gates to the dwarven kingdom from the south, head west instead to find a dwarf riding a hog guarding a spiral way up to the Ender of Fate.<br />
<br />
==== Crystal Key Fragments can be also collected on Arche Terre ====<br />
<br />
# The Ender of Fate - North of Hivernales a chromatic dragon (Also drops Grimoar of Eldritch Secrets which is a Key to summon the Witch) <br />
# Ice King - A king of Yetis in Hivernales (Also drops Witch Staff which is a Key to summon the Witch) <br />
# Undead Mausoleum beneath Mur Cemetery <br />
# The Blight west of Aztika (Also drops Witches Hat which is a Key to summon the Witch) <br />
# The Lord of Terror - Beneath Hivernales Yeti tunnels (Also drops Witches Pipe which is a Key to summon the Witch) <br />
# Ice Dragon accessible from tunnel in Everneige - Belmorga Pass<br />
<br />
==== Path of Elements Book Locations ====<br />
The Compass key, which unlocks the PoE entrance, requires 3 different Books to create. <br />
<br />
# One book is found on the Devastation Spider in the spider caves of Forest of Eternity (main island). <br />
# The 2nd Book can be found on the lower level of Hamunaptra, the Saban pyramid (main island). <br />
# The 3rd Book can be found in the Yeti caves in Hivernales, in the hills (Arche Terre).<br />
<br />
=== Arche Terre's Tunnel System ===<br />
System with shared mechanics in terms of LEVEL SCALING as some of these dungeons will have creatures that differ in power and level so that you can enter as lv1 or even as lv40 they work as levelling roads too but yield a good loot and reveal some AT related drops etc... the party size will affect difficulty as well as more party members equals more enemies<br />
<br />
* House of Terror : Port Embria - Riverbend<br />
* Skinners : Embria Road - The River<br />
* Minotaurs : Smithy Volcano Mountain<br />
* Ant Tunnels : Deep Ancestral Pineforest Road<br />
* Ponies : Northern Road - Rocky Highlands<br />
* Troll Tunnels : West Road - South - Campsite<br />
* Cult of Leviathan : Pirate Airship Transport<br />
* Saltmarsh : Durakiss - Approach<br />
* Rogue's Challenge : West Road - South - Runoff<br />
* Pirate's Cove (Sambrune Road)<br />
<br />
=== Arche Terre's bonus dungeons ===<br />
<br />
<br />
(These are not part of the tunnel system afaik but obey the same rules as them) <br />
<br />
# Inquisition : Durakiss - North (There are Inqusitors spawns over on Arche around Blacklake and Durakiss if you ddefeat the lord inquisitor in Castle Justice you will make the roads safer for a week or so)<br />
# Surt the king of Ogres : Special dungeon you need a key from ogre elite then you can open a path in there thru a AT captain Anika • 5 Chromatic Dragons quest<blockquote>► Blue (Arid Stale Tunnel - Sambrune) <br />
<br />
► Red (Foul Smelling Cave - Mur Moutains) <br />
<br />
► Black (Putrid Bog Hole - Aztika) <br />
<br />
► Green (Noxious Meadow - West Roads) <br />
<br />
► White (Frigid Ice Cave - Hivernales)</blockquote><br />
<br />
# Spider Queen (Deep Ancestral Pineforest Road - There are Spiders spawns over on Arche around Deep Ancestral Pineforest if you defeat the Spider Queen in her lair you will make the roads safer for a week or so)<br />
# Necromancer Quest ( South East Coast - Elysium Track - very difficult dungeon with a single encounter if you collected dragon parts from previous quest)<br />
# Gnoll's Blood God (Sambrune Desert)<br />
# Rhemoraz (Mystic Cave - Hivernales)<br />
# Lizardfolk Camp (Sambrune Road)<br />
<br />
=== Arche Terre World Plot Dungeons ===<br />
Obeys same rules as tunnel system in terms of party size difficulty increment (needs special keys and unlike the others is part of the Arche Terre's world plot story) <br />
<br />
• Instarius : Blacklake Draal - Lake <br />
<br />
• The Vessle : Sambrune - Graves<br />
----<br />
<br />
=== '''Sinfar Dungeons''' ===<br />
<br />
===== Christenholme, the Decaying City =====<br />
The Dungeon of Christenholme is on the main Sinifer Server and it's connected to the Palace of Coins Casino which is found in the server hub's waterfront area, and it's systems are intimately tied into the gambling system found within. Compromised of four areas- Shalamoya, The Broken Harbor- Shalamoya, the Decaying City- Shalamoya: Crumbling Homes- and Shalamoya - Christenholme - The Church of Them. The players explore a city who has been overtaken by some strange slime and slowly uncover the state of the city as it collapsed under the weight of false worship, tyranny, and the plague which spread among them.<br />
<br />
The Dungeon sees spurts in development as new features are added and developed. The loot can either be sold for gold or donated for Casino Tokens to play the games at the Palace of Coins.<br />
<br />
Players can influence the direction and the hopes of the citizens of the Broken Harbor by contributing and communicating with the builder of the area, XCRs Bitch.</div>LockOnhttps://wiki.sinfar.net/index.php?title=Builder_List&diff=1021Builder List2025-07-19T19:26:51Z<p>LockOn: Builder List</p>
<hr />
<div>== Builder List by Island ==<br />
{| class="wikitable"<br />
|+<br />
!Island<br />
!Builder<br />
|-<br />
| colspan="2" |'''Sinfar Islands'''<br />
|-<br />
|Angellos Island<br />
|Hadikori<br />
|-<br />
|Cinder Isle<br />
|Zephyrys<br />
|-<br />
|Forest of Eternity<br />
|None<br />
|-<br />
|Leisure Isle<br />
|None<br />
|-<br />
|Lotus Isles<br />
|Hadikori<br />
|-<br />
|Middle of Nowhere<br />
|None<br />
|-<br />
|Sakura<br />
|Leikeze<br />
|-<br />
|Port Saban<br />
|Kezef<br />
|-<br />
|Darkmist<br />
|Violet, Fading<br />
|-<br />
|Shadebrook Village<br />
|Ghost Type<br />
|-<br />
|Sinfar Island<br />
|LockOn<br />
|-<br />
|Urskoy<br />
|Ghost Type<br />
|-<br />
|Wyrmtooth Island<br />
|Fallen Angel<br />
|-<br />
|Esus<br />
|Fallen Angel<br />
|-<br />
|Sinfar Isle - The Slums<br />
|XCR's Bitch<br />
|-<br />
|Lenny's Isle<br />
|ChittychittyBangbang<br />
|-<br />
|<br />
|<br />
|-<br />
| colspan="2" |'''Outer Isles'''<br />
|-<br />
|Aeon Empire<br />
|Carcerian<br />
|-<br />
|Aeon Nim<br />
|Atomic Blonde<br />
|-<br />
|Aglon<br />
|Eternal Serenity<br />
|-<br />
|Cat Ta Berry<br />
|She lonely<br />
|-<br />
|Celestial Anvil<br />
|None<br />
|-<br />
|Copa Tel Morilinde<br />
|None<br />
|-<br />
|Granas Falls<br />
|None<br />
|-<br />
|Aossi Isle<br />
|Busy_BZ_Bee<br />
|-<br />
|Icenfar<br />
|Badger<br />
|-<br />
|Kissmet<br />
|Road Apples<br />
|-<br />
|Lost World: Village of Psamathe<br />
|Road Apples<br />
|-<br />
|Moonvale<br />
|Fallen Angel<br />
|-<br />
|Radatonga<br />
|Carcerian<br />
|-<br />
|Ruins of Illswyn<br />
|Busy_BZ_Bee<br />
|-<br />
|Sandy Moore<br />
|Eternal Serenity<br />
|-<br />
|Maurnan V'dre<br />
|Carcerian<br />
|-<br />
|<br />
|<br />
|-<br />
|'''Arche Terre'''<br />
|'''Spankitty Overall'''<br />
|-<br />
|Che'El Oloth<br />
|<br />
|-<br />
|Competition Island<br />
|<br />
|-<br />
|Durakiss<br />
|<br />
|-<br />
|Elysium Port<br />
|<br />
|-<br />
|Hivernales<br />
|<br />
|-<br />
|Lomidar Village<br />
|<br />
|-<br />
|Lost Lands<br />
|<br />
|-<br />
|Mur County<br />
|<br />
|-<br />
|Mur Harbor<br />
|<br />
|-<br />
|Mur Village<br />
|<br />
|-<br />
|Port Embria<br />
|<br />
|-<br />
|Sambrune<br />
|Stranger<br />
|-<br />
|Tal En'Dae<br />
|<br />
|-<br />
|Tal'Malelee<br />
|<br />
|-<br />
|Whiteharbor<br />
|<br />
|-<br />
|<br />
|<br />
|-<br />
| colspan="2" |'''Dread Isles'''<br />
|-<br />
|Dungeon Island<br />
|ItsaBadger<br />
|-<br />
|Faerun<br />
|Carcerian<br />
|-<br />
|Kara tur<br />
|Hadikori<br />
|-<br />
|Isle of Dread<br />
|Xordac<br />
|-<br />
|Skull Island<br />
|Dynama/Stranger<br />
|}</div>LockOnhttps://wiki.sinfar.net/index.php?title=Main_Page&diff=1020Main Page2025-07-19T19:20:03Z<p>LockOn: Added the builder list</p>
<hr />
<div>==Welcome to the '''Sinfar Wiki'''==<br />
Here you will find information about the server, its various areas and systems, guides and introductions. This Wiki is made up of user-submitted articles, and you can make your own contributions. You will require a functioning [[Sinfar account]] to log in and you can help us organize how to do our styling and formatting. Be sure to join our [https://discord.gg/sinfar Discord] and check the [https://forum.sinfar.net/ Forums].<br />
<br />
When making new or editing existing articles, please respect that any article on here should be written in as an objective manner as possible, focusing on facts and information. If you write info about areas of the server, please avoid spoiling surprises and focus instead on general things and/or the area history. Articles may include specific characters who may hold prominent positions, but should not be a substitute for the in-game descriptions available on nwn.sinfar.net and in game. Please see [[Contributing]] for further details.<br />
<br />
<!--I'd like to add a search box here but I want it to look nice (see Star Citizen wiki for examples). Will need to add extensions.--><br />
<!--<span style="color:#955919> for the golden text colour</span>--><br />
----<br />
{| class="wikitable" style=" margin: auto;text-align: center;"<br />
!colspan="4"|'''<big><center>New to Sinfar or NWN? Look up the following guides to get started.</center></big>'''<br />
|-<br />
| [[About Sinfar]] || [[Getting Started]] || [[Recommended Settings]] || [[Solving Client or Connection Issues]]<br />
|-<br />
!colspan="6"|'''<center>Returning or just need the necessary downloads?</center>'''<br />
|-<br />
|colspan="3" style="text-align:center;"|Download for the Sinfar [[Hak Files]] ||colspan="3" style="text-align:center;"|Download for the [[Sinfar Client Extender (SinfarX)]]<br />
|-<br />
!colspan="6" style="text-align: center"|<br />
|}<br />
'''<big><center>Also be sure to read up on our [[Rules]]!</center></big>'''<br />
----<br />
You can find information for players, supporters and builders.<br />
{| class="wikitable"<br />
!'''For Players'''<br />
|<br />
{|<br />
|[[Character Customisation]]<br />
|[[Dungeon Running]]<br />
|[[Chat Commands]]<br />
|[[Magical Items]]<br />
|[[House Scripts]]<br />
|[[Player Housing]]<br />
|-<br />
|[[Class Changes]]<br />
|[[Feat Changes]]<br />
|[[Spell Changes]]<br />
|[[Chat Channels]]<br />
|[[Custom Emotes]]<br />
|[[Class Bonuses]]<br />
|}<br />
|-<br />
!'''For Suporters'''<br />
|<br />
{|<br />
|[[Custom Scripting]]<br />
|[[Your Resources]]<br />
|[[All Supporter Resources]]<br />
|}<br />
|-<br />
!'''For Builders'''<br />
|<br />
{|<br />
|[[Creature Event System]]<br />
|[[Registered Events]]<br />
|[[Variable Events]]<br />
|[[Builder List]]<br />
|}<br />
|-<br />
!'''For Scripters'''<br />
|<br />
{|<br />
|[[Common Includes]]<br />
|[[:Category:Systems|Scripting Systems]]<br />
|}<br />
|}<br />
----<br />
{| class="wikitable"<br />
|+<br />
! colspan="2" |The following categories are set up and should be set on relevant new pages. More categories can be applied.<br />
|-<br />
|[[:Category:Builder Contributions|Builder Contributions]]<br />
|For guides and instructions on your ERFs and contributions. Generally only useful for other builders. <br />
|-<br />
|[[:Category:Builders Tools|Builders Tools]]<br />
|Guides and instructions of various Sinfar tools specifically for builders.<br />
|-<br />
|[[:Category:Sinfar Supporters|Sinfar Supporters]]<br />
|Tools for Supporters to use primarily within their houses.<br />
|-<br />
|[[:Category:Player Businesses|Player Businesses]]<br />
|Lore articles for in-game establishments.<br />
|-<br />
|[[:Category:Builder Businesses|Builder Businesses]]<br />
|Instructions and details about businesses made by builders that exist outside player houses.<br />
|-<br />
|[[:Category:Player Tools|Player Tools]]<br />
|Various useful tools and pages for all players.<br />
|}<br />
__NOTOC__</div>LockOnhttps://wiki.sinfar.net/index.php?title=Dungeon_Running&diff=1019Dungeon Running2025-07-19T18:47:19Z<p>LockOn: Clean up</p>
<hr />
<div>Dungeon running in Sinfar is a long-established and deep game-play experience on Sinfar. There are multiple dungeons with unique rewards available to dungeon runners who play through them.<br />
<br />
Below is a brief overview of the various dungones available on the server.<br />
<br />
=== Shard Runs ===<br />
Shard Run dungeons are considered the premium dungeon experience in Sinfar. These dungeons require specific builds and tactics to be run efficiently and are considered the top tier dungeons on our Servers.<br />
{| class="wikitable"<br />
|+<br />
!Name<br />
!Abbreviation<br />
|-<br />
|Searing Chasm<br />
|SC<br />
|-<br />
|Heaven vs Hell<br />
|HvH<br />
|-<br />
|Crystal Archon Complex<br />
|CAC<br />
|-<br />
|Dark Matter Dimension<br />
|DMD<br />
|-<br />
|Path of Elements<br />
|PoE<br />
|-<br />
|The Witch's Menagerie<br />
|Witch<br />
|-<br />
|Bards Haunted Mansion<br />
|BHM<br />
|-<br />
|Corrupted Town<br />
|CT<br />
|}<br />
<br />
=== Crystal Key Fragments ===<br />
There are dungeons scattered on Main Server where you need to kill a set of 6 difference bosses which do drop Crystal Key Fragmets which can be used to open CAC or SC (But SC has also Glacier Keys so the Fragment Keys are used in 99% of time only for CAC).<br />
<br />
# The Lord of Terror can be found in the Icenfar cathedral deep in the forest, on the main floor of the cathedral near the pentagram. <br />
# The Blight can be found underneath the cathedral by circling around it and using the entrance in the back. <br />
# The Blighted King is in the burial grounds west of Icenfar town. Find a small hill with 2 opposing entrances, one of these is the entrance, the other the exit.<br />
# The Ice Drake is in a cave at the top of the Icenfar mountain. <br />
# The Frost Giant King is inside said mountain. Approach the mountain from the south, go east 1 map and head north to find the entrance cave near a spawn of feral bears. Inside the mountain, head straight till you find a cave entrance guarded by ice themed monsters. <br />
# The Ender of Fate can be found close to the dwarven kingdom inside the Icenfar mountain. In the town of Icenfar is a building guarded by a single NPC, enter and then enter the hole in the ground. Make your way through the long path and you'll approach the gates to the dwarven kingdom from the south, head west instead to find a dwarf riding a hog guarding a spiral way up to the Ender of Fate.<br />
<br />
==== Crystal Key Fragments can be also collected on Arche Terre ====<br />
<br />
# The Ender of Fate - North of Hivernales a chromatic dragon (Also drops Grimoar of Eldritch Secrets which is a Key to summon the Witch) <br />
# Ice King - A king of Yetis in Hivernales (Also drops Witch Staff which is a Key to summon the Witch) <br />
# Undead Mausoleum beneath Mur Cemetery <br />
# The Blight west of Aztika (Also drops Witches Hat which is a Key to summon the Witch) <br />
# The Lord of Terror - Beneath Hivernales Yeti tunnels (Also drops Witches Pipe which is a Key to summon the Witch) <br />
# Ice Dragon accessible from tunnel in Everneige - Belmorga Pass<br />
<br />
==== Path of Elements Book Locations ====<br />
The Compass key, which unlocks the PoE entrance, requires 3 different Books to create. <br />
<br />
# One book is found on the Devastation Spider in the spider caves of Forest of Eternity (main island). <br />
# The 2nd Book can be found on the lower level of Hamunaptra, the Saban pyramid (main island). <br />
# The 3rd Book can be found in the Yeti caves in Hivernales, in the hills (Arche Terre).<br />
<br />
=== Arche Terre's Tunnel System ===<br />
System with shared mechanics in terms of LEVEL SCALING as some of these dungeons will have creatures that differ in power and level so that you can enter as lv1 or even as lv40 they work as levelling roads too but yield a good loot and reveal some AT related drops etc... the party size will affect difficulty as well as more party members equals more enemies<br />
<br />
* House of Terror : Port Embria - Riverbend<br />
* Skinners : Embria Road - The River<br />
* Minotaurs : Smithy Volcano Mountain<br />
* Ant Tunnels : Deep Ancestral Pineforest Road<br />
* Ponies : Northern Road - Rocky Highlands<br />
* Troll Tunnels : West Road - South - Campsite<br />
* Cult of Leviathan : Pirate Airship Transport<br />
* Saltmarsh : Durakiss - Approach<br />
* Rogue's Challenge : West Road - South - Runoff<br />
* Pirate's Cove (Sambrune Road)<br />
<br />
=== Arche Terre's bonus dungeons ===<br />
<br />
<br />
(These are not part of the tunnel system afaik but obey the same rules as them) <br />
<br />
# Inquisition : Durakiss - North (There are Inqusitors spawns over on Arche around Blacklake and Durakiss if you ddefeat the lord inquisitor in Castle Justice you will make the roads safer for a week or so)<br />
# Surt the king of Ogres : Special dungeon you need a key from ogre elite then you can open a path in there thru a AT captain Anika • 5 Chromatic Dragons quest<blockquote>► Blue (Arid Stale Tunnel - Sambrune) <br />
<br />
► Red (Foul Smelling Cave - Mur Moutains) <br />
<br />
► Black (Putrid Bog Hole - Aztika) <br />
<br />
► Green (Noxious Meadow - West Roads) <br />
<br />
► White (Frigid Ice Cave - Hivernales)</blockquote><br />
<br />
# Spider Queen (Deep Ancestral Pineforest Road - There are Spiders spawns over on Arche around Deep Ancestral Pineforest if you defeat the Spider Queen in her lair you will make the roads safer for a week or so)<br />
# Necromancer Quest ( South East Coast - Elysium Track - very difficult dungeon with a single encounter if you collected dragon parts from previous quest)<br />
# Gnoll's Blood God (Sambrune Desert)<br />
# Rhemoraz (Mystic Cave - Hivernales)<br />
# Lizardfolk Camp (Sambrune Road)<br />
<br />
=== Arche Terre World Plot Dungeons ===<br />
Obeys same rules as tunnel system in terms of party size difficulty increment (needs special keys and unlike the others is part of the Arche Terre's world plot story) <br />
<br />
• Instarius : Blacklake Draal - Lake <br />
<br />
• The Vessle : Sambrune - Graves</div>LockOnhttps://wiki.sinfar.net/index.php?title=Dungeon_Running&diff=1018Dungeon Running2025-07-19T18:44:13Z<p>LockOn: Created our Dungeon Summary Page</p>
<hr />
<div>Dungeon running in Sinfar is a long-established and deep game-play experience on Sinfar. There are multiple dungeons with unique rewards available to dungeon runners who play through them.<br />
<br />
Below is a brief overview of the various dungones available on the server.<br />
<br />
=== Shard Runs ===<br />
Shard Run dungeons are considered the premium dungeon experience in Sinfar. These dungeons require specific builds and tactics to be run efficiently and are considered the top tier dungeons on our Servers.<br />
{| class="wikitable"<br />
|+<br />
!Name<br />
!Abbreviation<br />
|-<br />
|Searing Chasm<br />
|SC<br />
|-<br />
|Heaven vs Hell<br />
|HvH<br />
|-<br />
|Crystal Archon Complex<br />
|CAC<br />
|-<br />
|Dark Matter Dimension<br />
|DMD<br />
|-<br />
|Path of Elements<br />
|PoE<br />
|-<br />
|The Witch's Menagerie<br />
|Witch<br />
|-<br />
|Bards Haunted Mansion<br />
|BHM<br />
|-<br />
|Corrupted Town<br />
|CT<br />
|}<br />
<br />
=== Crystal Key Fragments ===<br />
There are dungeons scattered on Main Server where you need to kill a set of 6 difference bosses which do drop Crystal Key Fragmets which can be used to open CAC or SC (But SC has also Glacier Keys so the Fragment Keys are used in 99% of time only for CAC).<br />
<br />
# The Lord of Terror can be found in the Icenfar cathedral deep in the forest, on the main floor of the cathedral near the pentagram. <br />
# The Blight can be found underneath the cathedral by circling around it and using the entrance in the back. <br />
# The Blighted King is in the burial grounds west of Icenfar town. Find a small hill with 2 opposing entrances, one of these is the entrance, the other the exit.<br />
# The Ice Drake is in a cave at the top of the Icenfar mountain. <br />
# The Frost Giant King is inside said mountain. Approach the mountain from the south, go east 1 map and head north to find the entrance cave near a spawn of feral bears. Inside the mountain, head straight till you find a cave entrance guarded by ice themed monsters. <br />
# The Ender of Fate can be found close to the dwarven kingdom inside the Icenfar mountain. In the town of Icenfar is a building guarded by a single NPC, enter and then enter the hole in the ground. Make your way through the long path and you'll approach the gates to the dwarven kingdom from the south, head west instead to find a dwarf riding a hog guarding a spiral way up to the Ender of Fate.<br />
<br />
==== Crystal Key Fragments can be also collected on Arche Terre ====<br />
<br />
# The Ender of Fate - North of Hivernales a chromatic dragon (Also drops Grimoar of Eldritch Secrets which is a Key to summon the Witch) <br />
# Ice King - A king of Yetis in Hivernales (Also drops Witch Staff which is a Key to summon the Witch) <br />
# Undead Mausoleum beneath Mur Cemetery <br />
# The Blight west of Aztika (Also drops Witches Hat which is a Key to summon the Witch) <br />
# The Lord of Terror - Beneath Hivernales Yeti tunnels (Also drops Witches Pipe which is a Key to summon the Witch) <br />
# Ice Dragon accessible from tunnel in Everneige - Belmorga Pass<br />
<br />
==== Path of Elements Book Locations ====<br />
The Compass key, which unlocks the PoE entrance, requires 3 different Books to create. <br />
<br />
# One book is found on the Devastation Spider in the spider caves of Forest of Eternity (main island). <br />
# The 2nd Book can be found on the lower level of Hamunaptra, the Saban pyramid (main island). <br />
# The 3rd Book can be found in the Yeti caves in Hivernales, in the hills (Arche Terre).<br />
<br />
=== Arche Terre's Tunnel System ===<br />
System with shared mechanics in terms of LEVEL SCALING as some of these dungeons will have creatures that differ in power and level so that you can enter as lv1 or even as lv40 they work as levelling roads too but yield a good loot and reveal some AT related drops etc... the party size will affect difficulty as well as more party members equals more enemies<br />
<br />
• House of Terror : Port Embria - Riverbend <br />
<br />
• Skinners : Embria Road - The River <br />
<br />
• Minotaurs : Smithy Volcano Mountain <br />
<br />
• Ant Tunnels : Deep Ancestral Pineforest Road <br />
<br />
• Ponies : Northern Road - Rocky Highlands <br />
<br />
• Troll Tunnels : West Road - South - Campsite <br />
<br />
• Cult of Leviathan : Pirate Airship Transport <br />
<br />
• Saltmarsh : Durakiss - Approach <br />
<br />
• Rogue's Challenge : West Road - South - Runoff <br />
<br />
• Pirate's Cove (Sambrune Road)<br />
<br />
=== Arche Terre's bonus dungeons ===<br />
<br />
<br />
(These are not part of the tunnel system afaik but obey the same rules as them) <br />
<br />
• Inquisition : Durakiss - North (There are Inqusitors spawns over on Arche around Blacklake and Durakiss if you ddefeat the lord inquisitor in Castle Justice you will make the roads safer for a week or so) <br />
<br />
• Surt the king of Ogres : Special dungeon you need a key from ogre elite then you can open a path in there thru a AT captain Anika • 5 Chromatic Dragons quest<blockquote>► Blue (Arid Stale Tunnel - Sambrune) <br />
<br />
► Red (Foul Smelling Cave - Mur Moutains) <br />
<br />
► Black (Putrid Bog Hole - Aztika) <br />
<br />
► Green (Noxious Meadow - West Roads) <br />
<br />
► White (Frigid Ice Cave - Hivernales)</blockquote><br />
<br />
<br />
• Spider Queen (Deep Ancestral Pineforest Road - There are Spiders spawns over on Arche around Deep Ancestral Pineforest if you defeat the Spider Queen in her lair you will make the roads safer for a week or so) <br />
<br />
• Necromancer Quest ( South East Coast - Elysium Track - very difficult dungeon with a single encounter if you collected dragon parts from previous quest) <br />
<br />
• Gnoll's Blood God (Sambrune Desert) <br />
<br />
• Rhemoraz (Mystic Cave - Hivernales) <br />
<br />
• Lizardfolk Camp (Sambrune Road)<br />
<br />
=== Arche Terre World Plot Dungeons ===<br />
Obeys same rules as tunnel system in terms of party size difficulty increment (needs special keys and unlike the others is part of the Arche Terre's world plot story) <br />
<br />
• Instarius : Blacklake Draal - Lake <br />
<br />
• The Vessle : Sambrune - Graves</div>LockOnhttps://wiki.sinfar.net/index.php?title=Main_Page&diff=1017Main Page2025-07-19T18:28:02Z<p>LockOn: Trying to get the new page done.</p>
<hr />
<div>==Welcome to the '''Sinfar Wiki'''==<br />
Here you will find information about the server, its various areas and systems, guides and introductions. This Wiki is made up of user-submitted articles, and you can make your own contributions. You will require a functioning [[Sinfar account]] to log in and you can help us organize how to do our styling and formatting. Be sure to join our [https://discord.gg/sinfar Discord] and check the [https://forum.sinfar.net/ Forums].<br />
<br />
When making new or editing existing articles, please respect that any article on here should be written in as an objective manner as possible, focusing on facts and information. If you write info about areas of the server, please avoid spoiling surprises and focus instead on general things and/or the area history. Articles may include specific characters who may hold prominent positions, but should not be a substitute for the in-game descriptions available on nwn.sinfar.net and in game. Please see [[Contributing]] for further details.<br />
<br />
<!--I'd like to add a search box here but I want it to look nice (see Star Citizen wiki for examples). Will need to add extensions.--><br />
<!--<span style="color:#955919> for the golden text colour</span>--><br />
----<br />
{| class="wikitable" style=" margin: auto;text-align: center;"<br />
!colspan="4"|'''<big><center>New to Sinfar or NWN? Look up the following guides to get started.</center></big>'''<br />
|-<br />
| [[About Sinfar]] || [[Getting Started]] || [[Recommended Settings]] || [[Solving Client or Connection Issues]]<br />
|-<br />
!colspan="6"|'''<center>Returning or just need the necessary downloads?</center>'''<br />
|-<br />
|colspan="3" style="text-align:center;"|Download for the Sinfar [[Hak Files]] ||colspan="3" style="text-align:center;"|Download for the [[Sinfar Client Extender (SinfarX)]]<br />
|-<br />
!colspan="6" style="text-align: center"|<br />
|}<br />
'''<big><center>Also be sure to read up on our [[Rules]]!</center></big>'''<br />
----<br />
You can find information for players, supporters and builders.<br />
{| class="wikitable"<br />
!'''For Players'''<br />
|<br />
{|<br />
|[[Character Customisation]]<br />
|[[Dungeon Running]]<br />
|[[Chat Commands]]<br />
|[[Magical Items]]<br />
|[[House Scripts]]<br />
|[[Player Housing]]<br />
|-<br />
|[[Class Changes]]<br />
|[[Feat Changes]]<br />
|[[Spell Changes]]<br />
|[[Chat Channels]]<br />
|[[Custom Emotes]]<br />
|[[Class Bonuses]]<br />
|}<br />
|-<br />
!'''For Suporters'''<br />
|<br />
{|<br />
|[[Custom Scripting]]<br />
|[[Your Resources]]<br />
|[[All Supporter Resources]]<br />
|}<br />
|-<br />
!'''For Builders'''<br />
|<br />
{|<br />
|[[Creature Event System]]<br />
|[[Registered Events]]<br />
|[[Variable Events]]<br />
|}<br />
|-<br />
!'''For Scripters'''<br />
|<br />
{|<br />
|[[Common Includes]]<br />
|[[:Category:Systems|Scripting Systems]]<br />
|}<br />
|}<br />
----<br />
{| class="wikitable"<br />
|+<br />
! colspan="2" |The following categories are set up and should be set on relevant new pages. More categories can be applied.<br />
|-<br />
|[[:Category:Builder Contributions|Builder Contributions]]<br />
|For guides and instructions on your ERFs and contributions. Generally only useful for other builders. <br />
|-<br />
|[[:Category:Builders Tools|Builders Tools]]<br />
|Guides and instructions of various Sinfar tools specifically for builders.<br />
|-<br />
|[[:Category:Sinfar Supporters|Sinfar Supporters]]<br />
|Tools for Supporters to use primarily within their houses.<br />
|-<br />
|[[:Category:Player Businesses|Player Businesses]]<br />
|Lore articles for in-game establishments.<br />
|-<br />
|[[:Category:Builder Businesses|Builder Businesses]]<br />
|Instructions and details about businesses made by builders that exist outside player houses.<br />
|-<br />
|[[:Category:Player Tools|Player Tools]]<br />
|Various useful tools and pages for all players.<br />
|}<br />
__NOTOC__</div>LockOnhttps://wiki.sinfar.net/index.php?title=Main_Page&diff=1016Main Page2025-07-19T18:23:19Z<p>LockOn: Removed approval points. Going to replace it with Dungeon Running once the page is created.</p>
<hr />
<div>==Welcome to the '''Sinfar Wiki'''==<br />
Here you will find information about the server, its various areas and systems, guides and introductions. This Wiki is made up of user-submitted articles, and you can make your own contributions. You will require a functioning [[Sinfar account]] to log in and you can help us organize how to do our styling and formatting. Be sure to join our [https://discord.gg/sinfar Discord] and check the [https://forum.sinfar.net/ Forums].<br />
<br />
When making new or editing existing articles, please respect that any article on here should be written in as an objective manner as possible, focusing on facts and information. If you write info about areas of the server, please avoid spoiling surprises and focus instead on general things and/or the area history. Articles may include specific characters who may hold prominent positions, but should not be a substitute for the in-game descriptions available on nwn.sinfar.net and in game. Please see [[Contributing]] for further details.<br />
<br />
<!--I'd like to add a search box here but I want it to look nice (see Star Citizen wiki for examples). Will need to add extensions.--><br />
<!--<span style="color:#955919> for the golden text colour</span>--><br />
----<br />
{| class="wikitable" style=" margin: auto;text-align: center;"<br />
!colspan="4"|'''<big><center>New to Sinfar or NWN? Look up the following guides to get started.</center></big>'''<br />
|-<br />
| [[About Sinfar]] || [[Getting Started]] || [[Recommended Settings]] || [[Solving Client or Connection Issues]]<br />
|-<br />
!colspan="6"|'''<center>Returning or just need the necessary downloads?</center>'''<br />
|-<br />
|colspan="3" style="text-align:center;"|Download for the Sinfar [[Hak Files]] ||colspan="3" style="text-align:center;"|Download for the [[Sinfar Client Extender (SinfarX)]]<br />
|-<br />
!colspan="6" style="text-align: center"|<br />
|}<br />
'''<big><center>Also be sure to read up on our [[Rules]]!</center></big>'''<br />
----<br />
You can find information for players, supporters and builders.<br />
{| class="wikitable"<br />
!'''For Players'''<br />
|<br />
{|<br />
|[[Character Customisation]]<br />
|<br />
|[[Chat Commands]]<br />
|[[Magical Items]]<br />
|[[House Scripts]]<br />
|[[Player Housing]]<br />
|-<br />
|[[Class Changes]]<br />
|[[Feat Changes]]<br />
|[[Spell Changes]]<br />
|[[Chat Channels]]<br />
|[[Custom Emotes]]<br />
|[[Class Bonuses]]<br />
|}<br />
|-<br />
!'''For Suporters'''<br />
|<br />
{|<br />
|[[Custom Scripting]]<br />
|[[Your Resources]]<br />
|[[All Supporter Resources]]<br />
|}<br />
|-<br />
!'''For Builders'''<br />
|<br />
{|<br />
|[[Creature Event System]]<br />
|[[Registered Events]]<br />
|[[Variable Events]]<br />
|}<br />
|-<br />
!'''For Scripters'''<br />
|<br />
{|<br />
|[[Common Includes]]<br />
|[[:Category:Systems|Scripting Systems]]<br />
|}<br />
|}<br />
----<br />
{| class="wikitable"<br />
|+<br />
! colspan="2" |The following categories are set up and should be set on relevant new pages. More categories can be applied.<br />
|-<br />
|[[:Category:Builder Contributions|Builder Contributions]]<br />
|For guides and instructions on your ERFs and contributions. Generally only useful for other builders. <br />
|-<br />
|[[:Category:Builders Tools|Builders Tools]]<br />
|Guides and instructions of various Sinfar tools specifically for builders.<br />
|-<br />
|[[:Category:Sinfar Supporters|Sinfar Supporters]]<br />
|Tools for Supporters to use primarily within their houses.<br />
|-<br />
|[[:Category:Player Businesses|Player Businesses]]<br />
|Lore articles for in-game establishments.<br />
|-<br />
|[[:Category:Builder Businesses|Builder Businesses]]<br />
|Instructions and details about businesses made by builders that exist outside player houses.<br />
|-<br />
|[[:Category:Player Tools|Player Tools]]<br />
|Various useful tools and pages for all players.<br />
|}<br />
__NOTOC__</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1009House Scripts2025-06-15T21:30:28Z<p>LockOn: Minor edits to</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula.<br />
<br />
* price = item value * (x-1000) where x is the markup variable. (You can get the item value of any item by using the player tool on it.).<br />
<br />
However there is a hard cap of 10 million gold that can be collected in the chest at any one time. Any gold collected after the cap is hit will be lost. Price and monitor carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== hs_tipjar ==<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
Script: Placeable Heartbeat = hs_store_xferspw<br />
<br />
All items put in the inventory of this placeable will be moved to the store identified by the variable HS_STORE_TAG.<br />
<br />
Variable: HS_STORE_TAG : String<br />
<br />
Script: Placeable Heartbeat = hs_store_spawn<br />
<br />
Turn a useable placeable into a merchant NPC. The merchant will open a store identified by the variable HS_STORE_TAG (10 characters max). You can fill that store with the hs_store_xferspw script.<br />
<br />
You can control the cost if the items with the following variables:<br />
<br />
HS_STORE_BONUS_MARK_UP:<br />
<br />
is added to the stores default mark up percentage on items sold (-100 to 100)<br />
<br />
HS_STORE_BONUS_MARK_DOWN:<br />
<br />
added to the stores default mark down percentage on items bought (-100 to 100)<br />
<br />
You can set the properties of the NPC with the following variables:<br />
<br />
HS_STORE_MERCHANT_GENDER:<br />
<br />
1 for female, 0 for male<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE:<br />
<br />
Use the body model to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_HEADV2:<br />
<br />
Use the body model, new heads section, to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE:<br />
<br />
Use the tailoring model to get the value of this variable<br />
<br />
HS_SPAWN_VFX_0 - HS_SPAWN_VFX_5:<br />
<br />
Visual effects (horns, eyes, hat…), from the visualeffects.2da file.<br />
<br />
You can control what the NPC say with the following variables:<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND: Sound resref to play when the dialog start.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION: Animation to play when the dialog start. Use the !EINFO command to find out the value of this variable.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT<br />
<br />
Notes: - You can use the web client to copy the values spoken by the body or tailoring models. - You can't get the gold of your sales. This is a non-profit script. If you want to get gold from you items, you have to sell them yourself.<br />
<br />
HS_SPAWN_VFX_0 : Integer<br />
<br />
HS_SPAWN_VFX_1 : Integer<br />
<br />
HS_SPAWN_VFX_2 : Integer<br />
<br />
HS_SPAWN_VFX_3 : Integer<br />
<br />
HS_SPAWN_VFX_4 : Integer<br />
<br />
HS_SPAWN_VFX_5 : Integer<br />
<br />
HS_STORE_BONUS_MARK_DOWN : Integer<br />
<br />
HS_STORE_BONUS_MARK_UP : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND : String<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT : String<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_GENDER : Integer<br />
<br />
HS_STORE_MERCHANT_HEADV2 : String<br />
<br />
HS_STORE_TAG : String<br />
Tailor NPCs<br />
<br />
Script: Placeable Heartbeat = hs_spawn_npc<br />
<br />
Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
<br />
Variable: HS_SPAWN_NPC_ID : Integer<br />
Trash Cans<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1008House Scripts2025-06-15T20:52:56Z<p>LockOn: Moved hs_tipjar out of the npc section</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_ANIMATION:Integer</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_SOUND:String</code><br /><code>HS_STORE_DIALOG_NPC_WELCOME_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_NO_TEXT:String</code><br /><code>HS_STORE_DIALOG_PC_YES_TEXT:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code> (Can go from 0-5)<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula, however there is a hard cap of 1 million gold that can be collected on any item sold. The script will allow players to set a markup price over 1 million gold, and sell at that price. However, all gold spent on the sale past that limit, will be lost, and the store owner will only collect 1 million for the sale. Price carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== hs_tipjar ==<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
Script: Placeable Heartbeat = hs_store_xferspw<br />
<br />
All items put in the inventory of this placeable will be moved to the store identified by the variable HS_STORE_TAG.<br />
<br />
Variable: HS_STORE_TAG : String<br />
<br />
Script: Placeable Heartbeat = hs_store_spawn<br />
<br />
Turn a useable placeable into a merchant NPC. The merchant will open a store identified by the variable HS_STORE_TAG (10 characters max). You can fill that store with the hs_store_xferspw script.<br />
<br />
You can control the cost if the items with the following variables:<br />
<br />
HS_STORE_BONUS_MARK_UP:<br />
<br />
is added to the stores default mark up percentage on items sold (-100 to 100)<br />
<br />
HS_STORE_BONUS_MARK_DOWN:<br />
<br />
added to the stores default mark down percentage on items bought (-100 to 100)<br />
<br />
You can set the properties of the NPC with the following variables:<br />
<br />
HS_STORE_MERCHANT_GENDER:<br />
<br />
1 for female, 0 for male<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE:<br />
<br />
Use the body model to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_HEADV2:<br />
<br />
Use the body model, new heads section, to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE:<br />
<br />
Use the tailoring model to get the value of this variable<br />
<br />
HS_SPAWN_VFX_0 - HS_SPAWN_VFX_5:<br />
<br />
Visual effects (horns, eyes, hat…), from the visualeffects.2da file.<br />
<br />
You can control what the NPC say with the following variables:<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND: Sound resref to play when the dialog start.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION: Animation to play when the dialog start. Use the !EINFO command to find out the value of this variable.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT<br />
<br />
Notes: - You can use the web client to copy the values spoken by the body or tailoring models. - You can't get the gold of your sales. This is a non-profit script. If you want to get gold from you items, you have to sell them yourself.<br />
<br />
HS_SPAWN_VFX_0 : Integer<br />
<br />
HS_SPAWN_VFX_1 : Integer<br />
<br />
HS_SPAWN_VFX_2 : Integer<br />
<br />
HS_SPAWN_VFX_3 : Integer<br />
<br />
HS_SPAWN_VFX_4 : Integer<br />
<br />
HS_SPAWN_VFX_5 : Integer<br />
<br />
HS_STORE_BONUS_MARK_DOWN : Integer<br />
<br />
HS_STORE_BONUS_MARK_UP : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND : String<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT : String<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_GENDER : Integer<br />
<br />
HS_STORE_MERCHANT_HEADV2 : String<br />
<br />
HS_STORE_TAG : String<br />
Tailor NPCs<br />
<br />
Script: Placeable Heartbeat = hs_spawn_npc<br />
<br />
Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
<br />
Variable: HS_SPAWN_NPC_ID : Integer<br />
Trash Cans<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1005House Scripts2025-06-15T15:30:31Z<p>LockOn: Minor edits and language cleanups on the three new scripts added.</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the gold collected from the jar when they open it. All other uses will only see an empty box. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant. The toolset has a 1024 character limit per variable. If your appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate stores in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
<br />
Mark up and mark down prices on items function based on a standardized formula, however there is a hard cap of 1 million gold that can be collected on any item sold. The script will allow players to set a markup price over 1 million gold, and sell at that price. However, all gold spent on the sale past that limit, will be lost, and the store owner will only collect 1 million for the sale. Price carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work versus handing out free gold to any nosy person wandering in.<br />
<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
Script: Placeable Heartbeat = hs_store_xferspw<br />
<br />
All items put in the inventory of this placeable will be moved to the store identified by the variable HS_STORE_TAG.<br />
<br />
Variable: HS_STORE_TAG : String<br />
<br />
Script: Placeable Heartbeat = hs_store_spawn<br />
<br />
Turn a useable placeable into a merchant NPC. The merchant will open a store identified by the variable HS_STORE_TAG (10 characters max). You can fill that store with the hs_store_xferspw script.<br />
<br />
You can control the cost if the items with the following variables:<br />
<br />
HS_STORE_BONUS_MARK_UP:<br />
<br />
is added to the stores default mark up percentage on items sold (-100 to 100)<br />
<br />
HS_STORE_BONUS_MARK_DOWN:<br />
<br />
added to the stores default mark down percentage on items bought (-100 to 100)<br />
<br />
You can set the properties of the NPC with the following variables:<br />
<br />
HS_STORE_MERCHANT_GENDER:<br />
<br />
1 for female, 0 for male<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE:<br />
<br />
Use the body model to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_HEADV2:<br />
<br />
Use the body model, new heads section, to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE:<br />
<br />
Use the tailoring model to get the value of this variable<br />
<br />
HS_SPAWN_VFX_0 - HS_SPAWN_VFX_5:<br />
<br />
Visual effects (horns, eyes, hat…), from the visualeffects.2da file.<br />
<br />
You can control what the NPC say with the following variables:<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND: Sound resref to play when the dialog start.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION: Animation to play when the dialog start. Use the !EINFO command to find out the value of this variable.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT<br />
<br />
Notes: - You can use the web client to copy the values spoken by the body or tailoring models. - You can't get the gold of your sales. This is a non-profit script. If you want to get gold from you items, you have to sell them yourself.<br />
<br />
HS_SPAWN_VFX_0 : Integer<br />
<br />
HS_SPAWN_VFX_1 : Integer<br />
<br />
HS_SPAWN_VFX_2 : Integer<br />
<br />
HS_SPAWN_VFX_3 : Integer<br />
<br />
HS_SPAWN_VFX_4 : Integer<br />
<br />
HS_SPAWN_VFX_5 : Integer<br />
<br />
HS_STORE_BONUS_MARK_DOWN : Integer<br />
<br />
HS_STORE_BONUS_MARK_UP : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND : String<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT : String<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_GENDER : Integer<br />
<br />
HS_STORE_MERCHANT_HEADV2 : String<br />
<br />
HS_STORE_TAG : String<br />
Tailor NPCs<br />
<br />
Script: Placeable Heartbeat = hs_spawn_npc<br />
<br />
Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
<br />
Variable: HS_SPAWN_NPC_ID : Integer<br />
Trash Cans<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1004House Scripts2025-06-15T15:20:04Z<p>LockOn: Added hs_store_spawn and hs_store_xferspw to the list for player uses.</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
'''Obtaining tips'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The script hs_tipjar will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the contents of the jar when they open it themselves. All other uses will only see an empty box, suitable for placing gold. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
=== hs_store_spawn ===<br />
'''Merchant drones'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be used in conjunction with hs_store_xferspw. Will transform a usable placeable into a standard merchant with basic conversation options for facilitating sales of player made items to other players.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_MERCHANT_APPEARANCE2_PART1:String</code><br /><code>HS_STORE_MERCHANT_APPEARANCE2_PART2:String</code><br /><code>HS_STORE_TAG:String</code><br /><code>HS_STORE_BONUS_MARK_UP:Integer</code><br /><code>HS_STORE_BONUS_MARK_DOWN:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Appearance strings can be used to customize the appearance of the merchant, but remember the toolset has a 1024 character limit per variable. If you're appearance string is longer than 2048 characters, you'll need to make it less complex.<br />
Store tag is used to differentiate the store in the player home. Multiple stores with multiple tags are supported (for different vendors with different inventories).<br />
Mark up and mark down prices on items function based on a standardized formula, however there is a hard cap of 1 million gold that can be collected on any item sold. If your markup price is over that 1 million limit, all gold spent on the sale past that limit, will be lost. Price carefully.<br />
|}<br />
<br />
=== hs_store_xferspw ===<br />
'''Merchant drone inventory'''<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Must be set to Plot. Must be Useable. And must have invetory.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_STORE_TAG:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Once set, the container can be used to place inventory items into the store for sale to other players. Once placed, the items will disappear and only be available through the Merchant interface used by hs_store_spawn.<br />
Gold from all sales is collected when the player opens the chest. This is not security coded, so locking chests is recommended if you want to get paid for your work.<br />
Stacks of items placed in the chest will be sold as stacks. Individual items placed, are sold as single items. Ammo from ammo makers is not sellable, and will be discarded if placed in the chest.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
Script: Placeable Heartbeat = hs_store_xferspw<br />
<br />
All items put in the inventory of this placeable will be moved to the store identified by the variable HS_STORE_TAG.<br />
<br />
Variable: HS_STORE_TAG : String<br />
<br />
Script: Placeable Heartbeat = hs_store_spawn<br />
<br />
Turn a useable placeable into a merchant NPC. The merchant will open a store identified by the variable HS_STORE_TAG (10 characters max). You can fill that store with the hs_store_xferspw script.<br />
<br />
You can control the cost if the items with the following variables:<br />
<br />
HS_STORE_BONUS_MARK_UP:<br />
<br />
is added to the stores default mark up percentage on items sold (-100 to 100)<br />
<br />
HS_STORE_BONUS_MARK_DOWN:<br />
<br />
added to the stores default mark down percentage on items bought (-100 to 100)<br />
<br />
You can set the properties of the NPC with the following variables:<br />
<br />
HS_STORE_MERCHANT_GENDER:<br />
<br />
1 for female, 0 for male<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE:<br />
<br />
Use the body model to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_HEADV2:<br />
<br />
Use the body model, new heads section, to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE:<br />
<br />
Use the tailoring model to get the value of this variable<br />
<br />
HS_SPAWN_VFX_0 - HS_SPAWN_VFX_5:<br />
<br />
Visual effects (horns, eyes, hat…), from the visualeffects.2da file.<br />
<br />
You can control what the NPC say with the following variables:<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND: Sound resref to play when the dialog start.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION: Animation to play when the dialog start. Use the !EINFO command to find out the value of this variable.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT<br />
<br />
Notes: - You can use the web client to copy the values spoken by the body or tailoring models. - You can't get the gold of your sales. This is a non-profit script. If you want to get gold from you items, you have to sell them yourself.<br />
<br />
HS_SPAWN_VFX_0 : Integer<br />
<br />
HS_SPAWN_VFX_1 : Integer<br />
<br />
HS_SPAWN_VFX_2 : Integer<br />
<br />
HS_SPAWN_VFX_3 : Integer<br />
<br />
HS_SPAWN_VFX_4 : Integer<br />
<br />
HS_SPAWN_VFX_5 : Integer<br />
<br />
HS_STORE_BONUS_MARK_DOWN : Integer<br />
<br />
HS_STORE_BONUS_MARK_UP : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND : String<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT : String<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_GENDER : Integer<br />
<br />
HS_STORE_MERCHANT_HEADV2 : String<br />
<br />
HS_STORE_TAG : String<br />
Tailor NPCs<br />
<br />
Script: Placeable Heartbeat = hs_spawn_npc<br />
<br />
Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
<br />
Variable: HS_SPAWN_NPC_ID : Integer<br />
Trash Cans<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=House_Scripts&diff=1003House Scripts2025-06-15T14:57:20Z<p>LockOn: Added hs_tipjar to the NPC list</p>
<hr />
<div>The official reference is here: https://nwn.sinfar.net/houses_scriptlist.php, but you can find more information on how to use those scripts here.<br />
<!-- Table template:<br />
<br />
{| class="wikitable"<br />
|+Briefly the type of script<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| String description including forum link if relevant.<br />
| Object Type<br />
| OnWhichEvent<br />
| <code>FIRST VARIABLE</code><br /><code>SECOND VARIABLE</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Note text.<br />
|}<br />
<br />
--><br />
<br />
== Activate/Deactivate Placeables ==<br />
=== bi_activate ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Set on a useable placeable, this script will by default activate its animation if it has one - for example, if it's a lever or a button, it will be pulled or pushed respectively. Additionally, the variables will change the nature of the Placeable itself if BI_TARGET is not set - if BI_TARGET is a valid object, the object used will still play its animation but the other effects will play on the target. This can be used, for example, to activate a shower in a bathroom by moving the water spray placeable above or below the floor with the variable <code>BI_MOVEZ</code>.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5292<br />
| Placeables<br />
| OnUsed<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Target Placeables require the script <code>[[home_tag]]</code> in the OnHeartbeat event.<br />
<br />
<code>BI_ACTIVATE_NEAREST_SOUND_OBJECT</code> which will activate or deactivate (base on the the BI_SOUND_ON variable) the nearest sound object, in addition to the current object.<br />
<br />
This script will toggle the animation state of placeable objects and also the illumination status, if the placeable supports that. It also supports lots of other transformations that you may wish to perform on a placable or door.<br />
<br />
If the string variable BI_TARGET is not specified, the used object will be activated. Otherwise it will try to active the objects in the area with a matching tag. By default all tags inside player housing are removed so you will need to use the <code>home_tag</code> script to set a house safe tag on the placeable. Outside of housing it words on the normal NWN tagging system. In either case you may only activate things in the same area.<br />
<br />
In the event that its not possible to use the same tag for all of the targets, additional target tags can be specified by appending a number to the end of the variable name starting with 1, so the script will check for string BI_TARGET, string BI_TARGET1, string BI_TARGET2 and so on.<br />
<br />
The script also supports other transformations:<br />
<br />
Move the placeable between two locations, the alternate location is specified using one or more of the following float local variables:<br />
<br />
* <code>BI_FACE:Float</code><br />
* <code>BI_MOVEX:Float</code><br />
* <code>BI_MOVEY:Float</code><br />
* <code>BI_MOVEZ:Float</code><br />
<br />
A common use for this is to conceal a placeable under the floor then make it appear by setting BI_MOVEZ =0.0 , this works very well for showers.<br />
<br />
It is also possible to turn a placeable by a set amount using:<code>BI_TURN:Float</code><br />
<br />
Make the placeable play a sound:<code>BI_SOUND:String</code><br />
<br />
Add a VFX to the placeable - very useful for lighting:<code>BI_VFX:Integer</code><br />
<br />
Also if a beam VFX is required the source tag may be specified using:<code>BI_BEAM_SOURCE:String</code><br />
<br />
If one of the alternative transformations is specified the script will only perform the activation animation when BI_ACTIVATE (int) is set to 1. You can also tell the script that the object is already activated by setting <code>BI_ACTIVATED:Integer</code> to 1.<br />
<br />
Likewise if the object is a sound object you may tell the script that its on by setting <code>BI_SOUND_ON:Integer</code> to 1.<br />
<br />
The script can also be set to automatically toggle the state back after a set number of seconds:<code>BI_RESET:Float</code><br />
<br />
The default (idle) placeable animation is a problem for the script as it is unable to reliably toggle it into an alternate state. For most placeables the default is the deactivate animation so this is what the script will assume. If this is incorrect an explicit animation must be selected when placing the object. The script will then correctly toggle between either activate/deactivate or open/close.<br />
<br />
It may not be possible to use all of the features inside players homes, I suspect that tagging sound objects for example may be impossible. Doors are also re-tagged so it will not be possible to target them inside a home.<br />
|}<br />
<br />
=== bi_activate_trig ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Trigger<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Attaches itself to the closest trigger which will toggle when the first creature enters the trigger and then the last leaves. Otherwise it should be identical to bi_activate, except that the placeable need not be useble.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |See notes from bi_activate.<br />
|}<br />
<br />
=== bi_activate_osca ===<br />
{| class="wikitable"<br />
|+Activate/Deactivate Placeables via Spell<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A wrapper for bi_activate that triggers when a spell is cast at the placeable. A spell ID should be defined using BI_SPELLID, this will be compared against the spell ID held in the spell.2da file and the spell cast at the placeable.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>BI_SPELLID:Integer</code><br /><code>BI_ACTIVATE:Integer</code><br /><code>BI_ACTIVATED:Integer</code><br /><code>BI_ACTIVATE_NEAREST_SOUND_OBJECT:Integer</code><br /><code>BI_BEAM_SOURCE:String</code><br /><code>BI_FACE:Float</code><br /><code>BI_MOVEX:Float</code><br /><code>BI_MOVEY:Float</code><br /><code>BI_MOVEZ:Float</code><br /><code>BI_RESET:Float</code><br /><code>BI_SOUND:String</code><br /><code>BI_SOUND_OBJECT_TAG:String</code><br /><code>BI_SOUND_ON:Integer</code><br /><code>BI_TARGET:String</code><br /><code>BI_TARGET1:String</code><br /><code>BI_TARGET2:String</code><br /><code>BI_TURN:Float</code><br /><code>BI_VFX:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use a negative spell ID if you want the check to be disabled and use -2 if you want to to report the spell ID of the spell that its it.<br />
<br />
It's also important that you pick a spell that can affect the placeable and that the placeable is not plot, lots of hit points will help.<br />
<br />
See additional notes from bi_activate.<br />
<br />
The placeable cannot be flagged as Plot. It must be able to take damage for this to work.<br />
|}<br />
<br />
== NPCs ==<br />
=== hs_spawn_animnpc ===<br />
{| class="wikitable"<br />
|+Animated NPCs<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into an animated NPC. The NPC can be customized like the hs_store_spawn script.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?f=33&t=111<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_ANIMNPC_PHENOTYPE:Integer</code><br /><code>HS_ANIMNPC_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_ANIMATION_SPEED:Float</code><br /><code>HS_ANIMNPC_TALKTO_ANIMATION:Integer</code><br /><code>HS_ANIMNPC_TALKTO_SOUND:String</code><br /><code>HS_ANIMNPC_TALKTO_MESSAGE:String</code><br /><code>HS_ANIMNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_ANIMNPC_BODY_APPEARANCE:String</code><br /><code>HS_ANIMNPC_HEADV2:String</code><br /><code>HS_ANIMNPC_GENDER:Integer</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART1:String</code><br /><code>HS_ANIMNPC_APPEARANCE2_PART2:String</code><br /><code>HS_ANIMNPC_SCALE:Float</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Use !E INFO to get the PHENOTYPE and ANIMATION integers. ANIMATION_SPEED is relative to 1.0, with higher being faster and lower being slower.<br />
<br />
TALKTO variables include SOUND as a ResRef of a sound file, animation will fire once when the NPC is activated and the MESSAGE will be said in talk volume.<br />
<br />
If using APPEARANCE2 variables, do NOT use Armor, Body, Head or Gender variables. And similar - if you use any of those, do not use APPEARANCE2. APPEARANCE2 is acquired as a full string from a body or tailor model speaking the whole appearance rather than specific parts. Each PART can be max 1024 characters long. If your string exceeds that length, remove accessories/VFX.<br />
|}<br />
<br />
=== hs_spawn_deadnpc ===<br />
{| class="wikitable"<br />
|+Corpses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable into dead creature.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_DEADNPC_APPEARANCE2_PART1:String</code><br /><code>HS_DEADNPC_APPEARANCE2_PART2:String</code><br /><code>HS_DEADNPC_APPEARANCE_TYPE:Integer</code><br /><code>HS_DEADNPC_ARMOR_APPEARANCE:String</code><br /><code>HS_DEADNPC_BODY_APPEARANCE:String</code><br /><code>HS_DEADNPC_GENDER:Integer</code><br /><code>HS_DEADNPC_HEADV2:String</code><br /><code>HS_SPAWN_VFX_0:Integer</code><br /><code>HS_SPAWN_VFX_1:Integer</code><br /><code>HS_SPAWN_VFX_2:Integer</code><br /><code>HS_SPAWN_VFX_3:Integer</code><br /><code>HS_SPAWN_VFX_4:Integer</code><br /><code>HS_SPAWN_VFX_5:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |APPEARANCE2 variables are max 1024 characters each. If your string exceeds this, use PART2 as well. Acquired from body or tailor models. If your total string exceeds 2048 characters, remove some VFX/accessories.<br />
<br />
APPEARANCE_TYPE is the creature appearance index from the appearance.2da file. Use 6 for base human.<br />
|}<br />
<br />
=== hs_tipjar ===<br />
{| class="wikitable"<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a useable placeable with inventory into a tipjar, suitable for collecting gold.<br />
| Placeables<br />
| OnHeartbeat<br />
|<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The script hs_tipjar will turn any placeable with an inventory into a usable tip jar. Ownership is coded to the house owner and will only supply the owner with the contents of the jar when they open it themselves. All other uses will only see an empty box, suitable for placing gold. Note, the tip function works only on gold passed, not other items. It is not recommended to use it for anything other than gold.<br />
|}<br />
<br />
== Doors and Locking ==<br />
<br />
=== bi_create_bdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - to other player houses<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door or a placeable that can go to another house on the same island/in the same erf. For example, all of Sinfar counts as the same island, whereas cities on Arche Terre are their own - you cannot create a backdoor from Lomidar to Durakiss, but you can create one from Sinifer to Ackalia. Backdoors are one-way, and the opposite side has to be set up correctly for them to go both ways. This is intended to be used to go from one house to another, not to be used within the same house though it will work like that as well.<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>BACKDOOR_VFX:Integer</code><br /><code>KEY:String</code><br /><code>NAME:String</code><br /><code>TARGET:String</code><br /><code>NOKEY:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NAME:String</code> and <code>TARGET:String</code> have to match on each end - the NAME of one side matches the TARGET on the other side, and vice-versa.<br />
<br />
You cannot make a backdoor portal outside the ERF of your house - that's typically one island but may be one city depending on the server. Backdoors are generally not allowed on Dread Lands server, EXCEPT the Cottage Island.<br />
<br />
To ensure it works smoothly, be sure that your NAME and TAG variables are unique, always! They should not exceed 16 characters.<br />
<br />
If you do not wish a key, you must include the NOKEY:integer variable set to 1. You should not include NOKEY if you use a key.<br />
<br />
Backdoors can fail unless the target house has been loaded onto the server. The house area has to be entered at least once after a reset for that to happen. If it fails, simply navigate to the target house once manually.<br />
|}<br />
<br />
=== bi_create_ebdoor ===<br />
{| class="wikitable"<br />
|+Back Doors - from house interiors to server areas<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates a portal from a door (specifically a door) that can go to an area outside of the house, presumably in the adjacent area, but not required. <br />
The standard back door script bi_create_bdoor is not well suited for linking to external server side back doors. This is a simplified version that does not require coordination between the server and home builders.<br />
Forum discussion: https://forum.sinfar.net/viewtopic.php?f=64&t=12539<br />
| Doors, Placeables<br />
| OnHeartbeat<br />
| <code>NUMBER:Integer</code><br /><code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>NUMBER:Integer</code> is the number of the back door on the server side, usually 1. <code>G_CLOSE_DELAY:Integer</code> and <code>G_CLOSE_LOCK:Integer</code> work as for g_door_autoclose.<br />
<br />
'''Home Builders'''<br />
<br />
Inside player homes, bi_create_ebdoor will work perfectly without any local variables, just add it as the door's heartbeat script. If this does not work then your house does not have access to any external backdoors, you will need to put in a request for one to be added in the appropriate housing forum.<br />
<br />
If your house has access to more than one external back door then you may use the local integer variable named NUMBER to select the door of your choice. By default this will be 1 which will select the first back door.<br />
<br />
The script should copy over locking information to the external door from the one inside the house. If no lock information is set, it will alternatively copy over the lock information from the main house door. If you always want the back door unlocked, then set a key value but leave the locked check box empty.<br />
<br />
The script will also accept G_CLOSE_DELAY and G_CLOSE_LOCK and apply g_door_autoclose if G_CLOSE_DELAY is set.<br />
|}<br />
<br />
=== g_door_autoclose ===<br />
{| class="wikitable"<br />
|+Door auto-lose and lock<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Automatically closes and optionally locks a door after it's been opened<br />
| Doors<br />
| OnOpen<br />
| <code>G_CLOSE_DELAY:Integer</code><br /><code>G_CLOSE_LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |The door will automatically close after 15 seconds by default, or however many seconds set by <code>G_CLOSE_DELAY</code>. If <code>G_CLOSE_LOCK</code> is set to 1, it will also lock.<br />
|}<br />
<br />
=== g_door_locker ===<br />
{| class="wikitable"<br />
|+Lock switches<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lock or unlock the nearest door.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Add a key tag to the door to further restrict access, such as in bedrooms.<br />
|}<br />
<br />
== Chairs and Sitting ==<br />
=== g_bench_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== g_bench_rsit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates multiple seats on a bench when used, facing reverse direction.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Some placeables are reversed. If you use <code>g_bench_sit</code> and your character sits the wrong way, use this one instead.<br />
|}<br />
<br />
=== g_chair_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| For a single seat on a chair or similar.<br />
| Placeables<br />
| OnUsed<br />
| None<br />
|}<br />
<br />
=== bi_onclick_sit ===<br />
{| class="wikitable"<br />
|+Sit-able objects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| An alternative sit script supporting benches and the many chairs that do not work correctly with g_chair_sit.<br />
<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2809<br />
| Placeables<br />
| OnClick<br />
| <code>BI_DIRECTION:Float</code><br /><code>BI_PLACES:Integer</code><br /><code>BI_RADIUS:Float</code><br /><code>BI_WIDTH:Float</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br /><code>BI_DEBUG:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Unlike the existing sit scripts which are designed for OnUsed, it should be added as an OnClick script. The script will checks if it knows about the placeable and if there are any local variable parameters. If it knows what to do it will add one or more invisible sit points, correct the elevation of the placeable so that it will meet your characters bottom then remove itself. If I doesn't know what to do it will replace itself with the standard g_chair_sit script and hope for the best.<br />
<br />
In most cases the script should work without any local variables but the defaults that I have selected may not be exactly what you want. Most of the time you may as well just add the invisible sit point in the toolset but it you have many chairs or benches to place it may be worth the trouble to use the script and provide your own sit parameters.<br />
<br />
As the script only adds sit points on demand it will usually be more efficient than manually placed sit points, and while its more expensive than the bench scripts on its first run it should be cheaper when people use the bench afterwards. That said, its better to use g_chair_sit unless there is a problem with the chair.<br />
<br />
BI_RADIUS variable is for curved benches/seats. BI_PLACES is a count from 1-16 with how many seats should be for benches.<br />
|}<br />
<br />
== Elevations ==<br />
=== bi_p_elevate ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Apply the script and specify the elevation value on the placeable as a local variable float, then use the toolset to create a generic trigger area over or close to the placeable. Any creature entering the trigger area will then be elevated by the value supplied.<br />
|}<br />
<br />
=== bi_p_elevatestep ===<br />
{| class="wikitable"<br />
|+ELevation triggers<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Creates an elevated walkable area near or over a (non-static) placeable, with steps like a staircase.<br />
| Placeable<br />
| OnHeartbeat<br />
| <code>ELEVATION:Float</code><br /><code>STEP:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A test version of bi_p_elevate, to allow “steps” that have to be gone up in order, so that simulated upper and lower walkable areas are possible. Character will elevate on any trigger one step higher, even, or any lower numbered trigger. The triggers need to overlap slightly at the points players are to cross from one step to the next.<br />
<br />
The <code>STEP</code> variable should be incremented for each step, starting at 1.<br />
|}<br />
<br />
== Minimap Options ==<br />
=== hs_hb_showarea ===<br />
{| class="wikitable"<br />
|+Reveal the minimap to players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap revealed.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
=== hs_hb_hidearea ===<br />
{| class="wikitable"<br />
|+Hide the minimap for players.<br />
!Description !! Objects !! Event<br />
|-<br />
| Any player entering the same area as the placeable with this script will have their minimap hidden.<br />
| Placeables<br />
| OnHeartbeat<br />
|}<br />
<br />
== Lights, Music and Buttons ==<br />
=== lwjb_jukebox ===<br />
{| class="wikitable"<br />
|+Jukebox and Lights System<br />
!Description !! Objects !! Event<br />
|-<br />
| Starts Lil's Jukebox and Light Controller<br />
| Placeables<br />
| OnUsed<br />
|}<br />
<br />
=== bi_p_lightswitch ===<br />
{| class="wikitable"<br />
|+Lightswitch<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Create a placeable that can turn lights on or off.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>SWITCH:Integer</code><br /><code>LIGHT:Integer</code><br /><code>NAME:String</code><br /><code>ACTIVATE:Integer</code><br /><code>EFFECTS:Integer</code><br /><code>EFFECT_1:Integer</code><br /><code>EFFECT_2:Integer</code><br /><code>EFFECT_3:Integer</code><br /><code>EFFECT_4:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Requires two or more placeables - 1 lightswitch and any number of lights. <code>SWITCH(int)1</code> variable set on the switch itself and <code>LIGHT(int)1</code> set on the lights. Use the various EFFECT variables to set extra visual effects if desired. Use <code>ACTIVATE(int)1</code> if the switch should activate (such as with buttons or levers that are animated). The <code>NAME</code> must be the same for the switch and all lights it's meant to activate.<br />
<br />
For VFX, set up to 4 - use EFFECTS(int) to specify how many and EFFECT_# to specify the visual effect number.<br />
|}<br />
<br />
=== yasm_doorbell ===<br />
{| class="wikitable"<br />
|+Doorbells<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Lobby doorbell. Sends a message to other PCs in the house and/or keyholders.<br />
| Placeables<br />
| OnUsed<br />
| <code>ENABLE_SHOUT:Integer</code><br /><code>KEY_TAG:String</code><br /><code>MSG_TXT:String</code><br /><code>NAME_USER:Integer</code><br /><code>PLAY_SOUND:Integer</code><br />
|}<br />
<br />
=== g_playsound ===<br />
{| class="wikitable"<br />
|+Sound Effects<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Plays sound effects on used.<br />
| Placeables<br />
| OnUsed<br />
| <code>G_PLAYSOUND:String</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Plays the sound defined by the <code>G_PLAYSOUND</code> variable when the placeable is used.<br />
|}<br />
<br />
== bi_p_cbar_hb ==<br />
{| class="wikitable"<br />
|+Drinks Store<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Scripts that allows you to add a custom drinks bar to a house, it is fairly complex so the documentation is in a forum topic. See topic: http://sinfar.net/forum/viewtopic.php?t=4561<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>ITEM0:String</code><br /><code>...</code><br /><code>ITEM29:String</code><br /><code>LOCK:Integer</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A common request that get is to offer custom drinks for player house bars and breweries. Rather than forcing everyone to go though a builder I thought that it would be nice to offer a script that allows players to make their own drinks inside of housing areas.<br />
<br />
To use the script you will need to add a useable container, the plot flag must not be set. Then add bi_p_cbar_hb as the heartbeat script.<br />
<br />
The script will look for number string variables beginning with “ITEM” followed by a numeric suffix beginning at zero. ITEM0, ITEM1, ITEM2 and so on.<br />
<br />
The string value must begin with a type to identify the base item then some parameters.<br />
<br />
Currently the script only supports alcoholic drinks in potion bottles that are charged at 50 Gold a time when a bottle is removed from the container.<br />
<br />
The syntax for a potion bottles with the one use alcoholic effect is:<br />
<br />
PotionA:Name:Appearance:Description<br />
<br />
Where Appearance is defined as follows:<br />
<br />
ModelTop;ColorTop;ModelMiddle;ColorMiddle;ModelBottom;ColorBottom<br />
<br />
ModelTop=1-7<br />
<br />
ColorTop=1-9<br />
<br />
ModelMiddle=1-7<br />
<br />
ColorMiddle=1-9<br />
<br />
ModelBottom=1-24<br />
<br />
ColorBottom=1-9<br />
<br />
eg 1;2;1;2;1;2<br />
<br />
ITEM0 (string) PotionA:Whisky:1;1;1;1;1;1:A bottle of single malt whisky.<br />
<br />
If you wish the container to auto lock add LOCK (int) 1<br />
<br />
The script will automatically make the bar plot, so that you do not need to.<br />
<br />
Obviously, since you control the Name and Description you are also free to make a RP potions if you wish. The effect will still be alcohol however.<br />
|}<br />
<br />
== g_onclickexamine ==<br />
{| class="wikitable"<br />
|+Examine a placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Immediately examine/open the description of a Placeable when clicking on it.<br />
| Placeable<br />
| OnClick<br />
| None<br />
|}<br />
<br />
== bi_p_force_emote ==<br />
{| class="wikitable"<br />
|+Force Emote with a Placeable<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| A simpler shackle script with a few additional options.<br />
Forum discussion: http://sinfar.net/forum/viewtopic.php?t=2743<br />
| Placeables<br />
| OnUsed<br />
| <code>BI1_ANIM:Integer</code><br /><code>BI1_BODYPART:Integer</code><br /><code>BI1_DESC:String</code><br /><code>BI1_DIRECTION:Float</code><br /><code>BI1_DURATION:Float</code><br /><code>BI1_MSG:String</code><br /><code>BI1_PHENO:Integer</code><br /><code>BI1_SPEED:Float</code><br /><code>BI1_VFX:Integer</code><br /><code>BI1_X:Float</code><br /><code>BI1_Y:Float</code><br /><code>BI1_Z:Float</code><br /><code>BI2_ANIM:Integer</code><br /><code>BI2_BODYPART:Integer</code><br /><code>BI2_DESC:String</code><br /><code>BI2_DIRECTION:Float</code><br /><code>BI2_DURATION:Float</code><br /><code>BI2_MSG:String</code><br /><code>BI2_PHENO:Integer</code><br /><code>BI2_SPEED:Float</code><br /><code>BI2_VFX:Integer</code><br /><code>BI2_X:Float</code><br /><code>BI2_Y:Float</code><br /><code>BI2_Z:Float</code><br /><code>BI3_ANIM:Integer</code><br /><code>BI3_BODYPART:Integer</code><br /><code>BI3_DESC:String</code><br /><code>BI3_DIRECTION:Float</code><br /><code>BI3_DURATION:Float</code><br /><code>BI3_MSG:String</code><br /><code>BI3_PHENO:Integer</code><br /><code>BI3_SPEED:Float</code><br /><code>BI3_VFX:Integer</code><br /><code>BI3_X:Float</code><br /><code>BI3_Y:Float</code><br /><code>BI3_Z:Float</code><br /><code>BI_ANIM:Integer</code><br /><code>BI_BODYPART:Integer</code><br /><code>BI_DESC:String</code><br /><code>BI_DIRECTION:Float</code><br /><code>BI_DURATION:Float</code><br /><code>BI_FE_SET:Integer</code><br /><code>BI_KEY:String</code><br /><code>BI_MSG:String</code><br /><code>BI_PHENO:Integer</code><br /><code>BI_SHACKLE_MODE:Integer</code><br /><code>BI_SPEED:Float</code><br /><code>BI_VFX:Integer</code><br /><code>BI_X:Float</code><br /><code>BI_Y:Float</code><br /><code>BI_Z:Float</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |A shackle script supporting an extensive selection of placeeables and offering the option to customise the emotes. It can also be used without a lock to allow characters to kneel on pillows or perform other emotes relative to a placeable.<br />
|}<br />
<br />
== hs_hb_makenboard ==<br />
{| class="wikitable"<br />
|+Noticeboards<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Turn a usable placeable into a notice board.<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_NOTICE_BOARD_TAG_SUFFIX:String</code><br />
|-<br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |<code>HS_NOTICE_BOARD_TAG_SUFFIX</code> must be set to a unique tag of maximum 10, A-Z,0-9,_ characters.<br />
|}<br />
<br />
== Portals ==<br />
=== hs_portal_used ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a portal from one part of a house to another.<br />
| Placeables<br />
| OnUsed<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Sets up a portal that can be used to teleport inside a house. It will not allow going from one house to another. Requires <code>hs_spawn_portwp</code> to set up the destination. Use the variable <code>HS_PORTAL_TAG</code> to designate the location - this should match the variable on the object used with <code>hs_spawn_portwp</code>. It shouldn't have more than 10 characters. Set a custom VFX or delay from clicking with the other variables.<br />
|}<br />
<br />
=== hs_spawn_portwp ===<br />
{| class="wikitable"<br />
|+In-House Portals<br />
!Description !! Objects !! Event !! Variables<br />
|-<br />
| Sets up a waypoint used with hs_portal_used<br />
| Placeables<br />
| OnHeartbeat<br />
| <code>HS_PORTAL_TAG:String</code><br /><code>HS_PORTAL_VFX:Integer</code><br /><code>HS_PORTAL_DELAY:Float</code><br />
! colspan="4" |Notes<br />
|-<br />
| colspan="4" |Turn the usable placeable into a waypoint where another placeable can bring characters to with the script hs_portal_used. The variable name should match exactly the <code>HS_PORTAL_TAG</code> defined on the other placeable. It shouldn't have more than 10 characters.<br />
|}<br />
<br />
<br />
== Rotate Placable on Use ==<br />
<br />
Script: Placeable Used = g_plc_used_turn<br />
<br />
Turns the used placeable by 30 degree, or the number of degree defined by the G_TURN_DEGREE variable.<br />
<br />
When it turns, you can make it play a sound defined by the variable G_TURN_SOUND.<br />
<br />
The placeable will be turned back after 30 seconds, or by the number of second that you set in the G_TURN_BACK_DELAY variable.<br />
<br />
Variables:<br />
<br />
G_TURN_BACK_DELAY : Integer<br />
<br />
G_TURN_DEGREE : Integer<br />
<br />
G_TURN_SOUND : String<br />
Set a Placables Tag<br />
<br />
Script: Placeable Heartbeat = home_tag<br />
<br />
Adds a tag to the placeable so that the placeable may be accessed by other scripts.<br />
<br />
For security reasons Tags are usually removed or replaced when homes are uploaded, this script provides a safe tag for home builders to work with.<br />
<br />
Variable: TAG : String<br />
<br />
Server script builders should, #include “home_inc_tag” and use one of the following fucntions to get a matching tag:<br />
<br />
string GetHomeSafeTag(string sOriginalTag);<br />
<br />
string GetHomeTagByID(string sOriginalTag, int nHomeID);<br />
Shackles (Bashable)<br />
<br />
Script: Placeable Death = shckle_p_ondeath<br />
<br />
The script to allow a PC to bash free of the shackles . Script: Placeable Used = shckle_p_talk<br />
<br />
Trigger for shackle placeables.<br />
Slave Tether<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=1162<br />
<br />
Script: Placeable Heartbeat = yasm_shackle<br />
<br />
Variable: CHAIN_LENGTH : Float<br />
<br />
Misc: Set PLC's Key to Owner's Key<br />
<br />
This system chains the prisoner to a shackle, allowing them freedom to move and emote whilst secured, but they are trapped within the length of the chain. A tether.<br />
<br />
To deploy the system in your house build simply put down a suitable placeable object, set it as usable and give it yasm_shackle as its heartbeat script.<br />
<br />
Whether or not you set a lock key determines how securely the prisoner is chained. With no key set the prisoner is released by just click/using the shackle. If a lock key is set the player needs to have an item with the required tag to unlock the prisoner. Keys tags work in the same manner as for doors & containers.<br />
<br />
The length of the chain can be controlled by setting a local variable, CHAIN_LENGTH (float), but this is optional and if omitted will default to 2.0<br />
<br />
In game usage is very simple, the prisoner clicks the shackle and they are locked. Usage implies consent to the consequences. If the shackle has a lock then Unlock (rather than Use) to release the prisoner. Escaping is as simple as typing !ooc, and by the time you transition back with !ic the shackle will have reset itself.<br />
<br />
You will notice that the system uses a trap mechanism, unfortunately the game engine spews a little bit of spam as players move in and out of the area of an active shackle/trap, sorry but that cant be muted. Just ignore the background noise and have fun emoting with the prisoner.<br />
Stores<br />
<br />
Discussion: http://sinfar.net/forum/viewtopic.php?f=64&t=5374<br />
<br />
Script: Placeable Heartbeat = hs_store_xferspw<br />
<br />
All items put in the inventory of this placeable will be moved to the store identified by the variable HS_STORE_TAG.<br />
<br />
Variable: HS_STORE_TAG : String<br />
<br />
Script: Placeable Heartbeat = hs_store_spawn<br />
<br />
Turn a useable placeable into a merchant NPC. The merchant will open a store identified by the variable HS_STORE_TAG (10 characters max). You can fill that store with the hs_store_xferspw script.<br />
<br />
You can control the cost if the items with the following variables:<br />
<br />
HS_STORE_BONUS_MARK_UP:<br />
<br />
is added to the stores default mark up percentage on items sold (-100 to 100)<br />
<br />
HS_STORE_BONUS_MARK_DOWN:<br />
<br />
added to the stores default mark down percentage on items bought (-100 to 100)<br />
<br />
You can set the properties of the NPC with the following variables:<br />
<br />
HS_STORE_MERCHANT_GENDER:<br />
<br />
1 for female, 0 for male<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE:<br />
<br />
Use the body model to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_HEADV2:<br />
<br />
Use the body model, new heads section, to get the value of this variable<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE:<br />
<br />
Use the tailoring model to get the value of this variable<br />
<br />
HS_SPAWN_VFX_0 - HS_SPAWN_VFX_5:<br />
<br />
Visual effects (horns, eyes, hat…), from the visualeffects.2da file.<br />
<br />
You can control what the NPC say with the following variables:<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND: Sound resref to play when the dialog start.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION: Animation to play when the dialog start. Use the !EINFO command to find out the value of this variable.<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT<br />
<br />
Notes: - You can use the web client to copy the values spoken by the body or tailoring models. - You can't get the gold of your sales. This is a non-profit script. If you want to get gold from you items, you have to sell them yourself.<br />
<br />
HS_SPAWN_VFX_0 : Integer<br />
<br />
HS_SPAWN_VFX_1 : Integer<br />
<br />
HS_SPAWN_VFX_2 : Integer<br />
<br />
HS_SPAWN_VFX_3 : Integer<br />
<br />
HS_SPAWN_VFX_4 : Integer<br />
<br />
HS_SPAWN_VFX_5 : Integer<br />
<br />
HS_STORE_BONUS_MARK_DOWN : Integer<br />
<br />
HS_STORE_BONUS_MARK_UP : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_ANIMATION : Integer<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_SOUND : String<br />
<br />
HS_STORE_DIALOG_NPC_WELCOME_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_NO_TEXT : String<br />
<br />
HS_STORE_DIALOG_PC_YES_TEXT : String<br />
<br />
HS_STORE_MERCHANT_ARMOR_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_BODY_APPEARANCE : String<br />
<br />
HS_STORE_MERCHANT_GENDER : Integer<br />
<br />
HS_STORE_MERCHANT_HEADV2 : String<br />
<br />
HS_STORE_TAG : String<br />
Tailor NPCs<br />
<br />
Script: Placeable Heartbeat = hs_spawn_npc<br />
<br />
Replaces the placeable by a given NPC. The placeable must be set as useable. The NPC to spawn is determined by the HS_SPAWN_NPC_ID variable, it can take one of the following values:<br />
<br />
1 = Male Tailoring Model<br />
<br />
2 = Female Tailoring Model<br />
<br />
3 = Male Body Model<br />
<br />
4 = Female Body Model<br />
<br />
Variable: HS_SPAWN_NPC_ID : Integer<br />
Trash Cans<br />
<br />
Script: Placeable Close = pcplc_trash_cls<br />
<br />
If the placeable has the script “pcplc_trash_cls” in its OnClose event, then it will act as a trash and so its inventory will be cleaned when closed.<br />
<br />
Important Note: It is not advisable making garbage cans in areas with persistent storage, as item loss can occur when adding or removing persistent storage not properly tagged.<br />
Turn Placeables State On/Off on use (with Sound Effects)<br />
<br />
Script: Placeable Used = g_plc_onoff<br />
<br />
Turn on/off a placeable.<br />
<br />
G_PLC_IS_ON: Set this to 1 if the placeable is initially on/activated/open.<br />
<br />
G_PLC_TURN_ON_SOUND: Sound ResRef to play when the placeable is turn on.<br />
<br />
G_PLC_TURN_OFF_SOUND: Sound ResRef to play when the placeable is turn off.<br />
<br />
Variables:<br />
<br />
G_PLC_IS_ON : Integer<br />
<br />
G_PLC_TURN_OFF_SOUND : String<br />
<br />
G_PLC_TURN_ON_SOUND : String<br />
VFX Heartbeat (with On/Off switch)<br />
<br />
Script: Placeable Heartbeat = plcvfx_self<br />
<br />
You can add any number of visual effects on a non-static placeable.<br />
<br />
For that, you need to add the script “plcvfx_self” in the OnHeartbeat event of the placeable. Then, you need to add 1 variable for each visual effect that you want to see on this placeable.<br />
<br />
This variable must be set as follow:<br />
<br />
⦁ Type: Integer.<br />
<br />
⦁ Name: PLCVFX_SELF#, where # is the index of the visual effect. The first index is 1 so the first visual effect will have “PLCVFX_SELF1” as variable name.<br />
<br />
⦁ Value: It is the row index of the visual effect in the visualeffects 2da.<br />
<br />
(Note: If you only want to add the light visual effect on a placeable, then you just need to put the script “zep_torchspawn” in the OnHeartbeat event.)<br />
<br />
Each visual effect count as 1 dynamic object and so, a placeable with 1 visual effect count as 2 dynamic objects. If it has 3 visual effects, then it count as 4 dynamic objects.<br />
<br />
Variables: PLCVFX_SELF1, PLCVFX_SELF2, PLCVFX_SELF3, Etc…<br />
<br />
Script: Placeable Used = plcvfx_switchoff<br />
<br />
Turn off/on the visual effect applied by the plcvfx_self heartbeat script.<br />
VFX on Placeable use<br />
<br />
Script: Placeable Used = g_play_vfx<br />
<br />
Plays a permanent VFX on an object when used, will remove the VFX on a second use. Will also work for instant effects.<br />
<br />
Variable: G_PLAYVFX : Integer<br />
VFX and SFX on Placable use<br />
<br />
Script: Placeable Used = g_play_vfx_sound<br />
<br />
Play a sound and an -instant- visual effect (FNF) when the placeable is used.<br />
<br />
Variables:<br />
<br />
G_PLAYVFX: visual effect index to display.<br />
<br />
G_PLAYSOUND: sound resref to play.<br />
<br />
G_PLAYSOUND : String<br />
<br />
G_PLAYVFX : Integer<br />
Web Client Media Support<br />
<br />
When used a placeable sends an Image, Sound, or Video to web client.<br />
<br />
Script: Placeable Used = hs_use_wc_image<br />
<br />
Sends an image to the web client of the player using the placeable.<br />
<br />
Variable: HS_IMAGE_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Used = hs_use_wc_sound<br />
<br />
Sends a sound to the web client of the player using the placeable.<br />
<br />
Variable: HS_SOUND_URL : String<br />
<br />
Script: hs_use_wc_image<br />
<br />
Placeable Heartbeat = hs_hb_wc_music<br />
Web Client Music Loop.<br />
<br />
Variable: HS_MUSIC_URL : String<br />
<br />
Script: hs_use_wc_sound<br />
<br />
Placeable Used = hs_use_wc_video<br />
<br />
Sends a video to the web client of the player using the placeable.<br />
<br />
Variable: HS_VIDEO_URL : String<br />
<br />
Script: hs_use_wc_video<br />
<br />
Placeable Used = hs_use_wc_youtub<br />
<br />
Sends a you tube video to the web client of the player using the placeable.<br />
<br />
HS_YOUTUBE_ID is the string of your youtube page's URL past “?v=”<br />
<br />
(If your URL is http://www.youtube.com/watch?v=AMKYQZHfaf8 then your ID string = AMKYQZHfaf8)<br />
<br />
Variable: HS_YOUTUBE_ID : String</div>LockOnhttps://wiki.sinfar.net/index.php?title=Main_Page&diff=423Main Page2024-09-19T16:44:39Z<p>LockOn: </p>
<hr />
<div>==Welcome to the '''Sinfar Wiki'''==<br />
Here you will find information about the server, its various areas and systems, guides and introductions. This Wiki is made up of user-submitted articles, and you can make your own contributions. You will require a functioning [[Sinfar account]] to log in and you can help us organize how to do our styling and formatting. Be sure to join our [https://https//discord.gg/jVaNBmj Discord] and check the [https://forum.sinfar.net/ Forums].<br />
<br />
When making new or editing existing articles, please respect that any article on here should be written in as an objective manner as possible, focusing on facts and information. If you write info about areas of the server, please avoid spoiling surprises and focus instead on general things and/or the area history. Articles may include specific characters who may hold prominent positions, but should not be a substitute for the in-game descriptions available on nwn.sinfar.net and in game. Please see [[Contributing]] for further details.<br />
<br />
<!--I'd like to add a search box here but I want it to look nice (see Star Citizen wiki for examples). Will need to add extensions.--><br />
----<br />
{| class="wikitable" style="text-align: center;"<br />
!colspan="6"|'''New to Sinfar or NWN? Look up the following guides to get started.'''<br />
|-<br />
| [[About Sinfar]] || [[Getting Started - Diamond Edition]] || [[Getting Started - Diamond Edition on Linux]] || [[Getting Started - Enhanced Edition]] || [[Recommended Settings]] || [[Solving Client or Connection Issues]]<br />
|-<br />
!colspan="6"|'''Returning or just need the necessary downloads?'''<br />
|-<br />
|colspan="3" style="text-align:center;"|Download for the Sinfar [[Hak Files]] ||colspan="3" style="text-align:center;"|Download for the [[Sinfar Client Extender (SinfarX)]]<br />
|-<br />
!colspan="6" style="text-align: center"|<br />
|}<br />
'''<big><center>Also be sure to read up on our [[Rules]]!</center></big>'''<br />
----<br />
You can find information for players, supporters and builders.<br />
{| class="wikitable"<br />
!'''For Players'''<br />
|<br />
{|<br />
|[[Character Customisation]]<br />
|[[Approval Points]]<br />
|[[Chat Commands]]<br />
|[[Magical Items]]<br />
|[[House Scripts]]<br />
|[[Player Housing]]<br />
|-<br />
|[[Class Changes]]<br />
|[[Feat Changes]]<br />
|[[Spell Changes]]<br />
|[[Chat Channels]]<br />
|[[Custom Emotes]]<br />
|}<br />
|-<br />
!'''For Suporters'''<br />
|<br />
{|<br />
|[[Custom Scripting]]<br />
|[[Your Resources]]<br />
|[[All Supporter Resources]]<br />
|}<br />
|-<br />
!'''For Builders'''<br />
|<br />
{|<br />
|[[Creature Event System]]<br />
|[[Registered Events]]<br />
|[[Variable Events]]<br />
|}<br />
|-<br />
!'''For Scripters'''<br />
|<br />
{|<br />
|[[Common Includes]]<br />
|}<br />
|}<br />
----<br />
{| class="wikitable"<br />
|+<br />
! colspan="2" |The following categories are set up and should be set on relevant new pages. More categories can be applied.<br />
|-<br />
|[[:Category:Builder Contributions|Builder Contributions]]<br />
|For guides and instructions on your ERFs and contributions. Generally only useful for other builders. <br />
|-<br />
|[[:Category:Builders Tools|Builders Tools]]<br />
|Guides and instructions of various Sinfar tools specifically for builders.<br />
|-<br />
|[[:Category:Sinfar Supporters|Sinfar Supporters]]<br />
|Tools for Supporters to use primarily within their houses.<br />
|-<br />
|[[:Category:Player Businesses|Player Businesses]]<br />
|Lore articles for in-game establishments.<br />
|-<br />
|[[:Category:Builder Businesses|Builder Businesses]]<br />
|Instructions and details about businesses made by builders that exist outside player houses.<br />
|-<br />
|[[:Category:Player Tools|Player Tools]]<br />
|Various useful tools and pages for all players.<br />
|}<br />
__NOTOC__</div>LockOnhttps://wiki.sinfar.net/index.php?title=Main_Page&diff=422Main Page2024-09-19T16:44:18Z<p>LockOn: </p>
<hr />
<div>==Welcome to the '''Sinfar Wiki'''==<br />
Here you will find information about the server, its various areas and systems, guides and introductions. This Wiki is made up of user-submitted articles, and you can make your own contributions. You will require a functioning [[Sinfar account]] to log in and you can help us organize how to do our styling and formatting. Be sure to join our [https://https//discord.gg/jVaNBmj Discord] and check the [https://forum.sinfar.net/ Forums].<br />
<br />
When making new or editing existing articles, please respect that any article on here should be written in as an objective manner as possible, focusing on facts and information. If you write info about areas of the server, please avoid spoiling surprises and focus instead on general things and/or the area history. Articles may include specific characters who may hold prominent positions, but should not be a substitute for the in-game descriptions available on nwn.sinfar.net and in game. Please see [[Contributing]] for further details.<br />
<br />
<!--I'd like to add a search box here but I want it to look nice (see Star Citizen wiki for examples). Will need to add extensions.--><br />
----<br />
{| class="wikitable" style="text-align: center;"<br />
!colspan="6"|'''New to Sinfar or NWN? Look up the following guides to get started.'''<br />
|-<br />
| [[About Sinfar]] || [[Getting Started - Diamond Edition]] || [[Getting Started - Diamond Edition on Linux]] || [[Getting Started - Enhanced Edition]] || [[Recommended Settings]] || [[Solving Client or Connection Issues]]<br />
|-<br />
!colspan="6"|'''Returning or just need the necessary downloads?'''<br />
|-<br />
|colspan="3" style="text-align:center;"|Download for the Sinfar [[Hak Files]] ||colspan="3" style="text-align:center;"|Download for the [[Sinfar Client Extender (SinfarX)]]<br />
|-<br />
!colspan="6" style="text-align: center"|'''<big>Also be sure to read up on our [[Rules]]!</big>'''<br />
|}<br />
'''<big><center>Also be sure to read up on our [[Rules]]!</center></big>'''<br />
----<br />
You can find information for players, supporters and builders.<br />
{| class="wikitable"<br />
!'''For Players'''<br />
|<br />
{|<br />
|[[Character Customisation]]<br />
|[[Approval Points]]<br />
|[[Chat Commands]]<br />
|[[Magical Items]]<br />
|[[House Scripts]]<br />
|[[Player Housing]]<br />
|-<br />
|[[Class Changes]]<br />
|[[Feat Changes]]<br />
|[[Spell Changes]]<br />
|[[Chat Channels]]<br />
|[[Custom Emotes]]<br />
|}<br />
|-<br />
!'''For Suporters'''<br />
|<br />
{|<br />
|[[Custom Scripting]]<br />
|[[Your Resources]]<br />
|[[All Supporter Resources]]<br />
|}<br />
|-<br />
!'''For Builders'''<br />
|<br />
{|<br />
|[[Creature Event System]]<br />
|[[Registered Events]]<br />
|[[Variable Events]]<br />
|}<br />
|-<br />
!'''For Scripters'''<br />
|<br />
{|<br />
|[[Common Includes]]<br />
|}<br />
|}<br />
----<br />
{| class="wikitable"<br />
|+<br />
! colspan="2" |The following categories are set up and should be set on relevant new pages. More categories can be applied.<br />
|-<br />
|[[:Category:Builder Contributions|Builder Contributions]]<br />
|For guides and instructions on your ERFs and contributions. Generally only useful for other builders. <br />
|-<br />
|[[:Category:Builders Tools|Builders Tools]]<br />
|Guides and instructions of various Sinfar tools specifically for builders.<br />
|-<br />
|[[:Category:Sinfar Supporters|Sinfar Supporters]]<br />
|Tools for Supporters to use primarily within their houses.<br />
|-<br />
|[[:Category:Player Businesses|Player Businesses]]<br />
|Lore articles for in-game establishments.<br />
|-<br />
|[[:Category:Builder Businesses|Builder Businesses]]<br />
|Instructions and details about businesses made by builders that exist outside player houses.<br />
|-<br />
|[[:Category:Player Tools|Player Tools]]<br />
|Various useful tools and pages for all players.<br />
|}<br />
__NOTOC__</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=421About Sinfar2024-09-18T04:43:32Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<br />
<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|left|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=420About Sinfar2024-09-18T04:43:17Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<br />
<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|left|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=419About Sinfar2024-09-18T04:43:06Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<br />
<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|left|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=418About Sinfar2024-09-18T04:42:57Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<br />
<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|left|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=417About Sinfar2024-09-18T04:42:31Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|left|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=416About Sinfar2024-09-18T04:41:55Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|left|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=415About Sinfar2024-09-18T04:41:42Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image8.jpg|thumb|right|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=414About Sinfar2024-09-18T04:41:08Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
[[File:Image8.jpg|thumb|Pondering the situation.|274x274px]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=413About Sinfar2024-09-18T04:40:27Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=412About Sinfar2024-09-18T04:39:54Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=411About Sinfar2024-09-18T04:39:41Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=410About Sinfar2024-09-18T04:38:40Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=409About Sinfar2024-09-18T04:38:13Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=408About Sinfar2024-09-18T04:38:03Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=407About Sinfar2024-09-18T04:37:46Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=406About Sinfar2024-09-18T04:37:25Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=405About Sinfar2024-09-18T04:36:08Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=404About Sinfar2024-09-18T04:35:41Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=403About Sinfar2024-09-18T04:35:28Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|right|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=402About Sinfar2024-09-18T04:35:07Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|baseline|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=401About Sinfar2024-09-18T04:31:14Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=400About Sinfar2024-09-18T04:30:37Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|left|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|center|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=399About Sinfar2024-09-18T04:29:46Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|left|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=398About Sinfar2024-09-18T04:29:16Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|left|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=394About Sinfar2024-09-17T04:22:05Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.<br />
[[File:CtF 3.jpg|thumb|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=393About Sinfar2024-09-17T04:21:35Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<nowiki><blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.</nowiki><br />
[[File:CtF 3.jpg|thumb|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.&lt;/blockquote&gt;<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=392About Sinfar2024-09-17T04:20:29Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
<nowiki><blockquote>Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.</nowiki>&lt;/blockquote&gt;<br />
[[File:CtF 3.jpg|thumb|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOnhttps://wiki.sinfar.net/index.php?title=About_Sinfar&diff=391About Sinfar2024-09-17T04:18:29Z<p>LockOn: </p>
<hr />
<div>Welcome to Sinfar. Here, you'll find a persistent game world, built with the Neverwinter Nights Aurora Engine, for all 18+ players.<br />
<br />
&lt;nowiki&gt;Originally founded in 2010, Sinfar boasts years of volunteer-created content, in a true sand box environment. Here, our players socialize, engage in role play, level characters, run raid-level content, and can engage in controlled PvP, including factional PvP, with custom made characters within the game.&lt;/nowiki&gt;<br />
[[File:CtF 3.jpg|thumb|378x378px|Carnage on the battlefield!]]<br />
[[File:Image9.jpg|alt=|thumb|378x378px|A white skinned barbarian beauty. Don't ask her how she keeps those furs in place, unless you want the business end of her axe.]]<br />
Sinfar has the single best character/costume creation tools in all of the Neverwinter Nights Persistent server community. Racial and physical characteristics can be easily modified, costume pieces are all color tintable, and a wide variety of accessories exist. We even allow for custom shapes to be player-made, to enhance a given player's appearance and experience.<br />
<br />
Being a sand box style RP server, players have a lot of freedom to make the kinds of characters they want to be. The server boasts a large and very friendly LGBTQ+ population, with players logging in from 5 different continents all around the world. Global perspectives mix to help us have the best community possible, and we're proud of our players and our volunteers who help to make our server a great place to play and hang out.<br />
[[File:Image2.jpg|thumb|378x378px|Samurai in repose.]]<br />
[[File:Image8.jpg|thumb|Pondering the situation.]]<br />
Currently Sinfar operates best on Neverwinter Nights Diamond edition, though it is possible, with some small effort, to run the server with NWN Extended Edition. Plans are underway to migrate Sinfar to a fully functional EE server at some point in the future, but are still incomplete as of the time of this writing.<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[File:Image11.jpg|thumb|1108x1108px|Beach Party! Hooray!]]<br />
<br />
<br />
<br />
[[File:Image12.jpg|thumb|Who invited this guy?]]</div>LockOn