https://www.alandfaraway.info/Wiki/api.php?action=feedcontributions&feedformat=atom&user=WynnaALFA - User contributions [en]2026-04-04T10:05:53ZUser contributionsMediaWiki 1.29.1https://www.alandfaraway.info/Wiki/index.php?title=ACR_Spawn&diff=3986ACR Spawn2023-02-01T14:29:25Z<p>Wynna: /* Current Paramters */</p>
<hr />
<div>[[Category:ACR Systems]]<br />
The following is a complete list of features in the [[ALFA Core Rules|ACR]]'s spawn system.<br />
<br />
== Waypoints ==<br />
: ''See also: [[Using Local Variables]]''<br />
Just like [http://nwvault.ign.com/View.php?view=nwn2scripts.detail&id=181 NESS] and other spawn systems, the ACR's spawn system uses [[Waypoint|waypoints]] as spawn points. These waypoints have a great deal of options on them, in the form of local variables which the builder can change to suit his needs. You'll find a base, blank template for a spawn waypoint in the [[ALFA Campaign Folder]].<br />
<br />
It is important to note that ACR Spawn waypoints must be tagged as ''ACR_SPAWN_WP''.<br />
<br />
== Array Parameters ==<br />
In computer lingo, an [http://en.wikipedia.org/wiki/Array array] is simply a list of some sort of data of the same type. The spawn system uses arrays to list the "resource names" of creatures or objects you want to spawn, and the scripts you may wish to attach to these creatures. Since the spawn system depends on local variables for configuration, the arrays are lists of local variables. For example, ACR_SPAWN_RESNAME_ is a local string which lists the resrefs of the creatures spawned. So ACR_SPAWN_RESNAME_1 would be the name of the local variable for the first resref, ACR_SPAWN_RESNAME_2 the second, ACR_SPAWN_RESNAME_3 the third, and so on. Never skip a entry in an array. If you do, the spawn system will think the array has stopped at the missing entry. Also, always start at 1, not 0.<br />
<br />
== Current Parameters ==<br />
; ACR_SPAWN_TYPE (integer) : This indicates the type of object which is being spawned. The default is 0, for a creature, but other types are available, as listed below:<br />
::{| class="wikitable_standard boldFirstColumn"<br />
! Value<br />
! Result<br />
|-<br />
| 0<br />
| Creatures<br />
|-<br />
| 1<br />
| Placeables<br />
|-<br />
| 2<br />
| Items<br />
|-<br />
| 3<br />
| Store<br />
|-<br />
| 4<br />
| Waypoint<br />
|-<br />
| 5<br />
| Triggers<br />
|-<br />
| 6<br />
| Encounters<br />
|-<br />
| 7<br />
| Lights<br />
|-<br />
| 8<br />
| Trap<br />
|}<br />
<br />
; ACR_SPAWN_RESNAME_* (string array) : This array lists Resource Names of objects which are always spawned by the spawn point. If the spawn point is activated, all the Resource Names in this array will be spawned. Resource Names listed more than once are spawned more than once. <br />
:: ''Example: Leading to 2 badgers and a chicken each time: ACR_SPAWN_RESNAME_1 = "c_badger"; ACR_SPAWN_RESNAME_2 = "c_badger"; ACR_SPAWN_RESNAME_3 = "c_chicken"''<br />
<br />
; ACR_SPAWN_RANDOM_RESNAME_* (string array) : This array lists Resource Names of objects which are chosen at random to be spawned. The number of chosen Resource Names depends on the ACR_SPAWN_RESNAMES_MIN/MAX settings, see below. This array can have no more than 31 entries. Each time the spawns are chosen randomly from this list.<br />
:: ''Example: Leading to 67% chicken and 33% badger: ACR_SPAWN_RANDOM_RESNAME_1 = "c_badger"; ACR_SPAWN_RANDOM_RESNAME_2 = "c_chicken"; ACR_SPAWN_RANDOM_RESNAME_3 = "c_chicken"''<br />
<br />
; ACR_SPAWN_RESNAMES_MIN (integer)<br />
; ACR_SPAWN_RESNAMES_MAX (integer) : These are the maximum and minimum numbers of Resource Names spawned from the ACR_SPAWN_RANDOM_RESNAME_ array. The actual number spawned is determined randomly between these values. They can range between 0 and 31. To keep this value from being random, set both the min and max equal. Each one will be an independent pull from the RANDOM_RESNAME array described above, so if these are >1, you may end up with multiples of Resource Names from the RANDOM_RESNAME array: best to leave uniques like bosses to their own waypoint, or use the ACR_SPAWN_RESNAME_# option above for them.<br />
<br />
; ACR_SPAWN_RESPAWN_COUNT (integer) : This local integer defines the number of times a spawn point will spawn, if all its children have been killed. The default is 1, which indicates a "single-life" spawn. Mod reset or scripts can bring the spawn back, and normal despawning due to time or inactivity will not permanently deactivate the spawn point, only death of all of it's spawned "children". Note that this relies on the spawned objects having the correct acf_ondeath() scripts in their OnDeath events. A setting of "-1" will lead to an infinitely respawning waypoint, which will always repopulate after being "cleared out". Similarly, setting this value to "5", would mean the spawn point would have to be killed off 5 separate times to deactivate "for good". Note that currently a mod reset still sets this counter back to it's original state, though we may tie this into persistent variables once they become available to us again.<br />
<br />
; ACR_RESPAWN_DELAY_MIN (float)<br />
; ACR_RESPAWN_DELAY_MAX (float) : This is the random period of time a spawn spends "recharging" after its children have all been killed (see above). This value is in game hours, and is chosen randomly between the mininum and maximum. To keep this value from being random, set both the min and max equal. In practical terms, the respawn will happen at the next spawn pseudoheartbest after the timer expires, so the "accuracy" of the respawn delay will be somewhat dependent on the refresh rate of the system. Also note that setting respawn delay to "0.0" means the respawn will still be delayed until the next pseudoheartbeat, so respawns are never instantaneous (though if a spawn is killed just before a heartbeat, it may appear so).<br />
<br />
; ACR_SPAWN_CHANCE (float) : This value, from 0 to 100, represents the chance a spawn has of spawning. This chance is computed once every game day. The % chance applies per day for the waypoint collectively, so it is an all-or-nothing situation.<br />
<br />
; ACR_SPAWN_RANDOM_RADIUS (float) : This, if nonzero, specifies a maximum distance from the chosen spawn point location at which the spawn child may appear, in a random direction. This is calculated separately (distance and direction) for each spawned child, so for a multiple spawn, you can imagine it to describe the tightness of the "scatter" of the spawned children around the spawn point target. A small value will give a closely-spaced group, while a large one will give the illusion of entirely separate spawns, even though they are all children of the same waypoint.<br />
<br />
; ACR_SPAWN_RANDOM_RANGE (float) : This, if nonzero, specifies a range (in a random direction) from the actual location of the waypoint to the target/centerpoint of the spawning- 0.0 will always center the spawn right on top of the waypoint, while an arbitrarily large value could place the spawn anywhere in the area. Note that when spawning a single child, this parameter is functionally equivalent to ACR_SPAWN_RANDOM_RADIUS, but when used with multiple children, it can place a mob of creatures, placeables, or items in a less predictable position, either in a closely knit group, or a broad spread.<br />
<br />
; ACR_SPAWN_IN_VFX (integer) : This integer indicates the [[Visual Effect]] number of a visual effect which is played on every object this spawn point spawns. It is commonly used to represent teleporting or summoned monsters.<br />
<br />
; ACR_SPAWN_VFX (integer) : This integer indicates the visual effect number of a visual effect which is played on the spawn point itself as it activates. It is commonly used to represent groups of teleporting or summoned monsters.<br />
<br />
; ACR_SPAWN_IN_SFX (string) : This is the [[Sound Effect]] file which is played on each object spawned at this spawn point.<br />
<br />
; ACR_SPAWN_SFX (string) : This is the sound effect file which is played on the spawn point itself as it activates.<br />
<br />
; ACR_SPAWN_ANIMATION (string) : This is the animation performed by all creatures spawned from this spawn point, as they spawn.<br />
<br />
; ACR_SPAWN_IN_HOUR (integer)<br />
; ACR_SPAWN_OUT_HOUR (integer) : This is the hour of the day the spawn starts to spawn in and spawns out at. If the current hour is between these values, the spawn can be active. If the two values are equal (such as zero, the default), the hour of the day has no effect on whether or not the spawn activates. Valid values are between 0 and 23. This also works for "circular" cases, such as Night-only spaws.<br />
:: ''Example: Here for spawning in at 18:00, and spawning back out every 06:00: ACR_SPAWN_IN_HOUR = "18" ACR_SPAWN_OUT_HOUR = "6"''<br />
<br />
; ACR_SPAWN_IN_DAY (integer)<br />
; ACR_SPAWN_OUT_DAY (integer) : This is the day of the month (28 days in the Fearunian month) in which the spawn will spawn in and spawn out. These should also work in a circular fashion similar to the hours above, though that behaviour has not been stringently tested.<br />
<br />
; ACR_SPAWN_IN_MONTH (integer)<br />
; ACR_SPAWN_OUT_MONTH (integer) : This is the month of the year (12 months in the Faerunian year) the spawn starts to spawn in and spawns out at. If the current month is between these values, the spawn can be active. If the two values are equal (such as zero, the default), the month of the year has no effect on whether or not the spawn activates. Valid values are between 1 and 12.<br />
<br />
; ACR_SPAWN_IN_PC_SIGHT (integer) : If nonzero, the spawn will spawn with a PC in sight of it. This is disabled to keep spawns from suddenly appearing in front of a PC in an OOC fashion.<br />
<br />
; ACR_SPAWN_ONLY_WHEN_NO_PC_IN_AREA (integer) : If nonzero, this spawn will not respawn or activate at all if a PC is already in the area when it tries to do so. This is used to prevent creatures from re-appearing where they were after a PC just killed them, or something similar.<br />
<br />
; ACR_SPAWN_WITH_ANIMATION (integer) : If nonzero, this setting makes the spawn appear with its default spawn-in animation. This is usually a "fly-down" effect for most creatures, and a "climb down" effect for spiders.<br />
<br />
; ACR_SPAWN_IS_DISABLED (integer) : If nonzero, this spawn is disabled and will not spawn unless enabled by some other script or DM tool.<br />
<br />
; ACR_SPAWN_RANDOM_FACING (integer) : If nonzero, the spawn's facing is random, instead of facing the direction of the spawn waypoint.<br />
<br />
; ACR_SPAWN_IN_STEALTH (integer) : If nonzero, the spawn spawns in stealth mode.<br />
<br />
; ACR_SPAWN_IN_DETECT (integer) : If nonzero, the spawn spawns in detect mode.<br />
<br />
; ACR_SPAWN_BUFFED (integer) : If nonzero, spawned creatures spawn with all hour per level (or longer) buffs cast on itself in a semi-intelligent fashion (evil creatures cast protection from good, multiple magic vestimates or magic weapons are distributed over different items, etc).<br />
<br />
; ACR_COLOR_NAME (string) : Sets the color of the creature's name to the string value. Anything that functions inside of <C=[this spot]>Name</C> is valid for use.<br />
:: ''Example: A value of <code>gold</code> will set the spawned creature's name to a golden color.<br />
<br />
== Custom Script Parameters ==<br />
The spawn system allows custom scripts to be run when a spawn activates, for scripters to use how they wish. In order to use the functions listed here, be sure and include the spawn system's source file with the line: <code>#include "[[acr_spawn_i]]"</code> at the top of your script.<br />
<br />
; ACR_SPAWN_IN_SCRIPT_ (string array) : This array defines custom scripts which are run on each object spawned by the spawn point. Each script is executed on each spawned object once, with OBJECT_SELF pointing to the spawned object. These scripts can have any name.<br />
<br />
; ACR_SPAWN_SCRIPT_ (string array) : This array defines custom scripts which are run on the spawn point after it activates and spawns children. Each script is executed once, with OBJECT_SELF pointing to the spawn waypoint itself. If you wish to spawn additional objects from this script, use the function ACR_SpawnObject(). These scripts can have any name.<br />
<br />
; ACR_SPAWN_IS_ACTIVE_SCRIPT (string) : This variable defines a single custom which is run whenever the spawn system looks at the spawn point and tries to decide whether or not to spawn it. It allows custom logic to be used to decide whether or not the point should spawn, overriding the spawn point's normal behavior. In this script, OBJECT_SELF points to the spawn waypoint itself. If you wish the point to spawn, call ACR_ForceSpawn(). If you wish to keep it from spawning, call ACR_DisallowSpawn(). If you don't call either of these functions, the spawn point behaves as it normally would. If for some reason you call both, ACR_ForceSpawn() takes precedence and the spawn activates. (not yet tested)<br />
<br />
== System Configuration ==<br />
In addition to the options of each spawn point, there are a few settings which you can use to globally configure ALFA's spawn system. These are constants located in the script acf_spawn_i. Like all ACF files (click here for an explaination), it is never updated in an ACR update. So any settings here will always be preserved, though server staff may be asked to add options to this file in the future as the ACR evolves.<br />
<br />
; _SPAWN_AREA_DESPAWN_DELAY : This is the delay between when an area becomes empty of PCs, and when the spawn system despawns its children within it. Larger values here may lead to increased CPU usage as more creatures stay spawned at once.<br />
<br />
; _SPAWN_REFRESH_DELAY : This is the "heartbeat" of the spawn system. Larger values here reduce CPU usage, but make the spawn system react slower.<br />
<br />
; _SPAWN_PRESPAWN_SEAMLESS : This controls whether the spawn system will take cues from PCs entering seamless ATs in adjacent areas. If active, it should ensure all spawns are in place before the PC actually ATs. It may be disabled to keep memory use down, as it may lead to areas being population without PCs actually entering them (if the PC backs out of the AT trigger instead of continuing)<br />
<br />
; _SPAWN_PRESPAWN_PREDICTION : This controls whether the spawn system will take into account the predicted arrival point of an ATing PC, when deciding whether to spawn a group intended to be out of sight.<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=ACR_Spawn&diff=3985ACR Spawn2023-02-01T14:29:14Z<p>Wynna: /* Current Paramters */</p>
<hr />
<div>[[Category:ACR Systems]]<br />
The following is a complete list of features in the [[ALFA Core Rules|ACR]]'s spawn system.<br />
<br />
== Waypoints ==<br />
: ''See also: [[Using Local Variables]]''<br />
Just like [http://nwvault.ign.com/View.php?view=nwn2scripts.detail&id=181 NESS] and other spawn systems, the ACR's spawn system uses [[Waypoint|waypoints]] as spawn points. These waypoints have a great deal of options on them, in the form of local variables which the builder can change to suit his needs. You'll find a base, blank template for a spawn waypoint in the [[ALFA Campaign Folder]].<br />
<br />
It is important to note that ACR Spawn waypoints must be tagged as ''ACR_SPAWN_WP''.<br />
<br />
== Array Parameters ==<br />
In computer lingo, an [http://en.wikipedia.org/wiki/Array array] is simply a list of some sort of data of the same type. The spawn system uses arrays to list the "resource names" of creatures or objects you want to spawn, and the scripts you may wish to attach to these creatures. Since the spawn system depends on local variables for configuration, the arrays are lists of local variables. For example, ACR_SPAWN_RESNAME_ is a local string which lists the resrefs of the creatures spawned. So ACR_SPAWN_RESNAME_1 would be the name of the local variable for the first resref, ACR_SPAWN_RESNAME_2 the second, ACR_SPAWN_RESNAME_3 the third, and so on. Never skip a entry in an array. If you do, the spawn system will think the array has stopped at the missing entry. Also, always start at 1, not 0.<br />
<br />
== Current Paramters ==<br />
; ACR_SPAWN_TYPE (integer) : This indicates the type of object which is being spawned. The default is 0, for a creature, but other types are available, as listed below:<br />
::{| class="wikitable_standard boldFirstColumn"<br />
! Value<br />
! Result<br />
|-<br />
| 0<br />
| Creatures<br />
|-<br />
| 1<br />
| Placeables<br />
|-<br />
| 2<br />
| Items<br />
|-<br />
| 3<br />
| Store<br />
|-<br />
| 4<br />
| Waypoint<br />
|-<br />
| 5<br />
| Triggers<br />
|-<br />
| 6<br />
| Encounters<br />
|-<br />
| 7<br />
| Lights<br />
|-<br />
| 8<br />
| Trap<br />
|}<br />
<br />
; ACR_SPAWN_RESNAME_* (string array) : This array lists Resource Names of objects which are always spawned by the spawn point. If the spawn point is activated, all the Resource Names in this array will be spawned. Resource Names listed more than once are spawned more than once. <br />
:: ''Example: Leading to 2 badgers and a chicken each time: ACR_SPAWN_RESNAME_1 = "c_badger"; ACR_SPAWN_RESNAME_2 = "c_badger"; ACR_SPAWN_RESNAME_3 = "c_chicken"''<br />
<br />
; ACR_SPAWN_RANDOM_RESNAME_* (string array) : This array lists Resource Names of objects which are chosen at random to be spawned. The number of chosen Resource Names depends on the ACR_SPAWN_RESNAMES_MIN/MAX settings, see below. This array can have no more than 31 entries. Each time the spawns are chosen randomly from this list.<br />
:: ''Example: Leading to 67% chicken and 33% badger: ACR_SPAWN_RANDOM_RESNAME_1 = "c_badger"; ACR_SPAWN_RANDOM_RESNAME_2 = "c_chicken"; ACR_SPAWN_RANDOM_RESNAME_3 = "c_chicken"''<br />
<br />
; ACR_SPAWN_RESNAMES_MIN (integer)<br />
; ACR_SPAWN_RESNAMES_MAX (integer) : These are the maximum and minimum numbers of Resource Names spawned from the ACR_SPAWN_RANDOM_RESNAME_ array. The actual number spawned is determined randomly between these values. They can range between 0 and 31. To keep this value from being random, set both the min and max equal. Each one will be an independent pull from the RANDOM_RESNAME array described above, so if these are >1, you may end up with multiples of Resource Names from the RANDOM_RESNAME array: best to leave uniques like bosses to their own waypoint, or use the ACR_SPAWN_RESNAME_# option above for them.<br />
<br />
; ACR_SPAWN_RESPAWN_COUNT (integer) : This local integer defines the number of times a spawn point will spawn, if all its children have been killed. The default is 1, which indicates a "single-life" spawn. Mod reset or scripts can bring the spawn back, and normal despawning due to time or inactivity will not permanently deactivate the spawn point, only death of all of it's spawned "children". Note that this relies on the spawned objects having the correct acf_ondeath() scripts in their OnDeath events. A setting of "-1" will lead to an infinitely respawning waypoint, which will always repopulate after being "cleared out". Similarly, setting this value to "5", would mean the spawn point would have to be killed off 5 separate times to deactivate "for good". Note that currently a mod reset still sets this counter back to it's original state, though we may tie this into persistent variables once they become available to us again.<br />
<br />
; ACR_RESPAWN_DELAY_MIN (float)<br />
; ACR_RESPAWN_DELAY_MAX (float) : This is the random period of time a spawn spends "recharging" after its children have all been killed (see above). This value is in game hours, and is chosen randomly between the mininum and maximum. To keep this value from being random, set both the min and max equal. In practical terms, the respawn will happen at the next spawn pseudoheartbest after the timer expires, so the "accuracy" of the respawn delay will be somewhat dependent on the refresh rate of the system. Also note that setting respawn delay to "0.0" means the respawn will still be delayed until the next pseudoheartbeat, so respawns are never instantaneous (though if a spawn is killed just before a heartbeat, it may appear so).<br />
<br />
; ACR_SPAWN_CHANCE (float) : This value, from 0 to 100, represents the chance a spawn has of spawning. This chance is computed once every game day. The % chance applies per day for the waypoint collectively, so it is an all-or-nothing situation.<br />
<br />
; ACR_SPAWN_RANDOM_RADIUS (float) : This, if nonzero, specifies a maximum distance from the chosen spawn point location at which the spawn child may appear, in a random direction. This is calculated separately (distance and direction) for each spawned child, so for a multiple spawn, you can imagine it to describe the tightness of the "scatter" of the spawned children around the spawn point target. A small value will give a closely-spaced group, while a large one will give the illusion of entirely separate spawns, even though they are all children of the same waypoint.<br />
<br />
; ACR_SPAWN_RANDOM_RANGE (float) : This, if nonzero, specifies a range (in a random direction) from the actual location of the waypoint to the target/centerpoint of the spawning- 0.0 will always center the spawn right on top of the waypoint, while an arbitrarily large value could place the spawn anywhere in the area. Note that when spawning a single child, this parameter is functionally equivalent to ACR_SPAWN_RANDOM_RADIUS, but when used with multiple children, it can place a mob of creatures, placeables, or items in a less predictable position, either in a closely knit group, or a broad spread.<br />
<br />
; ACR_SPAWN_IN_VFX (integer) : This integer indicates the [[Visual Effect]] number of a visual effect which is played on every object this spawn point spawns. It is commonly used to represent teleporting or summoned monsters.<br />
<br />
; ACR_SPAWN_VFX (integer) : This integer indicates the visual effect number of a visual effect which is played on the spawn point itself as it activates. It is commonly used to represent groups of teleporting or summoned monsters.<br />
<br />
; ACR_SPAWN_IN_SFX (string) : This is the [[Sound Effect]] file which is played on each object spawned at this spawn point.<br />
<br />
; ACR_SPAWN_SFX (string) : This is the sound effect file which is played on the spawn point itself as it activates.<br />
<br />
; ACR_SPAWN_ANIMATION (string) : This is the animation performed by all creatures spawned from this spawn point, as they spawn.<br />
<br />
; ACR_SPAWN_IN_HOUR (integer)<br />
; ACR_SPAWN_OUT_HOUR (integer) : This is the hour of the day the spawn starts to spawn in and spawns out at. If the current hour is between these values, the spawn can be active. If the two values are equal (such as zero, the default), the hour of the day has no effect on whether or not the spawn activates. Valid values are between 0 and 23. This also works for "circular" cases, such as Night-only spaws.<br />
:: ''Example: Here for spawning in at 18:00, and spawning back out every 06:00: ACR_SPAWN_IN_HOUR = "18" ACR_SPAWN_OUT_HOUR = "6"''<br />
<br />
; ACR_SPAWN_IN_DAY (integer)<br />
; ACR_SPAWN_OUT_DAY (integer) : This is the day of the month (28 days in the Fearunian month) in which the spawn will spawn in and spawn out. These should also work in a circular fashion similar to the hours above, though that behaviour has not been stringently tested.<br />
<br />
; ACR_SPAWN_IN_MONTH (integer)<br />
; ACR_SPAWN_OUT_MONTH (integer) : This is the month of the year (12 months in the Faerunian year) the spawn starts to spawn in and spawns out at. If the current month is between these values, the spawn can be active. If the two values are equal (such as zero, the default), the month of the year has no effect on whether or not the spawn activates. Valid values are between 1 and 12.<br />
<br />
; ACR_SPAWN_IN_PC_SIGHT (integer) : If nonzero, the spawn will spawn with a PC in sight of it. This is disabled to keep spawns from suddenly appearing in front of a PC in an OOC fashion.<br />
<br />
; ACR_SPAWN_ONLY_WHEN_NO_PC_IN_AREA (integer) : If nonzero, this spawn will not respawn or activate at all if a PC is already in the area when it tries to do so. This is used to prevent creatures from re-appearing where they were after a PC just killed them, or something similar.<br />
<br />
; ACR_SPAWN_WITH_ANIMATION (integer) : If nonzero, this setting makes the spawn appear with its default spawn-in animation. This is usually a "fly-down" effect for most creatures, and a "climb down" effect for spiders.<br />
<br />
; ACR_SPAWN_IS_DISABLED (integer) : If nonzero, this spawn is disabled and will not spawn unless enabled by some other script or DM tool.<br />
<br />
; ACR_SPAWN_RANDOM_FACING (integer) : If nonzero, the spawn's facing is random, instead of facing the direction of the spawn waypoint.<br />
<br />
; ACR_SPAWN_IN_STEALTH (integer) : If nonzero, the spawn spawns in stealth mode.<br />
<br />
; ACR_SPAWN_IN_DETECT (integer) : If nonzero, the spawn spawns in detect mode.<br />
<br />
; ACR_SPAWN_BUFFED (integer) : If nonzero, spawned creatures spawn with all hour per level (or longer) buffs cast on itself in a semi-intelligent fashion (evil creatures cast protection from good, multiple magic vestimates or magic weapons are distributed over different items, etc).<br />
<br />
; ACR_COLOR_NAME (string) : Sets the color of the creature's name to the string value. Anything that functions inside of <C=[this spot]>Name</C> is valid for use.<br />
:: ''Example: A value of <code>gold</code> will set the spawned creature's name to a golden color.<br />
<br />
== Custom Script Parameters ==<br />
The spawn system allows custom scripts to be run when a spawn activates, for scripters to use how they wish. In order to use the functions listed here, be sure and include the spawn system's source file with the line: <code>#include "[[acr_spawn_i]]"</code> at the top of your script.<br />
<br />
; ACR_SPAWN_IN_SCRIPT_ (string array) : This array defines custom scripts which are run on each object spawned by the spawn point. Each script is executed on each spawned object once, with OBJECT_SELF pointing to the spawned object. These scripts can have any name.<br />
<br />
; ACR_SPAWN_SCRIPT_ (string array) : This array defines custom scripts which are run on the spawn point after it activates and spawns children. Each script is executed once, with OBJECT_SELF pointing to the spawn waypoint itself. If you wish to spawn additional objects from this script, use the function ACR_SpawnObject(). These scripts can have any name.<br />
<br />
; ACR_SPAWN_IS_ACTIVE_SCRIPT (string) : This variable defines a single custom which is run whenever the spawn system looks at the spawn point and tries to decide whether or not to spawn it. It allows custom logic to be used to decide whether or not the point should spawn, overriding the spawn point's normal behavior. In this script, OBJECT_SELF points to the spawn waypoint itself. If you wish the point to spawn, call ACR_ForceSpawn(). If you wish to keep it from spawning, call ACR_DisallowSpawn(). If you don't call either of these functions, the spawn point behaves as it normally would. If for some reason you call both, ACR_ForceSpawn() takes precedence and the spawn activates. (not yet tested)<br />
<br />
== System Configuration ==<br />
In addition to the options of each spawn point, there are a few settings which you can use to globally configure ALFA's spawn system. These are constants located in the script acf_spawn_i. Like all ACF files (click here for an explaination), it is never updated in an ACR update. So any settings here will always be preserved, though server staff may be asked to add options to this file in the future as the ACR evolves.<br />
<br />
; _SPAWN_AREA_DESPAWN_DELAY : This is the delay between when an area becomes empty of PCs, and when the spawn system despawns its children within it. Larger values here may lead to increased CPU usage as more creatures stay spawned at once.<br />
<br />
; _SPAWN_REFRESH_DELAY : This is the "heartbeat" of the spawn system. Larger values here reduce CPU usage, but make the spawn system react slower.<br />
<br />
; _SPAWN_PRESPAWN_SEAMLESS : This controls whether the spawn system will take cues from PCs entering seamless ATs in adjacent areas. If active, it should ensure all spawns are in place before the PC actually ATs. It may be disabled to keep memory use down, as it may lead to areas being population without PCs actually entering them (if the PC backs out of the AT trigger instead of continuing)<br />
<br />
; _SPAWN_PRESPAWN_PREDICTION : This controls whether the spawn system will take into account the predicted arrival point of an ATing PC, when deciding whether to spawn a group intended to be out of sight.<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=ACR_Traps&diff=3984ACR Traps2023-02-01T14:23:50Z<p>Wynna: /* Tooling Additional Traps */</p>
<hr />
<div>[[Category:ACR Tools]]<br />
[[Category:DM Guides]]<br />
The ACR has in its core content a custom implementation of traps that is meant to serve as a workaround for the severe limitations imposed by traps as they are implemented by [[Neverwinter Nights 2 | NWN2]]. These traps are capable of spawning and despawning, are aware of their own shapes and sizes, and can control whether or not they trigger by a number of conditions, including those which we would associate with spellcasting traps.<br />
<br />
== Detecting Traps ==<br />
A search roll is automatically rolled, with the fact that the roll was made being hidden, whenever a character approaches a trap with detect mode on. If the result of the search check is greater than or equal to the search DC, the trap is detected. There is a special exception made for high-DC traps: only rogues, or people under the effects of a Find Traps spell, may find traps with a search DC greater than 20. If a character does not expend the trap (for example, by triggering it until it runs out of ammunition or charges), but remains near it, an additional roll will be made every six seconds, and every PC near the trap will also get rolls.<br />
<br />
When a trap is detected, the character whose check revealed the trap will gain a visual effect overhead that indicates responsibility for the detection. In addition, the trap will become visible as a pulsing red VFX in the shape of the trap on the ground, and finally a disarm target object will appear on the ground where the detector was standing when the trap was revealed.<br />
: '''It is important to note that traps are invisible to DMs once they are spawned. The tick in the spawning UI when placing a trap is the indication that the spawning has happened.'''<br />
<br />
== Detect Magic ==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Spell_Traps Detect Magic: Spell Traps]<br />
<br />
Detect Magic will work automatically with a placed spell trap or a spell trap spawnpoint with a variable added to it called ACR_TRAP_SPELL_ID which contains the integer of the spell ID.* As with any ACR_Trap, either option requires a placeable tagged as TRAP_ORIGIN nearby, also.<br />
<br />
Detect Magic uses ACR_TRAP_SPELL_ID (already on a placed trap or added to the spawnpoint) to cross-reference spell effects against 2DA information. From the 2DA it pulls the proper school and spell power to put into the report to the Caster. For instance, for a Web Trap: "Spider Web and a circle centered on a spot 1m southwest of Spider Web gives off a Moderate aura of Conjuration." Spider Web is the placeable tagged as TRAP_ORIGIN. The spot at which the circle is reported is the either the placed trap or the spawnpoint. <br />
<br />
*Weirdly, although a placed trap already has the ACR_TRAP_SPELL_ID on it, that same trap spawned by a spawnpoint does not, so it has to be added to the spawnpoint itself for the Detect Magic to find it.<br />
<br />
== Disarming Traps ==<br />
Traps are disarmed by using the disarm widget. DM Avatars who do this will immediately and automatically disarm the trap, removing it and the target from the area permanently. If an character uses the disarm target, that character will begin to work on disarming the trap, which will take 12-48 (most likely 30) seconds. During this time the character must remain reasonably stationary and may not carry out other actions, but stepping away from the disarming device will abort the effort.<br />
<br />
Characters with ranks in Disable Device may choose to aid the effort by also using the disarm target, and as many as can physically approach the device may help. Each additional disabler will roll a DC 10 Disable Device check, granting a stacking +2 bonus to the primary disabler's check on success. A character may only attempt to aid in disabling a trap once per primary user's attempt.<br />
<br />
The disarming character will not know ahead of time how long it will take to disarm the trap, nor will he or she know how difficult to disarm the trap will be until attempting to disarm it once.<br />
<br />
At the end of the time required to disarm the trap, a skill check is made against the disarm DC of the trap. If the roll is greater than or equal to the DC to disarm the trap, the trap is removed from play and rendered harmless. If the Disable Device roll fails by 4 or less, then no change is made to the trap. If the Disable Device roll fails by 5 or more, then the effort is botched and the trap is triggered, functioning per the fired trap section, except that the trap disabler is treated as a potential target (possibly the only potential target) for the trap's execution.<br />
<br />
== Triggering Traps ==<br />
When a trap is triggered, its effects are applied to a random creature within the trap's trigger area, and potentially a botched disabler (see above). This effect may cover an area. For example, a trap which explodes in a fireball when triggered may have three people working on disarming it. Should the check be botched anyway while the trigger area is empty, only the primary disabler will be a valid target and he or she will be the center of the resulting explosion. However, the two nearby assistants are likely to be within the blast and to also be injured. If on the other hand the trigger required several people in its area to be triggered, and three were already within, botching the trap has a 1 in 4 chance of centering on each person in the trigger area or the disabler.<br />
<br />
It is possible for traps to trigger with discretion, such as a magical trap that only harms orcs. In this case, only qualifying creatures in the trigger area will be regarded as valid targets. Botching a disable attempt overrides this. A botched disabler is always a valid target, regardless of the trap's specific restrictions.<br />
<br />
== Default Traps ==<br />
By default, every ALFA module has access to a set of standard traps, which are modeled after the default NWN2 traps. All of them have only one charge, do direct damage, and have equal spot, disable, and reflex save DCs. All offer reflex saves when triggered. All are of "medium" trigger size (comparable to the area of a Magic Circle vs. Alignment)<br />
<br />
:{| class="wikitable_standard"<br />
! Name<br />
! Damage<br />
! DC<br />
! Area<br />
|-<br />
| Acid Blob, Minor<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Acid Blob, Average<br />
| 5d6<br />
| 20<br />
| 1 meter<br />
|-<br />
| Acid Blob, Strong<br />
| 12d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Blob, Deadly<br />
| 18d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Splash, Minor<br />
| 2d8<br />
| 12<br />
| 1 meter<br />
|-<br />
| Acid Splash, Average<br />
| 3d8<br />
| 14<br />
| 1 meter<br />
|-<br />
| Acid Splash, Strong<br />
| 5d8<br />
| 17<br />
| 1 meter<br />
|-<br />
| Acid Splash, Deadly<br />
| 8d8<br />
| 20<br />
| 1 meter<br />
|-<br />
| Electrical, Minor<br />
| 8d6<br />
| 19<br />
| 5 meters<br />
|-<br />
| Electrical, Average<br />
| 15d6<br />
| 22<br />
| 5 meters<br />
|-<br />
| Electrical, Strong<br />
| 20d6<br />
| 26<br />
| 5 meters<br />
|-<br />
| Electrical, Deadly<br />
| 30d6<br />
| 28<br />
| 5 meters<br />
|-<br />
| Fire, Minor<br />
| 5d6<br />
| 18<br />
| 2 meters<br />
|-<br />
| Fire, Average<br />
| 8d6<br />
| 20<br />
| 2 meters<br />
|-<br />
| Fire, Strong<br />
| 15d6<br />
| 23<br />
| 4 meters<br />
|-<br />
| Fire, Deadly<br />
| 25d6<br />
| 26<br />
| 4 meters<br />
|-<br />
| Frost, Minor<br />
| 2d4<br />
| 12<br />
| 1 meter<br />
|-<br />
| Frost, Average<br />
| 3d4<br />
| 13<br />
| 1 meter<br />
|-<br />
| Frost, Strong<br />
| 5d4<br />
| 14<br />
| 1 meter<br />
|-<br />
| Frost, Deadly<br />
| 8d4<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Minor<br />
| 2d6<br />
| 12<br />
| 1 meter<br />
|-<br />
| Negative, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Strong<br />
| 5d6<br />
| 18<br />
| 1 meter<br />
|-<br />
| Negative, Deadly<br />
| 8d6<br />
| 21<br />
| 1 meter<br />
|-<br />
| Sonic, Minor<br />
| 2d4<br />
| 12<br />
| 3 meters<br />
|-<br />
| Sonic, Average<br />
| 3d4<br />
| 14<br />
| 3 meters<br />
|-<br />
| Sonic, Strong<br />
| 5d4<br />
| 17<br />
| 3 meters<br />
|-<br />
| Sonic, Deadly<br />
| 8d4<br />
| 20<br />
| 3 meters<br />
|-<br />
| Spike, Minor<br />
| 2d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Strong<br />
| 5d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Deadly<br />
| 25d6<br />
| 15<br />
| 1 meter<br />
|}<br />
<br />
== Tooling Additional Traps ==<br />
Additional traps may be added to a module by creating waypoints which have variables on them which indicate that they are traps. The following variables control the behavior of the trap.<br />
<br />
* '''ACR_TRAP_TRIGGER_AREA''' (integer) -- This variable determines how large the area which is capable of causing the trap to fire is.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Name<br />
! Comparison<br />
|-<br />
| 1<br />
| Small<br />
| Single-Target<br />
|-<br />
| 2<br />
| Medium<br />
| Magic Circle v. Alignment<br />
|-<br />
| 3<br />
| Large<br />
| Entangle<br />
|-<br />
| 4<br />
| Huge<br />
| Fireball<br />
|-<br />
| 5<br />
| Gargantuan<br />
| Lesser Missile Storm<br />
|-<br />
| 6<br />
| Colossal<br />
| Area Dispel Magic<br />
|}<br />
* '''ACR_TRAP_ATTACK_BONUS''' (integer, optional) -- This is the attack bonus that will be used to calculate if a trap is able to damage its target, should no reflex save be defined for the trap. This is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DAMAGE_TYPE''' (bitfield) -- This variable determines what kind of damage will be applied to targets of the trap. As a bitfield, you may take the sum of several damage types to make the trap do multiple types of damage. For example, Piercing Damage (2) and Slashing Damage (4) can be added together to make a piercing/slashing trap (6). This is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Damage Type<br />
|-<br />
| 1<br />
| Bludgeoning<br />
|-<br />
| 2<br />
| Piercing<br />
|-<br />
| 4<br />
| Slashing<br />
|-<br />
| 8<br />
| Magical<br />
|-<br />
| 16<br />
| Acid<br />
|-<br />
| 32<br />
| Cold<br />
|-<br />
| 64<br />
| Divine<br />
|-<br />
| 128<br />
| Electrical<br />
|-<br />
| 256<br />
| Fire<br />
|-<br />
| 512<br />
| Negative<br />
|-<br />
| 1024<br />
| Positive<br />
|-<br />
| 2048<br />
| Sonic<br />
|}<br />
* '''ACR_TRAP_DETECT_DC (integer)''' -- This variable determines what the DC of search checks to discover the trap will be. If this number is greater than 20, the trap will only be discoverable by Rogues.<br />
* '''ACR_TRAP_DICE_NUMBER (integer)''' -- This variable determines how many dice will be rolled to determine trap damage. This is ignored if the trap casts a spell. For example, if this is 3 and ACR_TRAP_DICE_TYPE is 6, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DICE_TYPE (integer)''' -- This variable determines what sort of die will be rolled to determine trap damage. For example, if this is 6, and ACR_TRAP_DICE_NUMBER is 3, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DISARM_DC (integer)''' -- This variable determines what the DC to disarm the trap is.<br />
* '''ACR_TRAP_EFFECT_AREA (integer)''' -- This variable uses the SHAPE_ constants to determine how this trap's effect spreads out, if it has a large enough area to be significant. This setting is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Shape<br />
|-<br />
| 0<br />
| Spell Cyllinder (e.g. Lightning Bolt)<br />
|-<br />
| 1<br />
| Cone (e.g. Burning Hands)<br />
|-<br />
| 2<br />
| Cube (e.g. Order's Wrath)<br />
|-<br />
| 3<br />
| Spell Cone (e.g. Cone of Cold)<br />
|-<br />
| 4<br />
| Sphere (e.g. Fireball)<br />
|}<br />
* '''ACR_TRAP_EFFECT_SIZE''' (float) -- This is the size, in meters, of the effect area defined previously. Cylinders and cones become longer, but remain directional. Cubes gain length on all sides equally. Spheres gain a larger radius. This setting is ignroed if the trap casts a spell.<br />
* '''ACR_TRAP_MINIMUM_TO_TRIGGER''' (integer) -- This is the number of creatures who meet the criteria for a trap's triggering who must be within the trap's trigger area (defined above) before the trap will fire.<br />
* '''ACR_TRAP_NUMBER_OF_SHOTS''' (integer) -- This is the number of times the trap will fire before it is discharged. If this number is -1, the trap has infinite charges, and will fire until disarmed.<br />
* '''ACR_TRAP_SAVE_DC''' (integer) -- This is the reflex save DC of the trap. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- This is the ID of the spell that is cast. If this is -1 or if it is absent, the trap will not be regarded as spell casting, and will instead resolve to do damage. If this option is set, the trap must be placed or spawned near a placeable with the tag "TRAP_ORIGIN." In the absence of this placeable, the trap trigger will attempt to-- and typically fail to-- cast the spell itself.<br />
* '''ACR_TRAP_TARGET_ALIGNMENT''' (integer) -- This setting determines which alignments are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other alignments. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Alignment<br />
|-<br />
| 0<br />
| All Alignments<br />
|-<br />
| 1<br />
| Neutral Alignments<br />
|-<br />
| 2<br />
| Lawful Alignments<br />
|-<br />
| 3<br />
| Chaotic Alignments<br />
|-<br />
| 4<br />
| Good Alignments<br />
|-<br />
| 5<br />
| Evil Alignments<br />
|}<br />
* '''ACR_TRAP_TARGET_RACE''' (integer) -- This setting determins which racial types are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other races. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Race<br />
|-<br />
| 0<br />
| Dwarf<br />
|-<br />
| 1<br />
| Elf<br />
|-<br />
| 2<br />
| Gnome<br />
|-<br />
| 3<br />
| Halfling<br />
|-<br />
| 4<br />
| Half-Elf<br />
|-<br />
| 5<br />
| Half-Orc<br />
|-<br />
| 6<br />
| Human<br />
|-<br />
| 7<br />
| Abberations<br />
|-<br />
| 8<br />
| Animals<br />
|-<br />
| 9<br />
| Beasts (depreciated)<br />
|-<br />
| 10<br />
| Constructs<br />
|-<br />
| 11<br />
| Dragons<br />
|-<br />
| 12<br />
| Goblinoids<br />
|-<br />
| 13<br />
| Monstrous Humanoids<br />
|-<br />
| 14<br />
| Orcs<br />
|-<br />
| 15<br />
| Reptilian Humanoids<br />
|-<br />
| 16<br />
| Elementals<br />
|-<br />
| 17<br />
| Fey<br />
|-<br />
| 18<br />
| Giants<br />
|-<br />
| 19<br />
| Magical Beasts<br />
|-<br />
| 20<br />
| Outsiders<br />
|-<br />
| 24<br />
| Undead<br />
|-<br />
| 25<br />
| Vermin<br />
|-<br />
| '''28'''<br />
| '''All Races'''<br />
|-<br />
| 29<br />
| Oozes<br />
|-<br />
| 30<br />
| Incorporeal (depreciated)<br />
|-<br />
| 31<br />
| Yuan-Ti<br />
|}<br />
* '''ACR_TRAP_DESCRIPTION''' (string) -- This setting determines what the descriptive text on the trap's disarm target will read when examined with the default "examine" command. While it may contain any arbitrary information deemed useful by the builders, it is recommended that it contain a description of what a person would see of this trap upon discovering it.<br />
<br />
== Spawning Traps ==<br />
ACR Traps are currently able to be spawned through the [[ACR Creator]], and may also be placed using the ACR Spawn System, with object type 8.<br />
<br />
In order to spawn a trap, you must first tool the trap, according to the instructions above, and then use the resource name of the waypoint used to tool the trap as the resource name of the trap on the spawn point. In addition, for the trap to register to Detect Magic, to this spawnpoint add the variable: ACR_TRAP_SPELL_ID. Enter the spell integer into the integer slot. <br />
<br />
In all other respects, these spawn points work as any other spawn point.<br />
<br />
In addition, you may place a placeable with the tag "TRAP_ORIGIN" near any trap trigger and it will be regarded as the source for all effects which are created by the trap. This has two uses:<br />
* Animations that involve projectiles will show the trap's effect being shot from the trap origin<br />
* The trap may be used in the spell trap mode (as placeables are allowed to cast spells in the NWN2 engine, but triggers are not).<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=ACR_Traps&diff=3983ACR Traps2023-02-01T14:23:16Z<p>Wynna: /* Tooling Additional Traps */</p>
<hr />
<div>[[Category:ACR Tools]]<br />
[[Category:DM Guides]]<br />
The ACR has in its core content a custom implementation of traps that is meant to serve as a workaround for the severe limitations imposed by traps as they are implemented by [[Neverwinter Nights 2 | NWN2]]. These traps are capable of spawning and despawning, are aware of their own shapes and sizes, and can control whether or not they trigger by a number of conditions, including those which we would associate with spellcasting traps.<br />
<br />
== Detecting Traps ==<br />
A search roll is automatically rolled, with the fact that the roll was made being hidden, whenever a character approaches a trap with detect mode on. If the result of the search check is greater than or equal to the search DC, the trap is detected. There is a special exception made for high-DC traps: only rogues, or people under the effects of a Find Traps spell, may find traps with a search DC greater than 20. If a character does not expend the trap (for example, by triggering it until it runs out of ammunition or charges), but remains near it, an additional roll will be made every six seconds, and every PC near the trap will also get rolls.<br />
<br />
When a trap is detected, the character whose check revealed the trap will gain a visual effect overhead that indicates responsibility for the detection. In addition, the trap will become visible as a pulsing red VFX in the shape of the trap on the ground, and finally a disarm target object will appear on the ground where the detector was standing when the trap was revealed.<br />
: '''It is important to note that traps are invisible to DMs once they are spawned. The tick in the spawning UI when placing a trap is the indication that the spawning has happened.'''<br />
<br />
== Detect Magic ==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Spell_Traps Detect Magic: Spell Traps]<br />
<br />
Detect Magic will work automatically with a placed spell trap or a spell trap spawnpoint with a variable added to it called ACR_TRAP_SPELL_ID which contains the integer of the spell ID.* As with any ACR_Trap, either option requires a placeable tagged as TRAP_ORIGIN nearby, also.<br />
<br />
Detect Magic uses ACR_TRAP_SPELL_ID (already on a placed trap or added to the spawnpoint) to cross-reference spell effects against 2DA information. From the 2DA it pulls the proper school and spell power to put into the report to the Caster. For instance, for a Web Trap: "Spider Web and a circle centered on a spot 1m southwest of Spider Web gives off a Moderate aura of Conjuration." Spider Web is the placeable tagged as TRAP_ORIGIN. The spot at which the circle is reported is the either the placed trap or the spawnpoint. <br />
<br />
*Weirdly, although a placed trap already has the ACR_TRAP_SPELL_ID on it, that same trap spawned by a spawnpoint does not, so it has to be added to the spawnpoint itself for the Detect Magic to find it.<br />
<br />
== Disarming Traps ==<br />
Traps are disarmed by using the disarm widget. DM Avatars who do this will immediately and automatically disarm the trap, removing it and the target from the area permanently. If an character uses the disarm target, that character will begin to work on disarming the trap, which will take 12-48 (most likely 30) seconds. During this time the character must remain reasonably stationary and may not carry out other actions, but stepping away from the disarming device will abort the effort.<br />
<br />
Characters with ranks in Disable Device may choose to aid the effort by also using the disarm target, and as many as can physically approach the device may help. Each additional disabler will roll a DC 10 Disable Device check, granting a stacking +2 bonus to the primary disabler's check on success. A character may only attempt to aid in disabling a trap once per primary user's attempt.<br />
<br />
The disarming character will not know ahead of time how long it will take to disarm the trap, nor will he or she know how difficult to disarm the trap will be until attempting to disarm it once.<br />
<br />
At the end of the time required to disarm the trap, a skill check is made against the disarm DC of the trap. If the roll is greater than or equal to the DC to disarm the trap, the trap is removed from play and rendered harmless. If the Disable Device roll fails by 4 or less, then no change is made to the trap. If the Disable Device roll fails by 5 or more, then the effort is botched and the trap is triggered, functioning per the fired trap section, except that the trap disabler is treated as a potential target (possibly the only potential target) for the trap's execution.<br />
<br />
== Triggering Traps ==<br />
When a trap is triggered, its effects are applied to a random creature within the trap's trigger area, and potentially a botched disabler (see above). This effect may cover an area. For example, a trap which explodes in a fireball when triggered may have three people working on disarming it. Should the check be botched anyway while the trigger area is empty, only the primary disabler will be a valid target and he or she will be the center of the resulting explosion. However, the two nearby assistants are likely to be within the blast and to also be injured. If on the other hand the trigger required several people in its area to be triggered, and three were already within, botching the trap has a 1 in 4 chance of centering on each person in the trigger area or the disabler.<br />
<br />
It is possible for traps to trigger with discretion, such as a magical trap that only harms orcs. In this case, only qualifying creatures in the trigger area will be regarded as valid targets. Botching a disable attempt overrides this. A botched disabler is always a valid target, regardless of the trap's specific restrictions.<br />
<br />
== Default Traps ==<br />
By default, every ALFA module has access to a set of standard traps, which are modeled after the default NWN2 traps. All of them have only one charge, do direct damage, and have equal spot, disable, and reflex save DCs. All offer reflex saves when triggered. All are of "medium" trigger size (comparable to the area of a Magic Circle vs. Alignment)<br />
<br />
:{| class="wikitable_standard"<br />
! Name<br />
! Damage<br />
! DC<br />
! Area<br />
|-<br />
| Acid Blob, Minor<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Acid Blob, Average<br />
| 5d6<br />
| 20<br />
| 1 meter<br />
|-<br />
| Acid Blob, Strong<br />
| 12d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Blob, Deadly<br />
| 18d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Splash, Minor<br />
| 2d8<br />
| 12<br />
| 1 meter<br />
|-<br />
| Acid Splash, Average<br />
| 3d8<br />
| 14<br />
| 1 meter<br />
|-<br />
| Acid Splash, Strong<br />
| 5d8<br />
| 17<br />
| 1 meter<br />
|-<br />
| Acid Splash, Deadly<br />
| 8d8<br />
| 20<br />
| 1 meter<br />
|-<br />
| Electrical, Minor<br />
| 8d6<br />
| 19<br />
| 5 meters<br />
|-<br />
| Electrical, Average<br />
| 15d6<br />
| 22<br />
| 5 meters<br />
|-<br />
| Electrical, Strong<br />
| 20d6<br />
| 26<br />
| 5 meters<br />
|-<br />
| Electrical, Deadly<br />
| 30d6<br />
| 28<br />
| 5 meters<br />
|-<br />
| Fire, Minor<br />
| 5d6<br />
| 18<br />
| 2 meters<br />
|-<br />
| Fire, Average<br />
| 8d6<br />
| 20<br />
| 2 meters<br />
|-<br />
| Fire, Strong<br />
| 15d6<br />
| 23<br />
| 4 meters<br />
|-<br />
| Fire, Deadly<br />
| 25d6<br />
| 26<br />
| 4 meters<br />
|-<br />
| Frost, Minor<br />
| 2d4<br />
| 12<br />
| 1 meter<br />
|-<br />
| Frost, Average<br />
| 3d4<br />
| 13<br />
| 1 meter<br />
|-<br />
| Frost, Strong<br />
| 5d4<br />
| 14<br />
| 1 meter<br />
|-<br />
| Frost, Deadly<br />
| 8d4<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Minor<br />
| 2d6<br />
| 12<br />
| 1 meter<br />
|-<br />
| Negative, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Strong<br />
| 5d6<br />
| 18<br />
| 1 meter<br />
|-<br />
| Negative, Deadly<br />
| 8d6<br />
| 21<br />
| 1 meter<br />
|-<br />
| Sonic, Minor<br />
| 2d4<br />
| 12<br />
| 3 meters<br />
|-<br />
| Sonic, Average<br />
| 3d4<br />
| 14<br />
| 3 meters<br />
|-<br />
| Sonic, Strong<br />
| 5d4<br />
| 17<br />
| 3 meters<br />
|-<br />
| Sonic, Deadly<br />
| 8d4<br />
| 20<br />
| 3 meters<br />
|-<br />
| Spike, Minor<br />
| 2d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Strong<br />
| 5d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Deadly<br />
| 25d6<br />
| 15<br />
| 1 meter<br />
|}<br />
<br />
== Tooling Additional Traps ==<br />
Additional traps may be added to a module by creating waypoints which have variables on them which indicate that they are traps. The following variables control the behavior of the trap.<br />
<br />
* '''ACR_TRAP_TRIGGER_AREA''' (integer) -- This variable determines how large the area which is capable of causing the trap to fire is.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Name<br />
! Comparison<br />
|-<br />
| 1<br />
| Small<br />
| Single-Target<br />
|-<br />
| 2<br />
| Medium<br />
| Magic Circle v. Alignment<br />
|-<br />
| 3<br />
| Large<br />
| Entangle<br />
|-<br />
| 4<br />
| Huge<br />
| Fireball<br />
|-<br />
| 5<br />
| Gargantuan<br />
| Lesser Missile Storm<br />
|-<br />
| 6<br />
| Colossal<br />
| Area Dispel Magic<br />
|}<br />
* '''ACR_TRAP_ATTACK_BONUS''' (integer, optional) -- This is the attack bonus that will be used to calculate if a trap is able to damage its target, should no reflex save be defined for the trap. This is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DAMAGE_TYPE''' (bitfield) -- This variable determines what kind of damage will be applied to targets of the trap. As a bitfield, you may take the sum of several damage types to make the trap do multiple types of damage. For example, Piercing Damage (2) and Slashing Damage (4) can be added together to make a piercing/slashing trap (6). This is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Damage Type<br />
|-<br />
| 1<br />
| Bludgeoning<br />
|-<br />
| 2<br />
| Piercing<br />
|-<br />
| 4<br />
| Slashing<br />
|-<br />
| 8<br />
| Magical<br />
|-<br />
| 16<br />
| Acid<br />
|-<br />
| 32<br />
| Cold<br />
|-<br />
| 64<br />
| Divine<br />
|-<br />
| 128<br />
| Electrical<br />
|-<br />
| 256<br />
| Fire<br />
|-<br />
| 512<br />
| Negative<br />
|-<br />
| 1024<br />
| Positive<br />
|-<br />
| 2048<br />
| Sonic<br />
|}<br />
* '''ACR_TRAP_DETECT_DC (integer)''' -- This variable determines what the DC of search checks to discover the trap will be. If this number is greater than 20, the trap will only be discoverable by Rogues.<br />
* '''ACR_TRAP_DICE_NUMBER (integer)''' -- This variable determines how many dice will be rolled to determine trap damage. This is ignored if the trap casts a spell. For example, if this is 3 and ACR_TRAP_DICE_TYPE is 6, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DICE_TYPE (integer)''' -- This variable determines what sort of die will be rolled to determine trap damage. For example, if this is 6, and ACR_TRAP_DICE_NUMBER is 3, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DISARM_DC (integer)''' -- This variable determines what the DC to disarm the trap is.<br />
* '''ACR_TRAP_EFFECT_AREA (integer)''' -- This variable uses the SHAPE_ constants to determine how this trap's effect spreads out, if it has a large enough area to be significant. This setting is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Shape<br />
|-<br />
| 0<br />
| Spell Cyllinder (e.g. Lightning Bolt)<br />
|-<br />
| 1<br />
| Cone (e.g. Burning Hands)<br />
|-<br />
| 2<br />
| Cube (e.g. Order's Wrath)<br />
|-<br />
| 3<br />
| Spell Cone (e.g. Cone of Cold)<br />
|-<br />
| 4<br />
| Sphere (e.g. Fireball)<br />
|}<br />
* '''ACR_TRAP_EFFECT_SIZE''' (float) -- This is the size, in meters, of the effect area defined previously. Cylinders and cones become longer, but remain directional. Cubes gain length on all sides equally. Spheres gain a larger radius. This setting is ignroed if the trap casts a spell.<br />
* '''ACR_TRAP_MINIMUM_TO_TRIGGER''' (integer) -- This is the number of creatures who meet the criteria for a trap's triggering who must be within the trap's trigger area''' (defined above) before the trap will fire.<br />
* '''ACR_TRAP_NUMBER_OF_SHOTS''' (integer) -- This is the number of times the trap will fire before it is discharged. If this number is -1, the trap has infinite charges, and will fire until disarmed.<br />
* '''ACR_TRAP_SAVE_DC''' (integer) -- This is the reflex save DC of the trap. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- This is the ID of the spell that is cast. If this is -1 or if it is absent, the trap will not be regarded as spell casting, and will instead resolve to do damage. If this option is set, the trap must be placed or spawned near a placeable with the tag "TRAP_ORIGIN." In the absence of this placeable, the trap trigger will attempt to-- and typically fail to-- cast the spell itself.<br />
* '''ACR_TRAP_TARGET_ALIGNMENT''' (integer) -- This setting determines which alignments are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other alignments. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Alignment<br />
|-<br />
| 0<br />
| All Alignments<br />
|-<br />
| 1<br />
| Neutral Alignments<br />
|-<br />
| 2<br />
| Lawful Alignments<br />
|-<br />
| 3<br />
| Chaotic Alignments<br />
|-<br />
| 4<br />
| Good Alignments<br />
|-<br />
| 5<br />
| Evil Alignments<br />
|}<br />
* '''ACR_TRAP_TARGET_RACE''' (integer) -- This setting determins which racial types are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other races. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Race<br />
|-<br />
| 0<br />
| Dwarf<br />
|-<br />
| 1<br />
| Elf<br />
|-<br />
| 2<br />
| Gnome<br />
|-<br />
| 3<br />
| Halfling<br />
|-<br />
| 4<br />
| Half-Elf<br />
|-<br />
| 5<br />
| Half-Orc<br />
|-<br />
| 6<br />
| Human<br />
|-<br />
| 7<br />
| Abberations<br />
|-<br />
| 8<br />
| Animals<br />
|-<br />
| 9<br />
| Beasts (depreciated)<br />
|-<br />
| 10<br />
| Constructs<br />
|-<br />
| 11<br />
| Dragons<br />
|-<br />
| 12<br />
| Goblinoids<br />
|-<br />
| 13<br />
| Monstrous Humanoids<br />
|-<br />
| 14<br />
| Orcs<br />
|-<br />
| 15<br />
| Reptilian Humanoids<br />
|-<br />
| 16<br />
| Elementals<br />
|-<br />
| 17<br />
| Fey<br />
|-<br />
| 18<br />
| Giants<br />
|-<br />
| 19<br />
| Magical Beasts<br />
|-<br />
| 20<br />
| Outsiders<br />
|-<br />
| 24<br />
| Undead<br />
|-<br />
| 25<br />
| Vermin<br />
|-<br />
| '''28'''<br />
| '''All Races'''<br />
|-<br />
| 29<br />
| Oozes<br />
|-<br />
| 30<br />
| Incorporeal (depreciated)<br />
|-<br />
| 31<br />
| Yuan-Ti<br />
|}<br />
* '''ACR_TRAP_DESCRIPTION''' (string) -- This setting determines what the descriptive text on the trap's disarm target will read when examined with the default "examine" command. While it may contain any arbitrary information deemed useful by the builders, it is recommended that it contain a description of what a person would see of this trap upon discovering it.<br />
<br />
== Spawning Traps ==<br />
ACR Traps are currently able to be spawned through the [[ACR Creator]], and may also be placed using the ACR Spawn System, with object type 8.<br />
<br />
In order to spawn a trap, you must first tool the trap, according to the instructions above, and then use the resource name of the waypoint used to tool the trap as the resource name of the trap on the spawn point. In addition, for the trap to register to Detect Magic, to this spawnpoint add the variable: ACR_TRAP_SPELL_ID. Enter the spell integer into the integer slot. <br />
<br />
In all other respects, these spawn points work as any other spawn point.<br />
<br />
In addition, you may place a placeable with the tag "TRAP_ORIGIN" near any trap trigger and it will be regarded as the source for all effects which are created by the trap. This has two uses:<br />
* Animations that involve projectiles will show the trap's effect being shot from the trap origin<br />
* The trap may be used in the spell trap mode (as placeables are allowed to cast spells in the NWN2 engine, but triggers are not).<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=ACR_Traps&diff=3982ACR Traps2023-02-01T14:22:15Z<p>Wynna: /* Tooling Additional Traps */</p>
<hr />
<div>[[Category:ACR Tools]]<br />
[[Category:DM Guides]]<br />
The ACR has in its core content a custom implementation of traps that is meant to serve as a workaround for the severe limitations imposed by traps as they are implemented by [[Neverwinter Nights 2 | NWN2]]. These traps are capable of spawning and despawning, are aware of their own shapes and sizes, and can control whether or not they trigger by a number of conditions, including those which we would associate with spellcasting traps.<br />
<br />
== Detecting Traps ==<br />
A search roll is automatically rolled, with the fact that the roll was made being hidden, whenever a character approaches a trap with detect mode on. If the result of the search check is greater than or equal to the search DC, the trap is detected. There is a special exception made for high-DC traps: only rogues, or people under the effects of a Find Traps spell, may find traps with a search DC greater than 20. If a character does not expend the trap (for example, by triggering it until it runs out of ammunition or charges), but remains near it, an additional roll will be made every six seconds, and every PC near the trap will also get rolls.<br />
<br />
When a trap is detected, the character whose check revealed the trap will gain a visual effect overhead that indicates responsibility for the detection. In addition, the trap will become visible as a pulsing red VFX in the shape of the trap on the ground, and finally a disarm target object will appear on the ground where the detector was standing when the trap was revealed.<br />
: '''It is important to note that traps are invisible to DMs once they are spawned. The tick in the spawning UI when placing a trap is the indication that the spawning has happened.'''<br />
<br />
== Detect Magic ==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Spell_Traps Detect Magic: Spell Traps]<br />
<br />
Detect Magic will work automatically with a placed spell trap or a spell trap spawnpoint with a variable added to it called ACR_TRAP_SPELL_ID which contains the integer of the spell ID.* As with any ACR_Trap, either option requires a placeable tagged as TRAP_ORIGIN nearby, also.<br />
<br />
Detect Magic uses ACR_TRAP_SPELL_ID (already on a placed trap or added to the spawnpoint) to cross-reference spell effects against 2DA information. From the 2DA it pulls the proper school and spell power to put into the report to the Caster. For instance, for a Web Trap: "Spider Web and a circle centered on a spot 1m southwest of Spider Web gives off a Moderate aura of Conjuration." Spider Web is the placeable tagged as TRAP_ORIGIN. The spot at which the circle is reported is the either the placed trap or the spawnpoint. <br />
<br />
*Weirdly, although a placed trap already has the ACR_TRAP_SPELL_ID on it, that same trap spawned by a spawnpoint does not, so it has to be added to the spawnpoint itself for the Detect Magic to find it.<br />
<br />
== Disarming Traps ==<br />
Traps are disarmed by using the disarm widget. DM Avatars who do this will immediately and automatically disarm the trap, removing it and the target from the area permanently. If an character uses the disarm target, that character will begin to work on disarming the trap, which will take 12-48 (most likely 30) seconds. During this time the character must remain reasonably stationary and may not carry out other actions, but stepping away from the disarming device will abort the effort.<br />
<br />
Characters with ranks in Disable Device may choose to aid the effort by also using the disarm target, and as many as can physically approach the device may help. Each additional disabler will roll a DC 10 Disable Device check, granting a stacking +2 bonus to the primary disabler's check on success. A character may only attempt to aid in disabling a trap once per primary user's attempt.<br />
<br />
The disarming character will not know ahead of time how long it will take to disarm the trap, nor will he or she know how difficult to disarm the trap will be until attempting to disarm it once.<br />
<br />
At the end of the time required to disarm the trap, a skill check is made against the disarm DC of the trap. If the roll is greater than or equal to the DC to disarm the trap, the trap is removed from play and rendered harmless. If the Disable Device roll fails by 4 or less, then no change is made to the trap. If the Disable Device roll fails by 5 or more, then the effort is botched and the trap is triggered, functioning per the fired trap section, except that the trap disabler is treated as a potential target (possibly the only potential target) for the trap's execution.<br />
<br />
== Triggering Traps ==<br />
When a trap is triggered, its effects are applied to a random creature within the trap's trigger area, and potentially a botched disabler (see above). This effect may cover an area. For example, a trap which explodes in a fireball when triggered may have three people working on disarming it. Should the check be botched anyway while the trigger area is empty, only the primary disabler will be a valid target and he or she will be the center of the resulting explosion. However, the two nearby assistants are likely to be within the blast and to also be injured. If on the other hand the trigger required several people in its area to be triggered, and three were already within, botching the trap has a 1 in 4 chance of centering on each person in the trigger area or the disabler.<br />
<br />
It is possible for traps to trigger with discretion, such as a magical trap that only harms orcs. In this case, only qualifying creatures in the trigger area will be regarded as valid targets. Botching a disable attempt overrides this. A botched disabler is always a valid target, regardless of the trap's specific restrictions.<br />
<br />
== Default Traps ==<br />
By default, every ALFA module has access to a set of standard traps, which are modeled after the default NWN2 traps. All of them have only one charge, do direct damage, and have equal spot, disable, and reflex save DCs. All offer reflex saves when triggered. All are of "medium" trigger size (comparable to the area of a Magic Circle vs. Alignment)<br />
<br />
:{| class="wikitable_standard"<br />
! Name<br />
! Damage<br />
! DC<br />
! Area<br />
|-<br />
| Acid Blob, Minor<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Acid Blob, Average<br />
| 5d6<br />
| 20<br />
| 1 meter<br />
|-<br />
| Acid Blob, Strong<br />
| 12d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Blob, Deadly<br />
| 18d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Splash, Minor<br />
| 2d8<br />
| 12<br />
| 1 meter<br />
|-<br />
| Acid Splash, Average<br />
| 3d8<br />
| 14<br />
| 1 meter<br />
|-<br />
| Acid Splash, Strong<br />
| 5d8<br />
| 17<br />
| 1 meter<br />
|-<br />
| Acid Splash, Deadly<br />
| 8d8<br />
| 20<br />
| 1 meter<br />
|-<br />
| Electrical, Minor<br />
| 8d6<br />
| 19<br />
| 5 meters<br />
|-<br />
| Electrical, Average<br />
| 15d6<br />
| 22<br />
| 5 meters<br />
|-<br />
| Electrical, Strong<br />
| 20d6<br />
| 26<br />
| 5 meters<br />
|-<br />
| Electrical, Deadly<br />
| 30d6<br />
| 28<br />
| 5 meters<br />
|-<br />
| Fire, Minor<br />
| 5d6<br />
| 18<br />
| 2 meters<br />
|-<br />
| Fire, Average<br />
| 8d6<br />
| 20<br />
| 2 meters<br />
|-<br />
| Fire, Strong<br />
| 15d6<br />
| 23<br />
| 4 meters<br />
|-<br />
| Fire, Deadly<br />
| 25d6<br />
| 26<br />
| 4 meters<br />
|-<br />
| Frost, Minor<br />
| 2d4<br />
| 12<br />
| 1 meter<br />
|-<br />
| Frost, Average<br />
| 3d4<br />
| 13<br />
| 1 meter<br />
|-<br />
| Frost, Strong<br />
| 5d4<br />
| 14<br />
| 1 meter<br />
|-<br />
| Frost, Deadly<br />
| 8d4<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Minor<br />
| 2d6<br />
| 12<br />
| 1 meter<br />
|-<br />
| Negative, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Strong<br />
| 5d6<br />
| 18<br />
| 1 meter<br />
|-<br />
| Negative, Deadly<br />
| 8d6<br />
| 21<br />
| 1 meter<br />
|-<br />
| Sonic, Minor<br />
| 2d4<br />
| 12<br />
| 3 meters<br />
|-<br />
| Sonic, Average<br />
| 3d4<br />
| 14<br />
| 3 meters<br />
|-<br />
| Sonic, Strong<br />
| 5d4<br />
| 17<br />
| 3 meters<br />
|-<br />
| Sonic, Deadly<br />
| 8d4<br />
| 20<br />
| 3 meters<br />
|-<br />
| Spike, Minor<br />
| 2d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Strong<br />
| 5d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Deadly<br />
| 25d6<br />
| 15<br />
| 1 meter<br />
|}<br />
<br />
== Tooling Additional Traps ==<br />
Additional traps may be added to a module by creating waypoints which have variables on them which indicate that they are traps. The following variables control the behavior of the trap.<br />
<br />
* '''ACR_TRAP_TRIGGER_AREA''' (integer) -- This variable determines how large the area which is capable of causing the trap to fire is.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Name<br />
! Comparison<br />
|-<br />
| 1<br />
| Small<br />
| Single-Target<br />
|-<br />
| 2<br />
| Medium<br />
| Magic Circle v. Alignment<br />
|-<br />
| 3<br />
| Large<br />
| Entangle<br />
|-<br />
| 4<br />
| Huge<br />
| Fireball<br />
|-<br />
| 5<br />
| Gargantuan<br />
| Lesser Missile Storm<br />
|-<br />
| 6<br />
| Colossal<br />
| Area Dispel Magic<br />
|}<br />
* '''ACR_TRAP_ATTACK_BONUS''' (integer, optional) -- This is the attack bonus that will be used to calculate if a trap is able to damage its target, should no reflex save be defined for the trap. This is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DAMAGE_TYPE''' (bitfield) -- This variable determines what kind of damage will be applied to targets of the trap. As a bitfield, you may take the sum of several damage types to make the trap do multiple types of damage. For example, Piercing Damage (2) and Slashing Damage (4) can be added together to make a piercing/slashing trap (6). This is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Damage Type<br />
|-<br />
| 1<br />
| Bludgeoning<br />
|-<br />
| 2<br />
| Piercing<br />
|-<br />
| 4<br />
| Slashing<br />
|-<br />
| 8<br />
| Magical<br />
|-<br />
| 16<br />
| Acid<br />
|-<br />
| 32<br />
| Cold<br />
|-<br />
| 64<br />
| Divine<br />
|-<br />
| 128<br />
| Electrical<br />
|-<br />
| 256<br />
| Fire<br />
|-<br />
| 512<br />
| Negative<br />
|-<br />
| 1024<br />
| Positive<br />
|-<br />
| 2048<br />
| Sonic<br />
|}<br />
* '''ACR_TRAP_DETECT_DC''' (integer)''' -- This variable determines what the DC of search checks to discover the trap will be. If this number is greater than 20, the trap will only be discoverable by Rogues.<br />
* '''ACR_TRAP_DICE_NUMBER (integer)''' -- This variable determines how many dice will be rolled to determine trap damage. This is ignored if the trap casts a spell. For example, if this is 3 and * '''ACR_TRAP_DICE_TYPE''' is 6, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DICE_TYPE (integer)''' -- This variable determines what sort of die will be rolled to determine trap damage. For example, if this is 6, and * '''ACR_TRAP_DICE_NUMBER''' is 3, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DISARM_DC (integer)''' -- This variable determines what the DC to disarm the trap is.<br />
* '''ACR_TRAP_EFFECT_AREA''' (integer)''' -- This variable uses the SHAPE_ constants to determine how this trap's effect spreads out, if it has a large enough area to be significant. This setting is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Shape<br />
|-<br />
| 0<br />
| Spell Cyllinder (e.g. Lightning Bolt)<br />
|-<br />
| 1<br />
| Cone (e.g. Burning Hands)<br />
|-<br />
| 2<br />
| Cube (e.g. Order's Wrath)<br />
|-<br />
| 3<br />
| Spell Cone (e.g. Cone of Cold)<br />
|-<br />
| 4<br />
| Sphere (e.g. Fireball)<br />
|}<br />
* '''ACR_TRAP_EFFECT_SIZE''' (float) -- This is the size, in meters, of the effect area defined previously. Cylinders and cones become longer, but remain directional. Cubes gain length on all sides equally. Spheres gain a larger radius. This setting is ignroed if the trap casts a spell.<br />
* '''ACR_TRAP_MINIMUM_TO_TRIGGER''' (integer) -- This is the number of creatures who meet the criteria for a trap's triggering who must be within the trap's trigger area''' (defined above) before the trap will fire.<br />
* '''ACR_TRAP_NUMBER_OF_SHOTS''' (integer) -- This is the number of times the trap will fire before it is discharged. If this number is -1, the trap has infinite charges, and will fire until disarmed.<br />
* '''ACR_TRAP_SAVE_DC''' (integer) -- This is the reflex save DC of the trap. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- This is the ID of the spell that is cast. If this is -1 or if it is absent, the trap will not be regarded as spell casting, and will instead resolve to do damage. If this option is set, the trap must be placed or spawned near a placeable with the tag "TRAP_ORIGIN." In the absence of this placeable, the trap trigger will attempt to-- and typically fail to-- cast the spell itself.<br />
* '''ACR_TRAP_TARGET_ALIGNMENT''' (integer) -- This setting determines which alignments are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other alignments. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Alignment<br />
|-<br />
| 0<br />
| All Alignments<br />
|-<br />
| 1<br />
| Neutral Alignments<br />
|-<br />
| 2<br />
| Lawful Alignments<br />
|-<br />
| 3<br />
| Chaotic Alignments<br />
|-<br />
| 4<br />
| Good Alignments<br />
|-<br />
| 5<br />
| Evil Alignments<br />
|}<br />
* '''ACR_TRAP_TARGET_RACE''' (integer) -- This setting determins which racial types are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other races. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Race<br />
|-<br />
| 0<br />
| Dwarf<br />
|-<br />
| 1<br />
| Elf<br />
|-<br />
| 2<br />
| Gnome<br />
|-<br />
| 3<br />
| Halfling<br />
|-<br />
| 4<br />
| Half-Elf<br />
|-<br />
| 5<br />
| Half-Orc<br />
|-<br />
| 6<br />
| Human<br />
|-<br />
| 7<br />
| Abberations<br />
|-<br />
| 8<br />
| Animals<br />
|-<br />
| 9<br />
| Beasts (depreciated)<br />
|-<br />
| 10<br />
| Constructs<br />
|-<br />
| 11<br />
| Dragons<br />
|-<br />
| 12<br />
| Goblinoids<br />
|-<br />
| 13<br />
| Monstrous Humanoids<br />
|-<br />
| 14<br />
| Orcs<br />
|-<br />
| 15<br />
| Reptilian Humanoids<br />
|-<br />
| 16<br />
| Elementals<br />
|-<br />
| 17<br />
| Fey<br />
|-<br />
| 18<br />
| Giants<br />
|-<br />
| 19<br />
| Magical Beasts<br />
|-<br />
| 20<br />
| Outsiders<br />
|-<br />
| 24<br />
| Undead<br />
|-<br />
| 25<br />
| Vermin<br />
|-<br />
| '''28'''<br />
| '''All Races'''<br />
|-<br />
| 29<br />
| Oozes<br />
|-<br />
| 30<br />
| Incorporeal (depreciated)<br />
|-<br />
| 31<br />
| Yuan-Ti<br />
|}<br />
* '''ACR_TRAP_DESCRIPTION''' (string) -- This setting determines what the descriptive text on the trap's disarm target will read when examined with the default "examine" command. While it may contain any arbitrary information deemed useful by the builders, it is recommended that it contain a description of what a person would see of this trap upon discovering it.<br />
<br />
== Spawning Traps ==<br />
ACR Traps are currently able to be spawned through the [[ACR Creator]], and may also be placed using the ACR Spawn System, with object type 8.<br />
<br />
In order to spawn a trap, you must first tool the trap, according to the instructions above, and then use the resource name of the waypoint used to tool the trap as the resource name of the trap on the spawn point. In addition, for the trap to register to Detect Magic, to this spawnpoint add the variable: ACR_TRAP_SPELL_ID. Enter the spell integer into the integer slot. <br />
<br />
In all other respects, these spawn points work as any other spawn point.<br />
<br />
In addition, you may place a placeable with the tag "TRAP_ORIGIN" near any trap trigger and it will be regarded as the source for all effects which are created by the trap. This has two uses:<br />
* Animations that involve projectiles will show the trap's effect being shot from the trap origin<br />
* The trap may be used in the spell trap mode (as placeables are allowed to cast spells in the NWN2 engine, but triggers are not).<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3981Building Placeables2023-02-01T13:44:32Z<p>Wynna: /* Detect Magic - General */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.<br />
<br />
= Detect Magic - General =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
=Special Placeables=<br />
==Portals==<br />
===Building===<br />
See [[Portals]]<br />
===Detect Magic===<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Glyphs and Symbol Traps==<br />
===Detect Magic===<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3980Building Placeables2023-02-01T13:44:00Z<p>Wynna: /* Portals */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.<br />
<br />
= Detect Magic - General =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
=Special Placeables <br />
==Portals==<br />
===Building===<br />
See [[Portals]]<br />
===Detect Magic===<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Glyphs and Symbol Traps==<br />
===Detect Magic===<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3979Building Placeables2023-02-01T13:42:11Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.<br />
<br />
= Detect Magic - General =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
=Portals=<br />
==Building==<br />
See [[Portals]]<br />
==Detect Magic==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3978Building Placeables2023-02-01T13:41:36Z<p>Wynna: /* Portals */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
=Portals=<br />
==Building==<br />
See [[Portals]]<br />
==Detect Magic==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3977Building Placeables2023-02-01T13:39:34Z<p>Wynna: /* Detecting Portals */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
==Portals==<br />
===Building===<br />
See [[Portals]]<br />
===Detect Magic===<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3976Portals2023-02-01T13:37:11Z<p>Wynna: /* Building IC Portals */</p>
<hr />
<div>=Building IC Portals=<br />
Not to be confused with Server Portals: [[Building Portals]]<br />
<br />
An IC portal can be a placeable, a trigger, or a door. In order for the spell [[Analyze Portal]] to work correctly ingame, portals must be set up with the following properties:<br />
<br />
<br />
*'''Tag''' -- The tag must start with the alfa_portal prefix: "alfa_portal_". The rest of the tag can be whatever you want.<br />
<br />
*'''PORTAL_LOCATION''' (string) -- A description of the area where the portal is located.<br />
*'''PORTAL_COMMAND''' (string) -- Any key or command needed to activate the portal<br />
*'''PORTAL_CIRCUMSTANCE''' (string) -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''PORTAL_DIRECTION''' (string) -- Whether the portal is one-way or two-way.<br />
*'''PORTAL_PROPERTIES''' (string) -- Any unusual properties<br />
*'''PORTAL_DESTINATION''' (string) -- A description of the immediate area where the portal leads<br />
*'''PORTAL_FUNCTIONALITY''' (string) -- Whether the portal is functioning correctly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3975Portals2023-02-01T13:36:52Z<p>Wynna: /* Building IC Portals */</p>
<hr />
<div>=Building IC Portals=<br />
Not to be confused with Server Portals: [[Building Portals]]<br />
<br />
An IC portal can be a placeable, a trigger, or a door. In order for the spell [[Analyze Portal]] to work correctly ingame, portals must be set up with the following properties.<br />
<br />
<br />
*'''Tag''' -- The tag must start with the alfa_portal prefix: "alfa_portal_". The rest of the tag can be whatever you want.<br />
<br />
*'''PORTAL_LOCATION''' (string) -- A description of the area where the portal is located.<br />
*'''PORTAL_COMMAND''' (string) -- Any key or command needed to activate the portal<br />
*'''PORTAL_CIRCUMSTANCE''' (string) -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''PORTAL_DIRECTION''' (string) -- Whether the portal is one-way or two-way.<br />
*'''PORTAL_PROPERTIES''' (string) -- Any unusual properties<br />
*'''PORTAL_DESTINATION''' (string) -- A description of the immediate area where the portal leads<br />
*'''PORTAL_FUNCTIONALITY''' (string) -- Whether the portal is functioning correctly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3974Portals2023-02-01T13:36:34Z<p>Wynna: /* Building Portals */</p>
<hr />
<div>=Building IC Portals=<br />
Not to be confused with Server Portals: [[Building Portals]]<br />
A portal can be a placeable, a trigger, or a door. In order for the spell [[Analyze Portal]] to work correctly ingame, portals must be set up with the following properties.<br />
<br />
<br />
*'''Tag''' -- The tag must start with the alfa_portal prefix: "alfa_portal_". The rest of the tag can be whatever you want.<br />
<br />
*'''PORTAL_LOCATION''' (string) -- A description of the area where the portal is located.<br />
*'''PORTAL_COMMAND''' (string) -- Any key or command needed to activate the portal<br />
*'''PORTAL_CIRCUMSTANCE''' (string) -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''PORTAL_DIRECTION''' (string) -- Whether the portal is one-way or two-way.<br />
*'''PORTAL_PROPERTIES''' (string) -- Any unusual properties<br />
*'''PORTAL_DESTINATION''' (string) -- A description of the immediate area where the portal leads<br />
*'''PORTAL_FUNCTIONALITY''' (string) -- Whether the portal is functioning correctly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3973Portals2023-02-01T13:35:19Z<p>Wynna: </p>
<hr />
<div>=Building Portals=<br />
A portal can be a placeable, a trigger, or a door. In order for the spell [[Analyze Portal]] to work correctly ingame, portals must be set up with the following properties.<br />
<br />
<br />
*'''Tag''' -- The tag must start with the alfa_portal prefix: "alfa_portal_". The rest of the tag can be whatever you want.<br />
<br />
*'''PORTAL_LOCATION''' (string) -- A description of the area where the portal is located.<br />
*'''PORTAL_COMMAND''' (string) -- Any key or command needed to activate the portal<br />
*'''PORTAL_CIRCUMSTANCE''' (string) -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''PORTAL_DIRECTION''' (string) -- Whether the portal is one-way or two-way.<br />
*'''PORTAL_PROPERTIES''' (string) -- Any unusual properties<br />
*'''PORTAL_DESTINATION''' (string) -- A description of the immediate area where the portal leads<br />
*'''PORTAL_FUNCTIONALITY''' (string) -- Whether the portal is functioning correctly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Analyze_Portal&diff=3972Analyze Portal2023-02-01T13:31:00Z<p>Wynna: /* Analyze Portal */</p>
<hr />
<div>=Analyze Portal=<br />
<br />
The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to another 6 rounds, to learn information about the portal. Failing any caster level check ends the spell. Properties of the portal are discovered in this order:<br />
<br />
*'''Portal Command''' -- Any key or command needed to activate the portal<br />
*'''Portal Circumstances''' -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''Portal Direction''' -- Whether the portal is one-way or two-way<br />
*'''Portal Properties''' -- Any unusual properties<br />
*'''Portal Destination''' -- A description of the immediate area where the portal leads<br />
*'''Portal Functionality''' -- Whether the portal is functioning properly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Analyze_Portal&diff=3971Analyze Portal2023-02-01T13:30:47Z<p>Wynna: /* Analyze Portal */</p>
<hr />
<div>=Analyze Portal=<br />
<br />
The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to another 6 rounds, to learn information about the portal. Failing any caster level check ends the spell. Properties of the portal are discovered in this order:<br />
<br />
*'''Portal Command''' -- Any key or command needed to activate the portal<br />
*'''Portal Circumstances''' -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''Portal Direction''' Whether the portal is one-way or two-way<br />
*'''Portal Properties''' -- Any unusual properties<br />
*'''Portal Destination''' -- A description of the immediate area where the portal leads<br />
*'''Portal Functionality''' -- Whether the portal is functioning properly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3970Portals2023-02-01T13:27:50Z<p>Wynna: /* Building Portals */</p>
<hr />
<div>=Analyze Portal=<br />
<br />
The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to another 6 rounds, to learn information about the portal. Failing any caster level check ends the spell. Properties of the portal are discovered in this order:<br />
<br />
*'''Portal Command'''* -- Any key or command needed to activate the portal<br />
*'''Portal Circumstances'''* -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''Portal Direction'''* Whether the portal is one-way or two-way<br />
*'''Portal Properties'''* -- Any unusual properties<br />
*'''Portal Destination'''* -- A description of the immediate area where the portal leads<br />
*'''Portal Functionality'''* -- Whether the portal is functioning properly<br />
<br />
=Building Portals=<br />
In order for the spell [[Analyze Portal]] to work correctly ingame, portals must be set up with the following variables.<br />
<br />
<br />
PORTAL_LOCATION<br />
PORTAL_COMMAND<br />
PORTAL_CIRCUMSTANCE<br />
PORTAL_DIRECTION<br />
PORTAL_PROPERTIES<br />
PORTAL_DESTINATION<br />
PORTAL_FUNCTIONALITY</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Analyze_Portal&diff=3969Analyze Portal2023-02-01T13:25:08Z<p>Wynna: Created page with "=Analyze Portal= The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to..."</p>
<hr />
<div>=Analyze Portal=<br />
<br />
The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to another 6 rounds, to learn information about the portal. Failing any caster level check ends the spell. Properties of the portal are discovered in this order:<br />
<br />
*'''Portal Command'''* -- Any key or command needed to activate the portal<br />
*'''Portal Circumstances'''* -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''Portal Direction'''* Whether the portal is one-way or two-way<br />
*'''Portal Properties'''* -- Any unusual properties<br />
*'''Portal Destination'''* -- A description of the immediate area where the portal leads<br />
*'''Portal Functionality'''* -- Whether the portal is functioning properly</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3968Portals2023-02-01T13:23:43Z<p>Wynna: /* Analyze Portal= */</p>
<hr />
<div>=Analyze Portal=<br />
<br />
The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to another 6 rounds, to learn information about the portal. Failing any caster level check ends the spell. Properties of the portal are discovered in this order:<br />
<br />
*'''Portal Command'''* -- Any key or command needed to activate the portal<br />
*'''Portal Circumstances'''* -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''Portal Direction'''* Whether the portal is one-way or two-way<br />
*'''Portal Properties'''* -- Any unusual properties<br />
*'''Portal Destination'''* -- A description of the immediate area where the portal leads<br />
*'''Portal Functionality'''* -- Whether the portal is functioning properly<br />
<br />
=Building Portals=<br />
string sPortalLocation = GetLocalString(oPortal, "PORTAL_LOCATION");<br />
string sPortalCommand = GetLocalString(oPortal, "PORTAL_COMMAND");<br />
string sPortalCirc = GetLocalString(oPortal, "PORTAL_CIRCUMSTANCE");<br />
string sPortalDirection = GetLocalString(oPortal, "PORTAL_DIRECTION");<br />
string sPortalProps = GetLocalString(oPortal, "PORTAL_PROPERTIES");<br />
string sPortalDest = GetLocalString(oPortal, "PORTAL_DESTINATION");<br />
string sPortalFunc = GetLocalString(oPortal, "PORTAL_FUNCTIONALITY");<br />
string sPortalCompassDirection = GetCompassDirectionOfAngle(fAnglePortalFromCaster);<br />
string sPortalDistance = GetDisplayableDistance(GetDistanceBetween(oCaster, oPortal));</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3967Portals2023-02-01T13:23:31Z<p>Wynna: </p>
<hr />
<div>=Analyze Portal==<br />
<br />
The Caster can tell if a 20 foot sphere contains a magic portal. After the first round, Caster is given a caster level check (d20 + CL) each round, for up to another 6 rounds, to learn information about the portal. Failing any caster level check ends the spell. Properties of the portal are discovered in this order:<br />
<br />
*'''Portal Command'''* -- Any key or command needed to activate the portal<br />
*'''Portal Circumstances'''* -- Any special circumstances governing the portal's use (such as specific times when the portal can be activated)<br />
*'''Portal Direction'''* Whether the portal is one-way or two-way<br />
*'''Portal Properties'''* -- Any unusual properties<br />
*'''Portal Destination'''* -- A description of the immediate area where the portal leads<br />
*'''Portal Functionality'''* -- Whether the portal is functioning properly<br />
<br />
=Building Portals=<br />
string sPortalLocation = GetLocalString(oPortal, "PORTAL_LOCATION");<br />
string sPortalCommand = GetLocalString(oPortal, "PORTAL_COMMAND");<br />
string sPortalCirc = GetLocalString(oPortal, "PORTAL_CIRCUMSTANCE");<br />
string sPortalDirection = GetLocalString(oPortal, "PORTAL_DIRECTION");<br />
string sPortalProps = GetLocalString(oPortal, "PORTAL_PROPERTIES");<br />
string sPortalDest = GetLocalString(oPortal, "PORTAL_DESTINATION");<br />
string sPortalFunc = GetLocalString(oPortal, "PORTAL_FUNCTIONALITY");<br />
string sPortalCompassDirection = GetCompassDirectionOfAngle(fAnglePortalFromCaster);<br />
string sPortalDistance = GetDisplayableDistance(GetDistanceBetween(oCaster, oPortal));</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Portals&diff=3966Building Portals2023-02-01T13:08:30Z<p>Wynna: /* IC Portals */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
=Server Portals=<br />
Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA.<br />
<br />
Simply put, a portal (not to be confused with other [[Portals]])) is a method of traveling between ALFA servers.<br />
<br />
== Scripts ==<br />
A portal event may be initialized in either the <code>'''OnClick'''</code> or <code>'''OnUsed'''</code> events. Set either script to use or call [[acr_trg_portalstart.nss]].<br />
<br />
Remaining scripts should be the default acr_* scripts for the portal object type. See [[Building Placeables]] or [[Building Triggers]] for details on how to configure those.<br />
<br />
== Waypoints ==<br />
The destination of a cross-server portal is always a waypoint.<br />
<br />
Create a [[Waypoint]] with a [[Tag]] of the form <code>'''<SourceServerId>_PortalTo_<DestinationServerId>_<PortalNumber>'''</code>, where the <code>'''ServerIds'''</code> are 3 digit integers, and the <code>'''PortalNumber'''</code> is a 2 digit integer.<br />
: ''Example: For the arrival waypoint of a portal from [[Baldur's Gate (Server) | Baldur's Gate]] (Server ID 010) to [[The Silver Marches (Server) | The Silver Marches]] (Server ID 003), the first such arrival waypoint is given the tag: <code>'''010_PortalTo_003_01'''</code><br />
<br />
== Customizing Portals ==<br />
: ''See also: [[Using Local Variables]]''<br />
The following two variables are required for the portal to function.<br />
* <code>'''ACR_PORTAL_DEST_SERVER'''</code> (int) -- Must be set to the destination server ID.<br />
*: ''Example: <code>'''int ACR_PORTAL_DEST_SERVER = 10'''</code> to travel to Baldur's Gate.''<br />
* <code>'''ACR_PORTAL_NUM'''</code> (int) -- The unique ID (for the destination server) of the destination waypoint.<br />
*: ''Example: <code>'''int ACR_PORTAL_NUM = 1'''</code> may put you at the docks, while <code>'''int ACR_PORTAL_NUM = 2'''</code> may put you at the transition between the [[Western Heartlands (Server) | Western Heartlands]] and [[Tempest's Tears]].''<br />
<br />
The following options are optional.<br />
* <code>'''ACR_PORTAL_DEST_ADJACENT'''</code> (int) -- If set to <code>1</code>, the 24-hour portal cooldown will be disabled.<br />
<br />
=IC Portals= <br />
<br />
See Building IC [https://www.alandfaraway.info/wiki/Portals Portals]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Portals&diff=3965Building Portals2023-02-01T13:07:39Z<p>Wynna: /* IC Portals */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
=Server Portals=<br />
Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA.<br />
<br />
Simply put, a portal (not to be confused with other [[Portals]])) is a method of traveling between ALFA servers.<br />
<br />
== Scripts ==<br />
A portal event may be initialized in either the <code>'''OnClick'''</code> or <code>'''OnUsed'''</code> events. Set either script to use or call [[acr_trg_portalstart.nss]].<br />
<br />
Remaining scripts should be the default acr_* scripts for the portal object type. See [[Building Placeables]] or [[Building Triggers]] for details on how to configure those.<br />
<br />
== Waypoints ==<br />
The destination of a cross-server portal is always a waypoint.<br />
<br />
Create a [[Waypoint]] with a [[Tag]] of the form <code>'''<SourceServerId>_PortalTo_<DestinationServerId>_<PortalNumber>'''</code>, where the <code>'''ServerIds'''</code> are 3 digit integers, and the <code>'''PortalNumber'''</code> is a 2 digit integer.<br />
: ''Example: For the arrival waypoint of a portal from [[Baldur's Gate (Server) | Baldur's Gate]] (Server ID 010) to [[The Silver Marches (Server) | The Silver Marches]] (Server ID 003), the first such arrival waypoint is given the tag: <code>'''010_PortalTo_003_01'''</code><br />
<br />
== Customizing Portals ==<br />
: ''See also: [[Using Local Variables]]''<br />
The following two variables are required for the portal to function.<br />
* <code>'''ACR_PORTAL_DEST_SERVER'''</code> (int) -- Must be set to the destination server ID.<br />
*: ''Example: <code>'''int ACR_PORTAL_DEST_SERVER = 10'''</code> to travel to Baldur's Gate.''<br />
* <code>'''ACR_PORTAL_NUM'''</code> (int) -- The unique ID (for the destination server) of the destination waypoint.<br />
*: ''Example: <code>'''int ACR_PORTAL_NUM = 1'''</code> may put you at the docks, while <code>'''int ACR_PORTAL_NUM = 2'''</code> may put you at the transition between the [[Western Heartlands (Server) | Western Heartlands]] and [[Tempest's Tears]].''<br />
<br />
The following options are optional.<br />
* <code>'''ACR_PORTAL_DEST_ADJACENT'''</code> (int) -- If set to <code>1</code>, the 24-hour portal cooldown will be disabled.<br />
<br />
=IC Portals= <br />
<br />
See Building IC Portals</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Portals&diff=3964Building Portals2023-02-01T13:06:57Z<p>Wynna: </p>
<hr />
<div>[[Category:Technical Manuals]]<br />
=Server Portals=<br />
Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA.<br />
<br />
Simply put, a portal (not to be confused with other [[Portals]])) is a method of traveling between ALFA servers.<br />
<br />
== Scripts ==<br />
A portal event may be initialized in either the <code>'''OnClick'''</code> or <code>'''OnUsed'''</code> events. Set either script to use or call [[acr_trg_portalstart.nss]].<br />
<br />
Remaining scripts should be the default acr_* scripts for the portal object type. See [[Building Placeables]] or [[Building Triggers]] for details on how to configure those.<br />
<br />
== Waypoints ==<br />
The destination of a cross-server portal is always a waypoint.<br />
<br />
Create a [[Waypoint]] with a [[Tag]] of the form <code>'''<SourceServerId>_PortalTo_<DestinationServerId>_<PortalNumber>'''</code>, where the <code>'''ServerIds'''</code> are 3 digit integers, and the <code>'''PortalNumber'''</code> is a 2 digit integer.<br />
: ''Example: For the arrival waypoint of a portal from [[Baldur's Gate (Server) | Baldur's Gate]] (Server ID 010) to [[The Silver Marches (Server) | The Silver Marches]] (Server ID 003), the first such arrival waypoint is given the tag: <code>'''010_PortalTo_003_01'''</code><br />
<br />
== Customizing Portals ==<br />
: ''See also: [[Using Local Variables]]''<br />
The following two variables are required for the portal to function.<br />
* <code>'''ACR_PORTAL_DEST_SERVER'''</code> (int) -- Must be set to the destination server ID.<br />
*: ''Example: <code>'''int ACR_PORTAL_DEST_SERVER = 10'''</code> to travel to Baldur's Gate.''<br />
* <code>'''ACR_PORTAL_NUM'''</code> (int) -- The unique ID (for the destination server) of the destination waypoint.<br />
*: ''Example: <code>'''int ACR_PORTAL_NUM = 1'''</code> may put you at the docks, while <code>'''int ACR_PORTAL_NUM = 2'''</code> may put you at the transition between the [[Western Heartlands (Server) | Western Heartlands]] and [[Tempest's Tears]].''<br />
<br />
The following options are optional.<br />
* <code>'''ACR_PORTAL_DEST_ADJACENT'''</code> (int) -- If set to <code>1</code>, the 24-hour portal cooldown will be disabled.<br />
<br />
=IC Portals=</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Portals&diff=3963Portals2023-02-01T13:01:40Z<p>Wynna: Created page with "string sPortalLocation = GetLocalString(oPortal, "PORTAL_LOCATION"); string sPortalCommand = GetLocalString(oPortal, "PORTAL_COMMAND"); string sPortalCirc = GetLocalStri..."</p>
<hr />
<div>string sPortalLocation = GetLocalString(oPortal, "PORTAL_LOCATION");<br />
string sPortalCommand = GetLocalString(oPortal, "PORTAL_COMMAND");<br />
string sPortalCirc = GetLocalString(oPortal, "PORTAL_CIRCUMSTANCE");<br />
string sPortalDirection = GetLocalString(oPortal, "PORTAL_DIRECTION");<br />
string sPortalProps = GetLocalString(oPortal, "PORTAL_PROPERTIES");<br />
string sPortalDest = GetLocalString(oPortal, "PORTAL_DESTINATION");<br />
string sPortalFunc = GetLocalString(oPortal, "PORTAL_FUNCTIONALITY");<br />
string sPortalCompassDirection = GetCompassDirectionOfAngle(fAnglePortalFromCaster);<br />
string sPortalDistance = GetDisplayableDistance(GetDistanceBetween(oCaster, oPortal));</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3962Detect Magic2023-01-31T02:14:20Z<p>Wynna: /* Walls of Force */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL, ACR_SUBSCHOOL, and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell. Placeables do not have to be useable. <br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. Placeable portals do not have to be useable at the time of casting Detect Magic. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration.<br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. Placeables do not have to be useable. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. Placeables do not have to be useable. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only:<br />
<br />
*'''No matching item property:''' If a builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3961Detect Magic2023-01-31T02:13:52Z<p>Wynna: /* Glyphs and Symbol Traps */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL, ACR_SUBSCHOOL, and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell. Placeables do not have to be useable. <br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. Placeable portals do not have to be useable at the time of casting Detect Magic. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration.<br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. Placeables do not have to be useable. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only:<br />
<br />
*'''No matching item property:''' If a builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3960Detect Magic2023-01-31T02:13:28Z<p>Wynna: /* Portals */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL, ACR_SUBSCHOOL, and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell. Placeables do not have to be useable. <br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. Placeable portals do not have to be useable at the time of casting Detect Magic. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration.<br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only:<br />
<br />
*'''No matching item property:''' If a builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3959Detect Magic2023-01-31T02:12:38Z<p>Wynna: /* SpellSchool Variables */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL, ACR_SUBSCHOOL, and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell. Placeables do not have to be useable. <br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration. <br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only:<br />
<br />
*'''No matching item property:''' If a builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3958Detect Magic2023-01-30T22:45:24Z<p>Wynna: /* SpellSchool Variables */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL, ACR_SUBSCHOOL, and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell.<br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration. <br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only:<br />
<br />
*'''No matching item property:''' If a builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3954Detect Magic2023-01-30T22:25:14Z<p>Wynna: /* SpellSchool Variables */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL, ACR_SUBSCHOOL, and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell.<br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration. <br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, Items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only if:<br />
<br />
*'''No matching item property:''' A builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Detect_Magic&diff=3953Detect Magic2023-01-30T22:24:12Z<p>Wynna: /* Object Automatically Detected By Detect Magic */</p>
<hr />
<div>= Detect Magic Ingame= <br />
A caster can detect the magical auras of objects within the spellcone of Detect Magic cast ingame. Objects that will report include certain FX, Doors, Items, Placeables and their inventory, Triggers, Waypoints, Spell Traps, and finally Creatures and their effects and inventory.<br />
<br />
== Concentration Check == <br />
The amount of information revealed depends on how long you study a particular area or subject. Caster rolls a Concentration Check to determine rounds of study. Checks include Concentration modifiers and buffs. <br />
<br />
::{| class="wikitable_standard"<br />
! Roll<br />
! Rounds<br />
! Result<br />
|-<br />
| 1<br />
| 0 Rounds<br />
| Failure<br />
|-<br />
| 2-6<br />
| 1 Round<br />
| There is magic within range.<br />
|-<br />
| 7-13<br />
| 2 Rounds<br />
| Number of auras and the power of the strongest aura.<br />
|-<br />
| 14+<br />
| 3 Rounds<br />
| Location of auras, and a Spellcraft Check vs. power of item to learn its school of magic.<br />
|}<br />
<br />
===Failure===<br />
A natural 1, with or without modifiers, means the caster fails their casting and learns nothing.<br />
<br />
=== Round 1: There is Magic Within Range ===<br />
A roll of 2 to 6 earns one round of information that tells the caster simply that there is magic within range. After 1 Round, they get a server message that their concentration breaks.<br />
<br />
=== Round 2: Power of Magic ===<br />
A roll of 7 to 13 earns Round 2 of information: generalized number of auras within range and the strength of the strongest aura. After 2 Rounds, they get a server message that their concentration breaks.<br />
<br />
=== Round 3: Location, Individual Power and Possibly School of Magic ===<br />
A roll of 14+ earns Round 3 of information: the power and location of each aura in range. Also, at this time the caster rolls Spellcraft against the power of each aura to discover the school of the aura.<br />
<br />
= Building for Detect Magic =<br />
Some VFX, Creatures, Doors, Items, Placeables, Triggers and Waypoints (including spell traps) either automatically report or can be set up to report their magical auras to a caster of Detect Magic. <br />
<br />
== SpellSchool Variables == <br />
A builder can add up to three sets of ACR_SPELLSCHOOL and ACR_SPELLPOWER variables to Doors, Placeables, Triggers, and Waypoints to place an aura of any school, subschool and power. <br />
<br />
Sample versions of Doors, Placeables, Triggers, Traps and Waypoints, with the variable slots on them but zeroed out, exist in toolset under the category ALFA_DetectMagic (or ALFA_Traps_Spawn). Builders can change the name, tag, resref, appearance, description of these sample objects to anything. Only the variables are checked by the spell.<br />
<br />
To place an aura, only ACR_SPELLSCHOOL and ACR_SPELLPOWER are required. The others are optional and can be left as 0s or empty fields. <br />
<br />
=== School of Magic ===<br />
For instance, if you wish to suggest that a catapult has an ability to hurl fireballs, set ACR_SPELLSCHOOL to 5, for Evocation. If you want to suggest those fireballs are Transmuted magically from some solid fuel, set ACR_SPELLSCHOOL2 to 8, for Transmutation. A further suggestion that the whole thing is protected against good could use ACR_SPELLSCHOOL3 set to 1, for Abjuration.<br />
<br />
Variables (and the way they report to the caster) include:<br />
* '''ACR_SPELLSCHOOL''' (integer) -- "This catapult has an aura of Evocation"<br />
* '''ACR_SPELLSCHOOL2''' (integer) -- "This catapult has an aura of Evocation and Transmutation."<br />
* '''ACR_SPELLSCHOOL3''' (integer) -- "This catapult has an aura of Evocation and Transmutation around a central core of stored Abjuration."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Integer<br />
! School of Magic<br />
|-<br />
| 1<br />
| Abjuration <br />
|-<br />
| 2<br />
| Conjuration <br />
|-<br />
| 3<br />
| Divination <br />
|-<br />
| 4<br />
| Enchantment <br />
|-<br />
| 5<br />
| Evocation<br />
|-<br />
| 6<br />
| Illusion<br />
|-<br />
| 7<br />
| Necromancy<br />
|-<br />
| 8<br />
| Transmutation<br />
|-<br />
| 9<br />
| General/Universal Magic<br />
|}<br />
<br />
<br />
SubSchool strings are optional. A builder can enter classifications such as "Sonic" or "Mind-Affecting", or any subcategory or descriptor of spells. For instance, the hypothetical Catapult of Fireballs could be "Fire" or "Elemental". Or blank, if you don't want the PC to get that hint.<br />
* '''ACR_SUBSCHOOL''' (string) -- "This catapult has an aura of Evocation (Fire)."<br />
* '''ACR_SUBSCHOOL2''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth)."<br />
* '''ACR_SUBSCHOOL3''' (string) -- "This catapult has an aura of Evocation (Fire) and Transmutation (Earth) around a central core of stored Abjuration (Evil)."<br />
<br />
=== Power of Magic ===<br />
ACR_SPELLPOWER is required. The other two are only needed if you want multiple schools of magic. Enter the spell level of the spell being represented. For instance, our Catapult of Fireballs would be ACR_SPELLPOWER 3 for Fireball, ACR_SPELLPOWER2 5 for Transmute Rock to Mud (for loading in coal and getting out napalm) and ACR_SPELLPOWER3 8 for Unholy Aura. <br />
* '''ACR_SPELLPOWER''' (integer) -- "This catapult has a Faint aura of Evocation (Fire)."<br />
* '''ACR_SPELLPOWER2''' (integer) -- "This catapult has a Faint aura of Evocation (Fire) and a Moderate aura of Transmutation."<br />
* '''ACR_SPELLPOWER3''' (integer) -- -- "This widget has a Faint aura of Evocation and Moderate Transmutation around a central core of stored Powerful Abjuration (Evil)."<br />
<br />
<br />
:{| class="wikitable_standard"<br />
! Spell Level<br />
! Power of Magic<br />
|-<br />
| 1-3<br />
| Faint<br />
|-<br />
| 4-6<br />
| Moderate<br />
|-<br />
| 7-9<br />
| Strong<br />
|-<br />
| 10+<br />
| Overwhelming<br />
|}<br />
<br />
= Objects Automatically Detected By Detect Magic =<br />
Portals, Glyphs and Symbol Traps, Walls of Force, some FX, magical Creatures and Creatures with active spell effects, and Items with standard magical properties will be automatically found by Detect Magic, whether the object is placed in toolset or created on the fly ingame.<br />
<br />
==Portals==<br />
Portals can be triggers or placeables. If they have "_portal" in the tag, they will report to the caster as Strong Conjuration. <br />
<br />
==Glyphs and Symbol Traps==<br />
Glyphs of Warding and Symbol Traps can be triggers or placeables. If they contain certain words in their tags they will report as follows:<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Glyph of Warding <br />
|_glyph_ward<br />
|Faint Abjuration<br />
|-<br />
|Symbol of Pain <br />
|_symbol_pain<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Sleep <br />
|_symbol_sleep<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Fear <br />
|_symbol_fear<br />
|Moderate Necromancy<br />
|-<br />
|Symbol of Persuasion <br />
|_symbol_pers<br />
|Moderate Enchantment<br />
|-<br />
|Symbol of Weakness <br />
|_symbol_weakness<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Stunning <br />
|_symbol_stun<br />
|Strong Enchantment<br />
|-<br />
|Symbol of Death <br />
|_symbol_death<br />
|Strong Necromancy<br />
|-<br />
|Symbol of Insanity <br />
|_symbol_insanity<br />
|Strong Enchantment<br />
|-<br />
|}<br />
<br />
== Walls of Force == <br />
Forcefields with "Forcefield" in their names or "forcefield" in their tags are Walls of Force. They will report as Moderate Evocation.<br />
<br />
==Visual Effects==<br />
If placed or spawned without changing their tags, or at least maintaining the portion of the tag noted below, effects will register as follows.<br />
<br />
:{| class="wikitable_standard"<br />
! Type<br />
! Anywhere in Tag<br />
! Report<br />
|-<br />
|Containment Field<br />
|_containment<br />
|Faint Abjuration<br />
|-<br />
|Wall of Force<br />
|_force<br />
|Moderate Evocation<br />
|-<br />
|Ioun Stone <br />
|_ioun<br />
|Strong Transmutation<br />
|-<br />
|Elemental <br />
|_elemental<br />
|Moderate Conjuration<br />
|-<br />
|Arcane Symbol Projections <br />
|_proj as well as three letter abbreviation for school (_abj, _con, _div, _enc, _evo, _ill, _nec, _tra)<br />
|Faint {Insert School}<br />
|-<br />
|Arcane Lamp <br />
|_arcane_lamp_<br />
|Faint Evocation<br />
|-<br />
|Teleport Gem Blue <br />
|abr_afx_gem_energy_blue (entire tag)<br />
|Strong Conjuration<br />
|-<br />
|Other Energy Gems <br />
|_gem_energy<br />
|Faint Evocation<br />
|}<br />
<br />
<br />
<br />
== Spell Traps ==<br />
More information on tooling traps can be found on the [[ACR_Traps]] page. <br />
<br />
Spell Traps, not mechanical traps, will report school and power to the caster based on the spell they cast. <br />
<br />
===ACR_TRAP_SPELL_ID===<br />
If tooled up and placed in toolset, they already have the required spell ID on them. If spawned, they do not. To have a spawning trap report to the caster, its spawnpoint also needs to have the spell ID on it. (Mechanically, even though the tooled up trap has the trap integer on it in toolset and if placed, when it is *spawned* that trap integer disappears so it has to be on the spawnpoint, to register.)<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- Add this to the spawnpoint. Value is the row number of the spell from the Spells 2DA.<br />
<br />
===TRAP ORIGIN ===<br />
Spell Traps also require a nearby origin point, a Placeable tagged as TRAP_ORIGIN. It can have any appearance. <br />
<br />
Spell Traps report auras on both the origin and the location of the trap, which is not always at the origin point. <br />
<br />
For instance, a spawned or placed Fireball Trap originating from a burning torch where the flame is a placeable tagged TRAP_ORIGIN would have the ACR_TRAP_SPELL_ID of integer 58. If proximity to the torch itself is the trigger, that radius is already set on a correctly tooled or spawned trap. Origin and trap or trap spawnpoint are put on top of each other. It will report as "Torch Flame 2m to the Southeast gives off an aura of Faint Evocation."<br />
<br />
If the trigger is a nearby stone pressure plate, then the origin is the placeable flame and the trap or spawnpoint are placed on the pressure plate. This would report as "Torch Flame 2m to the Southeast and a circle centered on a point 4m West of Torch Flame give off an aura of Faint Evocation."<br />
<br />
==Creatures==<br />
Creatures are the most complex use case. They can have racial auras, active spell effects, and inventory.<br />
===Creature Report===<br />
A creature's report will start with Racial Auras, if any. Next comes a Functioning Spells section, if any spell effects are currently active. After that, the item reports begin, starting with an item summary, then moving to equipped items, and finally a blurb about inventory.<br />
<br />
=== Racial Auras ===<br />
Some Creatures will register automatically. For instance: "Pegasus has a lingering aura of Innate Magic."<br />
<br />
:{| class="wikitable_standard"<br />
! Race<br />
! School<br />
|-<br />
|Construct<br />
|Transmutation<br />
|-<br />
|Elemental<br />
|Conjuration<br />
|-<br />
|Fey<br />
|Enchantment<br />
|-<br />
|Magical Beast<br />
|Innate Magic<br />
|-<br />
|Outsider<br />
|Conjuration<br />
|-<br />
|Shapechanger<br />
|Transmutation<br />
|-<br />
|Undead<br />
|Necromancy<br />
|-<br />
|}<br />
<br />
<br />
Their power is based on 1/2 their CR. <br />
<br />
:{| class="wikitable_standard"<br />
! CR <br />
! Power of Magic<br />
|-<br />
| 1-6<br />
| Faint<br />
|-<br />
| 7-12<br />
| Moderate<br />
|-<br />
| 13-20<br />
| Strong<br />
|-<br />
| 20+<br />
| Overwhelming<br />
|}<br />
<br />
=== Creatures with Active Spell Effects ===<br />
PCs or NPCs with active spells will report their aura by cross-referencing the spell effect with the school and level from the Spells 2DA.<br />
<br />
Any active spell will register. Examples:<br />
<br />
:{| class="wikitable_standard"<br />
! Spell<br />
! School<br />
! Power<br />
|-<br />
| Death Ward<br />
| Necromancy<br />
| Moderate<br />
|-<br />
| Protection from Evil<br />
| Aburation<br />
| Faint<br />
|-<br />
| Invisibility*<br />
| Illusion<br />
| Faint/Moderate/Strong<br />
|-<br />
| Detect Scrying<br />
| Divination<br />
| Moderate<br />
|-<br />
| See Invisibility<br />
| Divination<br />
| Faint<br />
|-<br />
| Wildshape<br />
| Transmutation<br />
| Faint<br />
|}<br />
<br />
Note: Invisible creatures report only location of auras, not that they are on a creature or that creature's name.<br />
<br />
== Items ==<br />
===SpellSchool Variables===<br />
Like other objects, Items can have up to three sets of [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables SpellSchool Variables] added manually, but these should be used sparingly, since Item auras also automatically report based on their item properties. An Item ''can'' have both automatically reporting properties and SpellSchool properties, but use SpellSchool variables only if:<br />
<br />
*'''No matching item property:''' A builder wants to add an aura that no item property automatically generates;<br />
*'''Cast Unique:''' To supplement the aura information for items with the item properties: Cast Spell: Unique Power, or Cast Spell: Unique Power Self Only, or Cast Spell: On Hit. These properties each call tag-based event scripts that Detect Magic can't read, and which it will report as "This item has a complex aura of arcanity." Add SpellSchool variables to explicate the complex aura.<br />
<br />
For instance: a builder has created a spoon that magically sweetens any porridge it scoops up. The item property Cast Spell: Unique Power is placed on the spoon, which calls event script i_spoon_ac. The caster will get the "complex aura" message, and if the builder places an ACR_SPELLSCHOOL of 8 and an ACR_SPELLPOWER of 1 on the spoon, will also get a Faint Transmutation aura to represent the famous Transmutation spell: ''Sugar Hit''. <br />
<br />
<br />
Otherwise, Items report automatically based on the following guidelines.<br />
<br />
===Tag Based Auras===<br />
Some items return an aura based on their tag, rather than their properties. Note: These items can have other properties, too, but will return at least the following:<br />
<br />
{| class="wikitable_standard"<br />
! Item<br />
! School<br />
! Power<br />
|- <br />
|Holy Symbol <br />
|Abjuration <br />
|Faint<br />
|-<br />
|Scrying Multi-Tool <br />
|Universal <br />
|Faint<br />
|}<br />
<br />
===Spell Casting Properties===<br />
Any item that casts any spell is cross-referenced against the Item Property Spells 2DA and the Spells 2DA to get school and power.<br />
<br />
===Enhancement Properties===<br />
The SRD under Magic Items and Detect Magic says:<br />
<br />
:{| class="wikitable_standard"<br />
! Item<br />
! School<br />
|- <br />
|Armor and protection items<br />
|Abjuration<br />
|-<br />
|Weapons or offensive items<br />
|Evocation<br />
|- <br />
|Bonus to ability score, on skill check, etc.<br />
|Transmutation<br />
|}<br />
<br />
<br />
Power is based on amount of enhancement:<br />
<br />
:{| class="wikitable_standard"<br />
! Enhancement<br />
! Power<br />
|- <br />
| +1<br />
|Faint<br />
|-<br />
| +2<br />
|Moderate<br />
|- <br />
| +3<br />
|Strong<br />
|- <br />
| +4<br />
|Overwhelming<br />
|}<br />
<br />
===Miscellaneous Properties===<br />
<br />
:{| class="wikitable_standard"<br />
! Property<br />
! School<br />
! Power<br />
|- <br />
|Bonus Feat<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Bonus HP<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Darkvision<br />
|Transmutation<br />
|Faint<br />
|- <br />
|Freedom of Movement<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|Haste<br />
|Transmutation<br />
|Faint<br />
|-<br />
|Immunity Damage Type<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Misc<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Immunity Spell Level<br />
|Abjuration<br />
|Strong<br />
|-<br />
|Improved Evasion<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Light<br />
|Evocation<br />
|Faint<br />
|-<br />
|Regeneration<br />
|Transmutation<br />
|Strong<br />
|-<br />
|Spell Resistance<br />
|Abjuration<br />
|Moderate<br />
|-<br />
|True Seeing<br />
|Transmutation<br />
|Moderate<br />
|-<br />
|}<br />
===Loose Items ===<br />
<br />
Items on the ground or otherwise outside of a container or creature's inventory report individually, just like any other object.<br />
<br />
"A Tower Shield 10m Northwest gives off an aura of Moderate Abjuration."<br />
<br />
===Items in a Placeable===<br />
Placeables report their items based on whether they are open or closed. "Something in Chest 5m to the South gives off a Moderate aura of Conjuration." Or "An unidentified potion in a Chest 5m to the South gives off a Moderate aura of Conjuration. "Or if identified because the PC recognizes it "A Cure Moderate Wounds potion in a Chest gives off a Moderate aura of Conjuration."<br />
<br />
===Items on Creatures===<br />
<br />
'''Summary''': Creatures generate a more complex item report than any other object type. The first part of the Creature Item report is a summary of how many auras of each school of magic surround the creature. "Little Red Riding Hood has around half a dozen Abjuration auras. Little Red Riding Hood has 1 Necromancy aura."<br />
<br />
'''Equipped''': Items equipped on a visible creature report individually. "Bracers worn by the Big Bad Wolf gives off a Strong aura of Transmutation."'''<br />
<br />
'''Inventory''': Items in a Creature's inventory are reported in one statement at the end of the creature report. "The rest of the auras are in Big Bad Wolf's inventory."<br />
<br />
=End of Report=<br />
"That is all you learn."</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=ACR_Traps&diff=3952ACR Traps2023-01-30T22:16:36Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:ACR Tools]]<br />
[[Category:DM Guides]]<br />
The ACR has in its core content a custom implementation of traps that is meant to serve as a workaround for the severe limitations imposed by traps as they are implemented by [[Neverwinter Nights 2 | NWN2]]. These traps are capable of spawning and despawning, are aware of their own shapes and sizes, and can control whether or not they trigger by a number of conditions, including those which we would associate with spellcasting traps.<br />
<br />
== Detecting Traps ==<br />
A search roll is automatically rolled, with the fact that the roll was made being hidden, whenever a character approaches a trap with detect mode on. If the result of the search check is greater than or equal to the search DC, the trap is detected. There is a special exception made for high-DC traps: only rogues, or people under the effects of a Find Traps spell, may find traps with a search DC greater than 20. If a character does not expend the trap (for example, by triggering it until it runs out of ammunition or charges), but remains near it, an additional roll will be made every six seconds, and every PC near the trap will also get rolls.<br />
<br />
When a trap is detected, the character whose check revealed the trap will gain a visual effect overhead that indicates responsibility for the detection. In addition, the trap will become visible as a pulsing red VFX in the shape of the trap on the ground, and finally a disarm target object will appear on the ground where the detector was standing when the trap was revealed.<br />
: '''It is important to note that traps are invisible to DMs once they are spawned. The tick in the spawning UI when placing a trap is the indication that the spawning has happened.'''<br />
<br />
== Detect Magic ==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Spell_Traps Detect Magic: Spell Traps]<br />
<br />
Detect Magic will work automatically with a placed spell trap or a spell trap spawnpoint with a variable added to it called ACR_TRAP_SPELL_ID which contains the integer of the spell ID.* As with any ACR_Trap, either option requires a placeable tagged as TRAP_ORIGIN nearby, also.<br />
<br />
Detect Magic uses ACR_TRAP_SPELL_ID (already on a placed trap or added to the spawnpoint) to cross-reference spell effects against 2DA information. From the 2DA it pulls the proper school and spell power to put into the report to the Caster. For instance, for a Web Trap: "Spider Web and a circle centered on a spot 1m southwest of Spider Web gives off a Moderate aura of Conjuration." Spider Web is the placeable tagged as TRAP_ORIGIN. The spot at which the circle is reported is the either the placed trap or the spawnpoint. <br />
<br />
*Weirdly, although a placed trap already has the ACR_TRAP_SPELL_ID on it, that same trap spawned by a spawnpoint does not, so it has to be added to the spawnpoint itself for the Detect Magic to find it.<br />
<br />
== Disarming Traps ==<br />
Traps are disarmed by using the disarm widget. DM Avatars who do this will immediately and automatically disarm the trap, removing it and the target from the area permanently. If an character uses the disarm target, that character will begin to work on disarming the trap, which will take 12-48 (most likely 30) seconds. During this time the character must remain reasonably stationary and may not carry out other actions, but stepping away from the disarming device will abort the effort.<br />
<br />
Characters with ranks in Disable Device may choose to aid the effort by also using the disarm target, and as many as can physically approach the device may help. Each additional disabler will roll a DC 10 Disable Device check, granting a stacking +2 bonus to the primary disabler's check on success. A character may only attempt to aid in disabling a trap once per primary user's attempt.<br />
<br />
The disarming character will not know ahead of time how long it will take to disarm the trap, nor will he or she know how difficult to disarm the trap will be until attempting to disarm it once.<br />
<br />
At the end of the time required to disarm the trap, a skill check is made against the disarm DC of the trap. If the roll is greater than or equal to the DC to disarm the trap, the trap is removed from play and rendered harmless. If the Disable Device roll fails by 4 or less, then no change is made to the trap. If the Disable Device roll fails by 5 or more, then the effort is botched and the trap is triggered, functioning per the fired trap section, except that the trap disabler is treated as a potential target (possibly the only potential target) for the trap's execution.<br />
<br />
== Triggering Traps ==<br />
When a trap is triggered, its effects are applied to a random creature within the trap's trigger area, and potentially a botched disabler (see above). This effect may cover an area. For example, a trap which explodes in a fireball when triggered may have three people working on disarming it. Should the check be botched anyway while the trigger area is empty, only the primary disabler will be a valid target and he or she will be the center of the resulting explosion. However, the two nearby assistants are likely to be within the blast and to also be injured. If on the other hand the trigger required several people in its area to be triggered, and three were already within, botching the trap has a 1 in 4 chance of centering on each person in the trigger area or the disabler.<br />
<br />
It is possible for traps to trigger with discretion, such as a magical trap that only harms orcs. In this case, only qualifying creatures in the trigger area will be regarded as valid targets. Botching a disable attempt overrides this. A botched disabler is always a valid target, regardless of the trap's specific restrictions.<br />
<br />
== Default Traps ==<br />
By default, every ALFA module has access to a set of standard traps, which are modeled after the default NWN2 traps. All of them have only one charge, do direct damage, and have equal spot, disable, and reflex save DCs. All offer reflex saves when triggered. All are of "medium" trigger size (comparable to the area of a Magic Circle vs. Alignment)<br />
<br />
:{| class="wikitable_standard"<br />
! Name<br />
! Damage<br />
! DC<br />
! Area<br />
|-<br />
| Acid Blob, Minor<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Acid Blob, Average<br />
| 5d6<br />
| 20<br />
| 1 meter<br />
|-<br />
| Acid Blob, Strong<br />
| 12d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Blob, Deadly<br />
| 18d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Splash, Minor<br />
| 2d8<br />
| 12<br />
| 1 meter<br />
|-<br />
| Acid Splash, Average<br />
| 3d8<br />
| 14<br />
| 1 meter<br />
|-<br />
| Acid Splash, Strong<br />
| 5d8<br />
| 17<br />
| 1 meter<br />
|-<br />
| Acid Splash, Deadly<br />
| 8d8<br />
| 20<br />
| 1 meter<br />
|-<br />
| Electrical, Minor<br />
| 8d6<br />
| 19<br />
| 5 meters<br />
|-<br />
| Electrical, Average<br />
| 15d6<br />
| 22<br />
| 5 meters<br />
|-<br />
| Electrical, Strong<br />
| 20d6<br />
| 26<br />
| 5 meters<br />
|-<br />
| Electrical, Deadly<br />
| 30d6<br />
| 28<br />
| 5 meters<br />
|-<br />
| Fire, Minor<br />
| 5d6<br />
| 18<br />
| 2 meters<br />
|-<br />
| Fire, Average<br />
| 8d6<br />
| 20<br />
| 2 meters<br />
|-<br />
| Fire, Strong<br />
| 15d6<br />
| 23<br />
| 4 meters<br />
|-<br />
| Fire, Deadly<br />
| 25d6<br />
| 26<br />
| 4 meters<br />
|-<br />
| Frost, Minor<br />
| 2d4<br />
| 12<br />
| 1 meter<br />
|-<br />
| Frost, Average<br />
| 3d4<br />
| 13<br />
| 1 meter<br />
|-<br />
| Frost, Strong<br />
| 5d4<br />
| 14<br />
| 1 meter<br />
|-<br />
| Frost, Deadly<br />
| 8d4<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Minor<br />
| 2d6<br />
| 12<br />
| 1 meter<br />
|-<br />
| Negative, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Strong<br />
| 5d6<br />
| 18<br />
| 1 meter<br />
|-<br />
| Negative, Deadly<br />
| 8d6<br />
| 21<br />
| 1 meter<br />
|-<br />
| Sonic, Minor<br />
| 2d4<br />
| 12<br />
| 3 meters<br />
|-<br />
| Sonic, Average<br />
| 3d4<br />
| 14<br />
| 3 meters<br />
|-<br />
| Sonic, Strong<br />
| 5d4<br />
| 17<br />
| 3 meters<br />
|-<br />
| Sonic, Deadly<br />
| 8d4<br />
| 20<br />
| 3 meters<br />
|-<br />
| Spike, Minor<br />
| 2d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Strong<br />
| 5d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Deadly<br />
| 25d6<br />
| 15<br />
| 1 meter<br />
|}<br />
<br />
== Tooling Additional Traps ==<br />
Additional traps may be added to a module by creating waypoints which have variables on them which indicate that they are traps. The following variables control the behavior of the trap.<br />
<br />
* '''ACR_TRAP_TRIGGER_AREA''' (integer) -- This variable determines how large the area which is capable of causing the trap to fire is.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Name<br />
! Comparison<br />
|-<br />
| 1<br />
| Small<br />
| Single-Target<br />
|-<br />
| 2<br />
| Medium<br />
| Magic Circle v. Alignment<br />
|-<br />
| 3<br />
| Large<br />
| Entangle<br />
|-<br />
| 4<br />
| Huge<br />
| Fireball<br />
|-<br />
| 5<br />
| Gargantuan<br />
| Lesser Missile Storm<br />
|-<br />
| 6<br />
| Colossal<br />
| Area Dispel Magic<br />
|}<br />
* '''ACR_TRAP_ATTACK_BONUS''' (integer, optional) -- This is the attack bonus that will be used to calculate if a trap is able to damage its target, should no reflex save be defined for the trap. This is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DAMAGE_TYPE''' (bitfield) -- This variable determines what kind of damage will be applied to targets of the trap. As a bitfield, you may take the sum of several damage types to make the trap do multiple types of damage. For example, Piercing Damage (2) and Slashing Damage (4) can be added together to make a piercing/slashing trap (6). This is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Damage Type<br />
|-<br />
| 1<br />
| Bludgeoning<br />
|-<br />
| 2<br />
| Piercing<br />
|-<br />
| 4<br />
| Slashing<br />
|-<br />
| 8<br />
| Magical<br />
|-<br />
| 16<br />
| Acid<br />
|-<br />
| 32<br />
| Cold<br />
|-<br />
| 64<br />
| Divine<br />
|-<br />
| 128<br />
| Electrical<br />
|-<br />
| 256<br />
| Fire<br />
|-<br />
| 512<br />
| Negative<br />
|-<br />
| 1024<br />
| Positive<br />
|-<br />
| 2048<br />
| Sonic<br />
|}<br />
* '''ACR_TRAP_DETECT_DC''' (integer)''' -- This variable determines what the DC of search checks to discover the trap will be. If this number is greater than 20, the trap will only be discoverable by Rogues.<br />
* '''ACR_TRAP_DICE_NUMBER (integer) -- This variable determines how many dice will be rolled to determine trap damage. This is ignored if the trap casts a spell. For example, if this is 3 and * '''ACR_TRAP_DICE_TYPE is 6, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DICE_TYPE (integer)''' -- This variable determines what sort of die will be rolled to determine trap damage. For example, if this is 6, and * '''ACR_TRAP_DICE_NUMBER is 3, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DISARM_DC (integer)''' -- This variable determines what the DC to disarm the trap is.<br />
* '''ACR_TRAP_EFFECT_AREA''' (integer) -- This variable uses the SHAPE_ constants to determine how this trap's effect spreads out, if it has a large enough area to be significant. This setting is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Shape<br />
|-<br />
| 0<br />
| Spell Cyllinder (e.g. Lightning Bolt)<br />
|-<br />
| 1<br />
| Cone (e.g. Burning Hands)<br />
|-<br />
| 2<br />
| Cube (e.g. Order's Wrath)<br />
|-<br />
| 3<br />
| Spell Cone (e.g. Cone of Cold)<br />
|-<br />
| 4<br />
| Sphere (e.g. Fireball)<br />
|}<br />
* '''ACR_TRAP_EFFECT_SIZE''' (float) -- This is the size, in meters, of the effect area defined previously. Cylinders and cones become longer, but remain directional. Cubes gain length on all sides equally. Spheres gain a larger radius. This setting is ignroed if the trap casts a spell.<br />
* '''ACR_TRAP_MINIMUM_TO_TRIGGER''' (integer) -- This is the number of creatures who meet the criteria for a trap's triggering who must be within the trap's trigger area''' (defined above) before the trap will fire.<br />
* '''ACR_TRAP_NUMBER_OF_SHOTS''' (integer) -- This is the number of times the trap will fire before it is discharged. If this number is -1, the trap has infinite charges, and will fire until disarmed.<br />
* '''ACR_TRAP_SAVE_DC''' (integer) -- This is the reflex save DC of the trap. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- This is the ID of the spell that is cast. If this is -1 or if it is absent, the trap will not be regarded as spell casting, and will instead resolve to do damage. If this option is set, the trap must be placed or spawned near a placeable with the tag "TRAP_ORIGIN." In the absence of this placeable, the trap trigger will attempt to-- and typically fail to-- cast the spell itself.<br />
* '''ACR_TRAP_TARGET_ALIGNMENT''' (integer) -- This setting determines which alignments are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other alignments. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Alignment<br />
|-<br />
| 0<br />
| All Alignments<br />
|-<br />
| 1<br />
| Neutral Alignments<br />
|-<br />
| 2<br />
| Lawful Alignments<br />
|-<br />
| 3<br />
| Chaotic Alignments<br />
|-<br />
| 4<br />
| Good Alignments<br />
|-<br />
| 5<br />
| Evil Alignments<br />
|}<br />
* '''ACR_TRAP_TARGET_RACE''' (integer) -- This setting determins which racial types are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other races. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Race<br />
|-<br />
| 0<br />
| Dwarf<br />
|-<br />
| 1<br />
| Elf<br />
|-<br />
| 2<br />
| Gnome<br />
|-<br />
| 3<br />
| Halfling<br />
|-<br />
| 4<br />
| Half-Elf<br />
|-<br />
| 5<br />
| Half-Orc<br />
|-<br />
| 6<br />
| Human<br />
|-<br />
| 7<br />
| Abberations<br />
|-<br />
| 8<br />
| Animals<br />
|-<br />
| 9<br />
| Beasts (depreciated)<br />
|-<br />
| 10<br />
| Constructs<br />
|-<br />
| 11<br />
| Dragons<br />
|-<br />
| 12<br />
| Goblinoids<br />
|-<br />
| 13<br />
| Monstrous Humanoids<br />
|-<br />
| 14<br />
| Orcs<br />
|-<br />
| 15<br />
| Reptilian Humanoids<br />
|-<br />
| 16<br />
| Elementals<br />
|-<br />
| 17<br />
| Fey<br />
|-<br />
| 18<br />
| Giants<br />
|-<br />
| 19<br />
| Magical Beasts<br />
|-<br />
| 20<br />
| Outsiders<br />
|-<br />
| 24<br />
| Undead<br />
|-<br />
| 25<br />
| Vermin<br />
|-<br />
| '''28'''<br />
| '''All Races'''<br />
|-<br />
| 29<br />
| Oozes<br />
|-<br />
| 30<br />
| Incorporeal (depreciated)<br />
|-<br />
| 31<br />
| Yuan-Ti<br />
|}<br />
* '''ACR_TRAP_DESCRIPTION''' (string) -- This setting determines what the descriptive text on the trap's disarm target will read when examined with the default "examine" command. While it may contain any arbitrary information deemed useful by the builders, it is recommended that it contain a description of what a person would see of this trap upon discovering it.<br />
<br />
== Spawning Traps ==<br />
ACR Traps are currently able to be spawned through the [[ACR Creator]], and may also be placed using the ACR Spawn System, with object type 8.<br />
<br />
In order to spawn a trap, you must first tool the trap, according to the instructions above, and then use the resource name of the waypoint used to tool the trap as the resource name of the trap on the spawn point. In addition, for the trap to register to Detect Magic, to this spawnpoint add the variable: ACR_TRAP_SPELL_ID. Enter the spell integer into the integer slot. <br />
<br />
In all other respects, these spawn points work as any other spawn point.<br />
<br />
In addition, you may place a placeable with the tag "TRAP_ORIGIN" near any trap trigger and it will be regarded as the source for all effects which are created by the trap. This has two uses:<br />
* Animations that involve projectiles will show the trap's effect being shot from the trap origin<br />
* The trap may be used in the spell trap mode (as placeables are allowed to cast spells in the NWN2 engine, but triggers are not).<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=ACR_Traps&diff=3951ACR Traps2023-01-30T22:16:15Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:ACR Tools]]<br />
[[Category:DM Guides]]<br />
The ACR has in its core content a custom implementation of traps that is meant to serve as a workaround for the severe limitations imposed by traps as they are implemented by [[Neverwinter Nights 2 | NWN2]]. These traps are capable of spawning and despawning, are aware of their own shapes and sizes, and can control whether or not they trigger by a number of conditions, including those which we would associate with spellcasting traps.<br />
<br />
== Detecting Traps ==<br />
A search roll is automatically rolled, with the fact that the roll was made being hidden, whenever a character approaches a trap with detect mode on. If the result of the search check is greater than or equal to the search DC, the trap is detected. There is a special exception made for high-DC traps: only rogues, or people under the effects of a Find Traps spell, may find traps with a search DC greater than 20. If a character does not expend the trap (for example, by triggering it until it runs out of ammunition or charges), but remains near it, an additional roll will be made every six seconds, and every PC near the trap will also get rolls.<br />
<br />
When a trap is detected, the character whose check revealed the trap will gain a visual effect overhead that indicates responsibility for the detection. In addition, the trap will become visible as a pulsing red VFX in the shape of the trap on the ground, and finally a disarm target object will appear on the ground where the detector was standing when the trap was revealed.<br />
: '''It is important to note that traps are invisible to DMs once they are spawned. The tick in the spawning UI when placing a trap is the indication that the spawning has happened.'''<br />
<br />
== Detect Magic ==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Spell_Traps Detect Magic: Spell Traps]<br />
Detect Magic will work automatically with a placed spell trap or a spell trap spawnpoint with a variable added to it called ACR_TRAP_SPELL_ID which contains the integer of the spell ID.* As with any ACR_Trap, either option requires a placeable tagged as TRAP_ORIGIN nearby, also.<br />
<br />
Detect Magic uses ACR_TRAP_SPELL_ID (already on a placed trap or added to the spawnpoint) to cross-reference spell effects against 2DA information. From the 2DA it pulls the proper school and spell power to put into the report to the Caster. For instance, for a Web Trap: "Spider Web and a circle centered on a spot 1m southwest of Spider Web gives off a Moderate aura of Conjuration." Spider Web is the placeable tagged as TRAP_ORIGIN. The spot at which the circle is reported is the either the placed trap or the spawnpoint. <br />
<br />
: *Weirdly, although a placed trap already has the ACR_TRAP_SPELL_ID on it, that same trap spawned by a spawnpoint does not, so it has to be added to the spawnpoint itself for the Detect Magic to find it.<br />
<br />
== Disarming Traps ==<br />
Traps are disarmed by using the disarm widget. DM Avatars who do this will immediately and automatically disarm the trap, removing it and the target from the area permanently. If an character uses the disarm target, that character will begin to work on disarming the trap, which will take 12-48 (most likely 30) seconds. During this time the character must remain reasonably stationary and may not carry out other actions, but stepping away from the disarming device will abort the effort.<br />
<br />
Characters with ranks in Disable Device may choose to aid the effort by also using the disarm target, and as many as can physically approach the device may help. Each additional disabler will roll a DC 10 Disable Device check, granting a stacking +2 bonus to the primary disabler's check on success. A character may only attempt to aid in disabling a trap once per primary user's attempt.<br />
<br />
The disarming character will not know ahead of time how long it will take to disarm the trap, nor will he or she know how difficult to disarm the trap will be until attempting to disarm it once.<br />
<br />
At the end of the time required to disarm the trap, a skill check is made against the disarm DC of the trap. If the roll is greater than or equal to the DC to disarm the trap, the trap is removed from play and rendered harmless. If the Disable Device roll fails by 4 or less, then no change is made to the trap. If the Disable Device roll fails by 5 or more, then the effort is botched and the trap is triggered, functioning per the fired trap section, except that the trap disabler is treated as a potential target (possibly the only potential target) for the trap's execution.<br />
<br />
== Triggering Traps ==<br />
When a trap is triggered, its effects are applied to a random creature within the trap's trigger area, and potentially a botched disabler (see above). This effect may cover an area. For example, a trap which explodes in a fireball when triggered may have three people working on disarming it. Should the check be botched anyway while the trigger area is empty, only the primary disabler will be a valid target and he or she will be the center of the resulting explosion. However, the two nearby assistants are likely to be within the blast and to also be injured. If on the other hand the trigger required several people in its area to be triggered, and three were already within, botching the trap has a 1 in 4 chance of centering on each person in the trigger area or the disabler.<br />
<br />
It is possible for traps to trigger with discretion, such as a magical trap that only harms orcs. In this case, only qualifying creatures in the trigger area will be regarded as valid targets. Botching a disable attempt overrides this. A botched disabler is always a valid target, regardless of the trap's specific restrictions.<br />
<br />
== Default Traps ==<br />
By default, every ALFA module has access to a set of standard traps, which are modeled after the default NWN2 traps. All of them have only one charge, do direct damage, and have equal spot, disable, and reflex save DCs. All offer reflex saves when triggered. All are of "medium" trigger size (comparable to the area of a Magic Circle vs. Alignment)<br />
<br />
:{| class="wikitable_standard"<br />
! Name<br />
! Damage<br />
! DC<br />
! Area<br />
|-<br />
| Acid Blob, Minor<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Acid Blob, Average<br />
| 5d6<br />
| 20<br />
| 1 meter<br />
|-<br />
| Acid Blob, Strong<br />
| 12d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Blob, Deadly<br />
| 18d6<br />
| 25<br />
| 1 meter<br />
|-<br />
| Acid Splash, Minor<br />
| 2d8<br />
| 12<br />
| 1 meter<br />
|-<br />
| Acid Splash, Average<br />
| 3d8<br />
| 14<br />
| 1 meter<br />
|-<br />
| Acid Splash, Strong<br />
| 5d8<br />
| 17<br />
| 1 meter<br />
|-<br />
| Acid Splash, Deadly<br />
| 8d8<br />
| 20<br />
| 1 meter<br />
|-<br />
| Electrical, Minor<br />
| 8d6<br />
| 19<br />
| 5 meters<br />
|-<br />
| Electrical, Average<br />
| 15d6<br />
| 22<br />
| 5 meters<br />
|-<br />
| Electrical, Strong<br />
| 20d6<br />
| 26<br />
| 5 meters<br />
|-<br />
| Electrical, Deadly<br />
| 30d6<br />
| 28<br />
| 5 meters<br />
|-<br />
| Fire, Minor<br />
| 5d6<br />
| 18<br />
| 2 meters<br />
|-<br />
| Fire, Average<br />
| 8d6<br />
| 20<br />
| 2 meters<br />
|-<br />
| Fire, Strong<br />
| 15d6<br />
| 23<br />
| 4 meters<br />
|-<br />
| Fire, Deadly<br />
| 25d6<br />
| 26<br />
| 4 meters<br />
|-<br />
| Frost, Minor<br />
| 2d4<br />
| 12<br />
| 1 meter<br />
|-<br />
| Frost, Average<br />
| 3d4<br />
| 13<br />
| 1 meter<br />
|-<br />
| Frost, Strong<br />
| 5d4<br />
| 14<br />
| 1 meter<br />
|-<br />
| Frost, Deadly<br />
| 8d4<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Minor<br />
| 2d6<br />
| 12<br />
| 1 meter<br />
|-<br />
| Negative, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Negative, Strong<br />
| 5d6<br />
| 18<br />
| 1 meter<br />
|-<br />
| Negative, Deadly<br />
| 8d6<br />
| 21<br />
| 1 meter<br />
|-<br />
| Sonic, Minor<br />
| 2d4<br />
| 12<br />
| 3 meters<br />
|-<br />
| Sonic, Average<br />
| 3d4<br />
| 14<br />
| 3 meters<br />
|-<br />
| Sonic, Strong<br />
| 5d4<br />
| 17<br />
| 3 meters<br />
|-<br />
| Sonic, Deadly<br />
| 8d4<br />
| 20<br />
| 3 meters<br />
|-<br />
| Spike, Minor<br />
| 2d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Average<br />
| 3d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Strong<br />
| 5d6<br />
| 15<br />
| 1 meter<br />
|-<br />
| Spike, Deadly<br />
| 25d6<br />
| 15<br />
| 1 meter<br />
|}<br />
<br />
== Tooling Additional Traps ==<br />
Additional traps may be added to a module by creating waypoints which have variables on them which indicate that they are traps. The following variables control the behavior of the trap.<br />
<br />
* '''ACR_TRAP_TRIGGER_AREA''' (integer) -- This variable determines how large the area which is capable of causing the trap to fire is.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Name<br />
! Comparison<br />
|-<br />
| 1<br />
| Small<br />
| Single-Target<br />
|-<br />
| 2<br />
| Medium<br />
| Magic Circle v. Alignment<br />
|-<br />
| 3<br />
| Large<br />
| Entangle<br />
|-<br />
| 4<br />
| Huge<br />
| Fireball<br />
|-<br />
| 5<br />
| Gargantuan<br />
| Lesser Missile Storm<br />
|-<br />
| 6<br />
| Colossal<br />
| Area Dispel Magic<br />
|}<br />
* '''ACR_TRAP_ATTACK_BONUS''' (integer, optional) -- This is the attack bonus that will be used to calculate if a trap is able to damage its target, should no reflex save be defined for the trap. This is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DAMAGE_TYPE''' (bitfield) -- This variable determines what kind of damage will be applied to targets of the trap. As a bitfield, you may take the sum of several damage types to make the trap do multiple types of damage. For example, Piercing Damage (2) and Slashing Damage (4) can be added together to make a piercing/slashing trap (6). This is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Damage Type<br />
|-<br />
| 1<br />
| Bludgeoning<br />
|-<br />
| 2<br />
| Piercing<br />
|-<br />
| 4<br />
| Slashing<br />
|-<br />
| 8<br />
| Magical<br />
|-<br />
| 16<br />
| Acid<br />
|-<br />
| 32<br />
| Cold<br />
|-<br />
| 64<br />
| Divine<br />
|-<br />
| 128<br />
| Electrical<br />
|-<br />
| 256<br />
| Fire<br />
|-<br />
| 512<br />
| Negative<br />
|-<br />
| 1024<br />
| Positive<br />
|-<br />
| 2048<br />
| Sonic<br />
|}<br />
* '''ACR_TRAP_DETECT_DC''' (integer)''' -- This variable determines what the DC of search checks to discover the trap will be. If this number is greater than 20, the trap will only be discoverable by Rogues.<br />
* '''ACR_TRAP_DICE_NUMBER (integer) -- This variable determines how many dice will be rolled to determine trap damage. This is ignored if the trap casts a spell. For example, if this is 3 and * '''ACR_TRAP_DICE_TYPE is 6, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DICE_TYPE (integer)''' -- This variable determines what sort of die will be rolled to determine trap damage. For example, if this is 6, and * '''ACR_TRAP_DICE_NUMBER is 3, then the trap does 3d6 damage. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_DISARM_DC (integer)''' -- This variable determines what the DC to disarm the trap is.<br />
* '''ACR_TRAP_EFFECT_AREA''' (integer) -- This variable uses the SHAPE_ constants to determine how this trap's effect spreads out, if it has a large enough area to be significant. This setting is ignored if the trap casts a spell.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Shape<br />
|-<br />
| 0<br />
| Spell Cyllinder (e.g. Lightning Bolt)<br />
|-<br />
| 1<br />
| Cone (e.g. Burning Hands)<br />
|-<br />
| 2<br />
| Cube (e.g. Order's Wrath)<br />
|-<br />
| 3<br />
| Spell Cone (e.g. Cone of Cold)<br />
|-<br />
| 4<br />
| Sphere (e.g. Fireball)<br />
|}<br />
* '''ACR_TRAP_EFFECT_SIZE''' (float) -- This is the size, in meters, of the effect area defined previously. Cylinders and cones become longer, but remain directional. Cubes gain length on all sides equally. Spheres gain a larger radius. This setting is ignroed if the trap casts a spell.<br />
* '''ACR_TRAP_MINIMUM_TO_TRIGGER''' (integer) -- This is the number of creatures who meet the criteria for a trap's triggering who must be within the trap's trigger area''' (defined above) before the trap will fire.<br />
* '''ACR_TRAP_NUMBER_OF_SHOTS''' (integer) -- This is the number of times the trap will fire before it is discharged. If this number is -1, the trap has infinite charges, and will fire until disarmed.<br />
* '''ACR_TRAP_SAVE_DC''' (integer) -- This is the reflex save DC of the trap. This setting is ignored if the trap casts a spell.<br />
* '''ACR_TRAP_SPELL_ID''' (integer) -- This is the ID of the spell that is cast. If this is -1 or if it is absent, the trap will not be regarded as spell casting, and will instead resolve to do damage. If this option is set, the trap must be placed or spawned near a placeable with the tag "TRAP_ORIGIN." In the absence of this placeable, the trap trigger will attempt to-- and typically fail to-- cast the spell itself.<br />
* '''ACR_TRAP_TARGET_ALIGNMENT''' (integer) -- This setting determines which alignments are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other alignments. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Alignment<br />
|-<br />
| 0<br />
| All Alignments<br />
|-<br />
| 1<br />
| Neutral Alignments<br />
|-<br />
| 2<br />
| Lawful Alignments<br />
|-<br />
| 3<br />
| Chaotic Alignments<br />
|-<br />
| 4<br />
| Good Alignments<br />
|-<br />
| 5<br />
| Evil Alignments<br />
|}<br />
* '''ACR_TRAP_TARGET_RACE''' (integer) -- This setting determins which racial types are regarded as valid targets for the trap-- this will be used to determine who in the trap area is the center of the effect and whether a given creature counts toward the trap's minimum to trigger. However, traps which explode will still strike creatures of other races. It will simply not aim for the others.<br />
::{| class="wikitable_standard"<br />
! Value<br />
! Race<br />
|-<br />
| 0<br />
| Dwarf<br />
|-<br />
| 1<br />
| Elf<br />
|-<br />
| 2<br />
| Gnome<br />
|-<br />
| 3<br />
| Halfling<br />
|-<br />
| 4<br />
| Half-Elf<br />
|-<br />
| 5<br />
| Half-Orc<br />
|-<br />
| 6<br />
| Human<br />
|-<br />
| 7<br />
| Abberations<br />
|-<br />
| 8<br />
| Animals<br />
|-<br />
| 9<br />
| Beasts (depreciated)<br />
|-<br />
| 10<br />
| Constructs<br />
|-<br />
| 11<br />
| Dragons<br />
|-<br />
| 12<br />
| Goblinoids<br />
|-<br />
| 13<br />
| Monstrous Humanoids<br />
|-<br />
| 14<br />
| Orcs<br />
|-<br />
| 15<br />
| Reptilian Humanoids<br />
|-<br />
| 16<br />
| Elementals<br />
|-<br />
| 17<br />
| Fey<br />
|-<br />
| 18<br />
| Giants<br />
|-<br />
| 19<br />
| Magical Beasts<br />
|-<br />
| 20<br />
| Outsiders<br />
|-<br />
| 24<br />
| Undead<br />
|-<br />
| 25<br />
| Vermin<br />
|-<br />
| '''28'''<br />
| '''All Races'''<br />
|-<br />
| 29<br />
| Oozes<br />
|-<br />
| 30<br />
| Incorporeal (depreciated)<br />
|-<br />
| 31<br />
| Yuan-Ti<br />
|}<br />
* '''ACR_TRAP_DESCRIPTION''' (string) -- This setting determines what the descriptive text on the trap's disarm target will read when examined with the default "examine" command. While it may contain any arbitrary information deemed useful by the builders, it is recommended that it contain a description of what a person would see of this trap upon discovering it.<br />
<br />
== Spawning Traps ==<br />
ACR Traps are currently able to be spawned through the [[ACR Creator]], and may also be placed using the ACR Spawn System, with object type 8.<br />
<br />
In order to spawn a trap, you must first tool the trap, according to the instructions above, and then use the resource name of the waypoint used to tool the trap as the resource name of the trap on the spawn point. In addition, for the trap to register to Detect Magic, to this spawnpoint add the variable: ACR_TRAP_SPELL_ID. Enter the spell integer into the integer slot. <br />
<br />
In all other respects, these spawn points work as any other spawn point.<br />
<br />
In addition, you may place a placeable with the tag "TRAP_ORIGIN" near any trap trigger and it will be regarded as the source for all effects which are created by the trap. This has two uses:<br />
* Animations that involve projectiles will show the trap's effect being shot from the trap origin<br />
* The trap may be used in the spell trap mode (as placeables are allowed to cast spells in the NWN2 engine, but triggers are not).<br />
<br />
<br />
{{ALFA Core Rules}}</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Triggers&diff=3950Building Triggers2023-01-30T22:14:56Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
Creating triggers under the ACR is nearly the same as creating them under standard NWN2; The ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming trigger blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
=== Localized Name ===<br />
Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance.<br />
: ''Example: Transition Trigger {party}''<br />
<br />
=== Template, ResRef, and Tag ===<br />
: ''See also: [[ResRef]], [[Tag]], and [[Template]]''<br />
All trigger blueprints in the basemod will begin with the <code>abr_tr</code> prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so <code>001_tr</code> for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the trigger itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
: ''Example: A global generic trigger: <code>abr_tr_gn_mytrigger</code><br />
: ''Example: A server generic trigger on server 01: <code>001_tr_gn_mytrigger</code><br />
<br />
=== Comments ===<br />
To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints).<br />
: ''Example: Created By: John Doe, Date Modified: 2014-01-23, Used By: [[acr_trigger_i.nss]]''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Event Handlers ==<br />
The default basemod triggers should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the trigger's event scripts are all set correctly. The default scripts are:<br />
* <code>'''acf_trg_onclick'''</code><br />
* <code>'''acf_trg_ondisarm'''</code><br />
* <code>'''acf_trg_onheartbeat'''</code><br />
* <code>'''acf_trg_ontraptriggered'''</code><br />
* <code>'''acf_trg_onenter'''</code><br />
* <code>'''acf_trg_onexit'''</code><br />
* <code>'''acf_trg_onuserdefined'''</code><br />
<br />
== Custom Scripting ==<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_trigger_i"<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_trg_* scripts. Failure to call one of these scripts in a trigger's event handler WILL break the ACR's trigger system, and probably a few other things as well.<br />
* <code>'''ACR_TriggerOnClick()'''</code><br />
* <code>'''ACR_TriggerOnDisarm()'''</code><br />
* <code>'''ACR_TriggerOnHeartbeat()'''</code><br />
* <code>'''ACR_TriggerOnTrapTriggered()'''</code><br />
* <code>'''ACR_TriggerOnEnter()'''</code><br />
* <code>'''ACR_TriggerOnExit()'''</code><br />
* <code>'''ACR_TriggerOnUserDefined()'''</code><br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a trigger to better suit their needs. These options are changed by altering the local variables on the trigger itself, and not by altering any of the scripts used by the trigger. The default basemod triggers should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
<br />
=== Detect Magic ===<br />
These are advanced options for triggers to register as magical to Detect Magic. <br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the trigger should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
*'''Detecting Portals'''<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
*'''Detecting Glyphs and Symbol Traps'''<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]<br />
<br />
=== Effects ===<br />
These are advanced options for placing effects (visual and otherwise) on triggers. For the following effect options, <code>'''{EVENT}'''</code> is one of:<br />
* <code>'''ON_CLICK'''</code><br />
* <code>'''ON_DISARM'''</code><br />
* <code>'''ON_HEARTBEAT'''</code><br />
* <code>'''ON_ENTER'''</code><br />
* <code>'''ON_EXIT'''</code><br />
<br />
==== Visual Effects ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT'''</code>/<code>'''VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2d]]a (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_VISUAL_EFFECT'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of <code>'''VFX_BEAM_FIRE'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== Physical Effects ====<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE'''</code>/<code>'''VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_PHYSICAL_EFFECT'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== Damage Effects ====<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE'''</code>/<code>'''ST TYPE'''</code>/<code>'''DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_DAMAGE_EFFECT'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Triggers&diff=3949Building Triggers2023-01-30T22:14:29Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
Creating triggers under the ACR is nearly the same as creating them under standard NWN2; The ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming trigger blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
=== Localized Name ===<br />
Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance.<br />
: ''Example: Transition Trigger {party}''<br />
<br />
=== Template, ResRef, and Tag ===<br />
: ''See also: [[ResRef]], [[Tag]], and [[Template]]''<br />
All trigger blueprints in the basemod will begin with the <code>abr_tr</code> prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so <code>001_tr</code> for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the trigger itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
: ''Example: A global generic trigger: <code>abr_tr_gn_mytrigger</code><br />
: ''Example: A server generic trigger on server 01: <code>001_tr_gn_mytrigger</code><br />
<br />
=== Comments ===<br />
To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints).<br />
: ''Example: Created By: John Doe, Date Modified: 2014-01-23, Used By: [[acr_trigger_i.nss]]''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Event Handlers ==<br />
The default basemod triggers should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the trigger's event scripts are all set correctly. The default scripts are:<br />
* <code>'''acf_trg_onclick'''</code><br />
* <code>'''acf_trg_ondisarm'''</code><br />
* <code>'''acf_trg_onheartbeat'''</code><br />
* <code>'''acf_trg_ontraptriggered'''</code><br />
* <code>'''acf_trg_onenter'''</code><br />
* <code>'''acf_trg_onexit'''</code><br />
* <code>'''acf_trg_onuserdefined'''</code><br />
<br />
== Custom Scripting ==<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_trigger_i"<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_trg_* scripts. Failure to call one of these scripts in a trigger's event handler WILL break the ACR's trigger system, and probably a few other things as well.<br />
* <code>'''ACR_TriggerOnClick()'''</code><br />
* <code>'''ACR_TriggerOnDisarm()'''</code><br />
* <code>'''ACR_TriggerOnHeartbeat()'''</code><br />
* <code>'''ACR_TriggerOnTrapTriggered()'''</code><br />
* <code>'''ACR_TriggerOnEnter()'''</code><br />
* <code>'''ACR_TriggerOnExit()'''</code><br />
* <code>'''ACR_TriggerOnUserDefined()'''</code><br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a trigger to better suit their needs. These options are changed by altering the local variables on the trigger itself, and not by altering any of the scripts used by the trigger. The default basemod triggers should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
<br />
=== Detect Magic ===<br />
These are advanced options for triggers to register as magical to Detect Magic. <br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the trigger should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
*'''Detecting Portals'''<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals]<br />
<br />
*'''Detecting Glyphs and Symbol Traps'''<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps]<br />
<br />
=== Effects ===<br />
These are advanced options for placing effects (visual and otherwise) on triggers. For the following effect options, <code>'''{EVENT}'''</code> is one of:<br />
* <code>'''ON_CLICK'''</code><br />
* <code>'''ON_DISARM'''</code><br />
* <code>'''ON_HEARTBEAT'''</code><br />
* <code>'''ON_ENTER'''</code><br />
* <code>'''ON_EXIT'''</code><br />
<br />
==== Visual Effects ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT'''</code>/<code>'''VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2d]]a (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_VISUAL_EFFECT'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of <code>'''VFX_BEAM_FIRE'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== Physical Effects ====<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE'''</code>/<code>'''VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_PHYSICAL_EFFECT'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== Damage Effects ====<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE'''</code>/<code>'''ST TYPE'''</code>/<code>'''DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_DAMAGE_EFFECT'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3948Building Placeables2023-01-30T22:11:31Z<p>Wynna: </p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
==Detecting Portals==<br />
<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3947Building Placeables2023-01-30T22:10:13Z<p>Wynna: /* Detecting Glyphs and Symbol Traps */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
==Detecting Portals==<br />
<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Glyphs_and_Symbol_Traps Detect Magic: Glyphs and Symbol Traps]<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3946Building Placeables2023-01-30T22:09:25Z<p>Wynna: /* Detecting Portals */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
==Detecting Portals==<br />
<br />
See [https://www.alandfaraway.info/wiki/Detect_Magic#Portals Detect Magic: Portals]<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
Glyphs of Warding placeables with "_glyph_warding" in the tag do not require variables. They will register automatically as having an aura of Faint (lvl 3) Abjuration.<br />
<br />
Symbols of X placeables with "_symbol_pain", "_symbol_sleep", "_symbol_pers", "_symbol_fear", "_symbol_stun", "_symbol_weakness", "_symbol_insanity", "_symbol_death", in the tag do not require variables. They will register automatically as having an aura of Moderate (Pain/Sleep/Persuasion/Fear) or Strong (Stun/Weakness/Insanity/Death) Enchantment (Persuasion/Sleep/Stun/Insanity) or Necromancy (Fear/Pain/Weakness/Death).<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3945Building Placeables2023-01-30T22:08:22Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
==Detecting Portals==<br />
Portal placeables prefixed with "alfa_portal" in the tag do not require variables. They will register automatically as having an aura of Moderate (lvl 4) Conjuration. If currently useable in game, they will report with their name to the Caster. If currently unuseable in game, they will report with "Something" as their name to the Caster. "Portal 5m to the northeast has a Moderate aura of Conjuration." Or, "Something 5m to the northeast has a Moderate aura of Conjuration."<br />
<br />
==Detecting Glyphs and Symbol Traps==<br />
Glyphs of Warding placeables with "_glyph_warding" in the tag do not require variables. They will register automatically as having an aura of Faint (lvl 3) Abjuration.<br />
<br />
Symbols of X placeables with "_symbol_pain", "_symbol_sleep", "_symbol_pers", "_symbol_fear", "_symbol_stun", "_symbol_weakness", "_symbol_insanity", "_symbol_death", in the tag do not require variables. They will register automatically as having an aura of Moderate (Pain/Sleep/Persuasion/Fear) or Strong (Stun/Weakness/Insanity/Death) Enchantment (Persuasion/Sleep/Stun/Insanity) or Necromancy (Fear/Pain/Weakness/Death).<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3944Building Placeables2023-01-30T22:08:02Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
= Detect Magic =<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
*==Detecting Portals==<br />
Portal placeables prefixed with "alfa_portal" in the tag do not require variables. They will register automatically as having an aura of Moderate (lvl 4) Conjuration. If currently useable in game, they will report with their name to the Caster. If currently unuseable in game, they will report with "Something" as their name to the Caster. "Portal 5m to the northeast has a Moderate aura of Conjuration." Or, "Something 5m to the northeast has a Moderate aura of Conjuration."<br />
<br />
*'==Detecting Glyphs and Symbol Traps==<br />
Glyphs of Warding placeables with "_glyph_warding" in the tag do not require variables. They will register automatically as having an aura of Faint (lvl 3) Abjuration.<br />
<br />
Symbols of X placeables with "_symbol_pain", "_symbol_sleep", "_symbol_pers", "_symbol_fear", "_symbol_stun", "_symbol_weakness", "_symbol_insanity", "_symbol_death", in the tag do not require variables. They will register automatically as having an aura of Moderate (Pain/Sleep/Persuasion/Fear) or Strong (Stun/Weakness/Insanity/Death) Enchantment (Persuasion/Sleep/Stun/Insanity) or Necromancy (Fear/Pain/Weakness/Death).<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Placeables&diff=3943Building Placeables2023-01-30T22:07:11Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
Creating placeables under the ACR is nearly the same as creating them under normal NWN, the ACR just provides a few more options for builders.<br />
<br />
== Naming Conventions ==<br />
The following conventions will need to be used in naming placeable blueprints to avoid any conflicts with other blueprints and to ensure that all content works properly with scripts:<br />
<br />
'''Localized Name''': Choose a one or two word descriptive name. You can add text visible only to builders in {} to help distinguish multiple blueprints of the same type at a glance. Ex: Wooden Chest {trapped}<br />
<br />
'''Template ResRef/Resource Name/Tag''': All placeable blueprints in the basemod will begin with the "abr_pl" prefix to designate them as global blueprints. Server specific blueprints should begin with a 3 digit server number in place of the "abr", so "001_pl" for example. For every subcategory, add a two letter acronym delimited with underscores followed lastly by a descriptive name for the placeable itself. This helps to quickly locate blueprints when all we have is its resref. To illustrate, here are a few examples:<br />
* A global container placeable: abr_pl_co_mycontainer<br />
* A server container placeable on server 01: 001_pl_co_mycontainer<br />
* A global building prop: abr_pl_bp_mybuilding<br />
<br />
'''Comments''' To identify and track blueprint versions, it's best to write your name and the date you modified the blueprint in the comments area. In addition, you may wish to note any scripts the blueprint is specifically used by (primarily for dedicated blueprints). : ''Ex: Created By: John Doe, Date Modified: 2006/12/20, Used By: acr_placeable_i.nss''<br />
<br />
For global blueprints, you should also include a link to this wiki page so builders that are unfamiliar with conventions or configuration options can easily find them.<br />
<br />
== Setting Event Handlers ==<br />
The default basemod placeables should already have these handlers in place, so if you are copying an existing blueprint, you probably don't need to do anything here. To start off with, make sure the placeable's event scripts are all set correctly. The default scripts are:<br />
* acf_plc_onclosed<br />
* acf_plc_onconversation<br />
* acf_plc_ondamaged<br />
* acf_plc_ondeath<br />
* acf_plc_ondisarm<br />
* acf_plc_onheartbeat<br />
* acf_plc_onlock<br />
* acf_plc_onmeleeattacked<br />
* acf_plc_onopen<br />
* acf_plc_onspellcastat<br />
* acf_plc_ontraptriggered<br />
* acf_plc_onunlock<br />
* acf_plc_onused<br />
* acf_plc_onuserdefined<br />
* acf_plc_oninventorydisturbed<br />
<br />
If you wish to make an object (like a chair) sitable, replace the OnUsed event handler with:<br />
* acf_plc_onusedsit<br />
<br />
= Custom Scripting =<br />
If you need to add your own custom scripts, you can of course do so. First, include this line at the top of your script somewhere:<br />
#include "acr_placeable_i"<br />
<br />
Then make sure the following functions are called in each of your custom event handlers, just as they are done in the acf_plc_* scripts. Failure to call one of these scripts in a placeable's event handler WILL break the ACR's placeable system, and probably a few other things as well.<br />
<br />
* ACR_PlaceableOnClosed()<br />
* ACR_PlaceableOnConversation()<br />
* ACR_PlaceableOnDamaged()<br />
* ACR_PlaceableOnDeath()<br />
* ACR_PlaceableOnDisarm()<br />
* ACR_PlaceableOnHeartbeat()<br />
* ACR_PlaceableOnLock()<br />
* ACR_PlaceableOnMeleeAttacked()<br />
* ACR_PlaceableOnOpen()<br />
* ACR_PlaceableOnSpellCastAt()<br />
* ACR_PlaceableOnTrapTriggered()<br />
* ACR_PlaceableOnUnlock()<br />
* ACR_PlaceableOnUsed()<br />
* ACR_PlaceableOnUserDefined()<br />
* ACR_PlaceableOnInventoryDisturbed()<br />
<br />
== Configuration Options ==<br />
: ''See also: [[Using Local Variables]]''<br />
These options allow the builder to configure a placeable to better suit their needs. These options are changed by altering the local variables on the placeable itself, and not by altering any of the scripts used by the placeable. The default basemod placeables should already have these variables in place, so if you are copying an existing blueprint, you probably only need to alter the values of the variables here.<br />
* <code>'''ACR_PLC_BREAK_DC'''</code> (integer) This is the strength-check DC necissary to force open a placeables lock, as per DMG rules. This is generally an alternative to smashing something to pieces with an axe.<br />
* <code>'''ACR_PLC_AUTO_LOCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it will always lock itself when it shuts.<br />
* <code>'''ACR_PLC_IS_STUCK'''</code> (integer) If zero, the placeable behaves normally. If nonzero, it is stuck shut, and must be forced open regardless of whether or not it is locked.<br />
* <code>'''ACR_PLC_WEIGHT'''</code> (float) If you want creatures to be able to pick up and move a placeable, set this value. They will be able to pick it up in both hands, and drop it again somewhere else. The placeable takes up both of their free hands, so fighting is not possible without dropping it. If you don't want a placeable to be able to be picked up, leave this value at zero. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_CARRIED_ITEM'''</code> (string) If you want a placeable to become a certain type of item when it is picked up, set this string to the resref of that item. If this string is defined, the weight setting will be ignored, and the item's default weight used. When the PC drops this item, the placeable will be created at the dropped location. Note: Movable placeables must be usable, walkable, non-static, and have dynamic collisions turned on.<br />
* <code>'''ACR_PLC_LIGHT'''</code> (string) This is the resref of the light object used to "light" the placeable when its light is "on".<br />
* <code>'''ACR_PLC_LIGHT_VFX'''</code> (string) This is the resref of the VFX to be used while the placeables light is "on".<br />
* <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (integer) The hour the placeable turns its light "on". If equal to <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_OFF_HOUR'''</code> (integer) The hour the placeable turns its light "off". If equal to <code>'''ACR_PLC_LIGHT_ON_HOUR'''</code> (or if neither variable is set), the placeable's light never changes on its own. Valid values are from 0 to 23.<br />
* <code>'''ACR_PLC_LIGHT_INITIAL_STATE'''</code> (integer) Sets the initial state of the placeable's light. If zero, it is off. If nonzero, it is on. If the on/off hours are used, this setting is ignored.<br />
* <code>'''ACR_PLC_LIGHT_TOGGLE'''</code> (integer) Sets whether or not a creature can light or unlight this placeable on its own, by using it. If zero, it cannot. If nonzero, it can.<br />
<br />
=== Detect Magic ===<br />
These are advanced options for placeables to register as having an aura to Detect Magic. <br />
<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] for which integer calls which school of magic. (Hint, it's alphabetical, from Abjuration to Universal.)<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the placeable should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the placeable should register a second aura to Detect Magic, again, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic. <br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the placeable should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For instance for a fireplace poker that simulates a casting of Burning Hands, ACR_SPELLSCHOOL would be integer 5 and ACR_SPELLPOWER would be 1, to return: "Magic Fireplace Poker has a Faint Aura of Evocation." Or "Magic Fireplace Poker has a Faint Aura" if the caster fails the Spellcraft check to learn the magic school. (Actually scripting the poker to cast Burning Hands is a separate matter entirely, but at least it will register as having the aura for it with these variables.)<br />
<br />
*'''Detecting Portals'''<br />
Portal placeables prefixed with "alfa_portal" in the tag do not require variables. They will register automatically as having an aura of Moderate (lvl 4) Conjuration. If currently useable in game, they will report with their name to the Caster. If currently unuseable in game, they will report with "Something" as their name to the Caster. "Portal 5m to the northeast has a Moderate aura of Conjuration." Or, "Something 5m to the northeast has a Moderate aura of Conjuration."<br />
<br />
*'''Detecting Glyphs and Symbol Traps'''<br />
Glyphs of Warding placeables with "_glyph_warding" in the tag do not require variables. They will register automatically as having an aura of Faint (lvl 3) Abjuration.<br />
<br />
Symbols of X placeables with "_symbol_pain", "_symbol_sleep", "_symbol_pers", "_symbol_fear", "_symbol_stun", "_symbol_weakness", "_symbol_insanity", "_symbol_death", in the tag do not require variables. They will register automatically as having an aura of Moderate (Pain/Sleep/Persuasion/Fear) or Strong (Stun/Weakness/Insanity/Death) Enchantment (Persuasion/Sleep/Stun/Insanity) or Necromancy (Fear/Pain/Weakness/Death).<br />
<br />
Like other traps, Glyphs and Symbols will always report with "Something" as their name. "Something 5m to the northeast has a Moderate aura." Or "Something 5m to the northeast has a Moderate aura of Enchantment" if the caster passes a spellcraft check to learn the school of magic.<br />
<br />
=== Persistence Options ===<br />
These options are used make placeable inventories persistent:<br />
* <code>'''ACR_PSO_NAME'''</code> (string) Sets the name of the database to which inventory is stored. THIS MUST BE UNIQUE PER MODULE AND HOST.<br />
* <code>'''ACR_PSO_ONDEATH'''</code> (integer) Sets whether the inventory of a persistent container should drop when destroyed. 0 = DO NOT DROP (default behavior) 1 = DROP INVENTORY<br />
<br />
=== Conversation Options ===<br />
In order to make a placeable use a conversation:<br />
* Place the standard script "'''x2_use_placeable'''" in the onused script event.<br />
* Check the box on your placeable for 'Usable' and uncheck the box for 'Static', it can be 'Walkable' or not depending on your needs.<br />
* Place the name of the Conversation it will start in the Conversation box.<br />
* Alternately you can also set the ''''Default Action Preference'''' to ''Use'' to make it easy for your players to access the conversation.<br />
<br />
=== Effect Options ===<br />
These are advanced options for placing effects (visual and otherwise) on placeables. For the following effect options, {EVENT} is one of:<br />
* ON_OPEN<br />
* ON_CLOSE<br />
* ON_LOCK<br />
* ON_UNLOCK<br />
* ON_USED<br />
* ON_ATTACKED<br />
* ON_DAMAGED<br />
* ON_SPELLCAST<br />
* ON_SPAWN<br />
* ON_DEATH<br />
* ON_DISTURBED<br />
* ON_HEARTBEAT<br />
* ON_DISARM<br />
* ON_PERCEPTION<br />
<br />
The possible configurations are as follows.<br />
<br />
==== EFFECT_VISUAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_VISUAL'''</code> (string)<br />
These strings are used to define the visual effects that trigger for each event on the activating creature (this includes light shaft placeables). These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX CONSTANT/VFX DURATION'''</code>, where <code>'''VFX CONSTANT'''</code> is one of the [[GetEffectInteger]] constants defined in [[visualeffects.2da]] (listed in [[NWScript.nss]]) and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Visual effects are those which only provide a visual indicator that something has occurred. These effects are totally harmless but are used in conjunction with Physical and Damage Effects to illustrate something has occurred to the target upon interacting with an object (the source of the effects).<br />
<br />
Visual effect constants are string values used in constructing the <code>'''*_EFFECT_VISUAL'''</code> local variable. The list of supported effects can be expanded as necessary, but any changes or additions should be reflected in the <code>'''_getVFXConstant()'''</code> function in the [[acr_vfx_i.nss]] file in order for the effect to function.<br />
<br />
Not all visual effects will support variable durations. Some simply have fixed animation cycles which cannot be affected through scripting.<br />
<br />
To setup the visual effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a fire beam that triggers when an object is used (touched) and expires after 5 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_VISUAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''VFX_BEAM_FIRE'''</code>/5.0<br />
<br />
You can substitute any of the available visual effects constants in place of VFX_BEAM_FIRE, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_PHYSICAL ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_PHYSICAL'''</code> (string)<br />
These strings are used to define the physical effects that trigger for each event on the activating creature. These are not mutually exclusive options (ie they can all be defined on a single object). Each string must be defined in the following format: <code>'''VFX TYPE/VFX DURATION'''</code>, where <code>'''VFX TYPE'''</code> is the specific type of effect to be applied and <code>'''VFX DURATION'''</code> is a float representing the total number of seconds the effect should last (use 0.0 if it's either n/a or a permanent effect; some exceptions apply noted in the individual effect sections of the documentation).<br />
<br />
Physical effects are those that affect the target's health or condition. These include anything from raw damage to altering the target's state of mind. They typically have NO visual indication (exceptions exist like knockdown) and as a result, should be used in tandem with a suitable visual effect for the benefit of the player (both in terms of providing IC feedback that something has affected their character as well as providing a more enjoyable and engaging atmosphere).<br />
<br />
Not all physical effects have durations. Some are instant effects and others are permanent. damage effects apply directly to the physical effect, and as such, you should always reference this section when constructing damage effect values to understand how the damage will be applied.<br />
<br />
To setup the physical effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to construct a knockdown physical effect to be used with the fire beam visual effect described above that expires after 10 seconds, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_PHYSICAL'''</code><br />
: Variable Type : string<br />
: Variable Value : <code>'''KNOCKDOWN'''</code>/5.0<br />
<br />
You can substitute any of the physical effects available in place of <code>'''KNOCKDOWN'''</code>, but be sure your spelling is correct. Typo's will not yield correct results.<br />
<br />
==== EFFECT_DAMAGE ====<br />
: <code>'''ACR_VFX_{EVENT}_EFFECT_DAMAGE'''</code> (string)<br />
These strings are used to define the damage a physical effect will apply to the activating creature for each event as well as the saving throw required to avoid suffering from the physical effect or related damage. These are not mutually exclusive options (ie they can all be defined on a single object) but they must exist for each physical effect defined if some form of damage is to be applied. Each string must be defined in the following format: <code>'''DAMAGE/ST TYPE/DC'''</code>, where <code>'''DAMAGE'''</code> is the damage value to apply toward the desired physical effect, <code>'''ST TYPE'''</code> is the type of Saving Throw possible (<code>'''FORTITUDE'''</code>, <code>'''REFLEX'''</code>, or <code>'''WILL'''</code>), and <code>'''DC'''</code> is the [[Difficulty Class]] of the save.<br />
<br />
Damage effects contain the actual details of the physical effect being applied, including any saving throws and DCs that the target can attempt to save against. Damage effects need not be defined, but they should be defined appropriately according to the physical effect used. Read the article on physical effect types to determine how damage values are applied to a given physical effect. Do not define a damage Effect without a corresponding physical effect to apply it to.<br />
<br />
To setup the damage effect local variable, select the object in the toolset that you wish to add effects to then click the "..." button in the properties dialogue to browse the variables list on the object. Once the variables screen opens up, enter in the appropriate variable name for the effect in the name field, select "string" as the variable type, and then enter in the appropriate value.<br />
<br />
For example, to give the knockdown physical effect described above some damage and allow the target a reflex saving throw of DC 15, you would create the following:<br />
: Variable Name : <code>'''ACR_VFX_ON_USE_EFFECT_DAMAGE'''</code><br />
: Variable Type : string<br />
: Variable Value : 3.0/<code>'''REFLEX'''</code>/15.0<br />
<br />
All values must be represented as floating point numbers.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Items&diff=3942Building Items2023-01-30T22:06:10Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
=Nomenclature=<br />
All items should be priced according to 3.5 edition canon (Player's Hand Book, Dungeon Master's Guide, etc), and to the ALFA specific exceptions set forth by ALFA [[Standards]]. '''Do not make items worth less than 1gp yet!''' Our currency system for silver and copper pieces is not yet ready, and we may not know how it will work until we have the client in our hands.<br />
<br />
'''Premise''': An item should be identifiable from it's tag/resref.<br />
<br />
'''<prefix>_it_<type>_<description>_<ID>'''<br />
<br />
'''<prefix>''' is either "abr" (minus the quotes) for default ALFA items, or a three digit code of the server.<br />
<br />
'''<type>''' is a three-letter abbreviation describing the slot occupied by the item.<br />
<br />
'''<description>''' is the number of fields necessary to describe any additional properties on the item.<br />
<br />
'''<ID>''' is an optional two-digit number used to distinguish items with identical properties. Leave the <ID> off of tags - it goes on resrefs only.<br />
<br />
Item tags should NEVER be longer than 28 characters. The game allows 32, so don't use them all.<br />
<br />
'''Scripting''': For information on how to script items, go here.<br />
<br />
'''Examples''': A standard longsword would be, '''Tag''': abr_it_wpn_longsword '''ResRef''': abr_it_wpn_longword_01<br />
<br />
=Materials=<br />
* Abyssal Bloodiron ay<br />
* Adamantine ad<br />
* Alchemical Silver sa<br />
* Arandur aa<br />
* Astral Driftmetal as<br />
* Aurorum au<br />
* Bluewood bw<br />
* Cold Iron ci<br />
* Copper co<br />
* Darksteel dk<br />
* Darkwood (Zalantar) za<br />
* Dlarun dl<br />
* Dragonbone db<br />
* Dragonfang df<br />
* Dragonhide dh<br />
* Dragonscale ds<br />
* Duskwood du<br />
* Fever Iron fr<br />
* Fiendbone fb<br />
* Frystalline fy<br />
* Gold go<br />
* Hide hi<br />
* Hizagkuur hz<br />
* Laminated Steel ls<br />
* Living Metal lm<br />
* Mithral mi<br />
* Obsidian ob<br />
* Pandemonic Silver ps<br />
* Platinum pt<br />
* Serren se<br />
* Silver sv<br />
* Solarian Truesteel tr<br />
* Sondarr so<br />
* Suzailian Chainweave ch<br />
* Weirwood ww<br />
* Ysgardian Heartwire ys<br />
<br />
=Quality=<br />
* Arcane Spell Failure -10% asf1<br />
* Drowcraft dc<br />
* Masterwork mw<br />
* Plus one e1<br />
* Poor po<br />
* Armour Class +1 ac1<br />
* Bonus Spell, Level 0 sb0<br />
* Bonus Spell, Levels 0, 1, 2 sb012<br />
* Damage Resistance 1 dr1<br />
* Damage Resistance 5/magic dr5m<br />
* Damage Resistance Fire 5 drf5<br />
* Feat: Alertness fale<br />
* Feat: Ambidexterity famb<br />
* Feat: Combat Casting fcca<br />
* Feat: Darkvision fdar<br />
* Feat: Dodge fdod<br />
* Feat: Extra Turning fext<br />
* Feat: Mobility fmob<br />
* Feat: Spell Focus (One) fsf1<br />
* Feat: Spell Penetration fpen<br />
* Feat: Two Weapon Fighting ftwf<br />
* Feat: Weapon Finesse fwfi<br />
* Spell Immunity, Level 0 si0<br />
* Spell Resistance 12 sr12<br />
* Freedom of Movement fom<br />
* Immunity: Death Magic ide<br />
* Immunity: Disease idi<br />
* Immunity: Drain idr<br />
* Immunity: Fear ife<br />
* Immunity: Gas iga<br />
* Immunity: Magic Missle imm<br />
* Immunity: Paralysis ipa<br />
* Immunity: Poison ipo<br />
* Save, Acid +1 sac1<br />
* Save, Cold +1 sco1<br />
* Save, Death +1 sde1<br />
* Save, Disease +1 sds1<br />
* Save, Fear +1 sfe1<br />
* Save, Fire +1 sfi1<br />
* Save, Fort +1 sfo1<br />
* Save, Mind +1 smi1<br />
* Save, Negative +1 sne1<br />
* Save, Poison +1 spo1<br />
* Save, Reflex +1 sre1<br />
* Save, Sonic +1 sso1<br />
* Save, Universal +1 sa1<br />
* Save, Will +1 swi1<br />
* Hide +1 hi1<br />
* Damage, Acid +1 da1<br />
* Damage, Bludgeoning +1 db1<br />
* Damage, Cold +1 dc1<br />
* Damage, Divine +1 dd1<br />
* Damage, Fire +1 df1<br />
* Damage, Magic +1 dm1<br />
* Damage, Negative +1 dn1<br />
* Damage, Piercing +1 dp1<br />
* Damage, Slashing +1 ds1<br />
* Damage, Sonic +1 do1<br />
* Feat: Cleave fcle<br />
* Feat: Disarm fdis<br />
* Feat: Improved Critical ficr<br />
* Feat: Point Blank Shot fpbs<br />
* Feat: Rapid Shot frap<br />
* Feat: Weapon Specialisation fwsp<br />
* Keen ke<br />
* Massive Criticals +1 mc1<br />
* Mighty +1 m1<br />
* Sure Striking sst<br />
* Vampiric +1 dv1<br />
* Wounding +1 dw1<br />
<br />
This is added in the toolset with a string separated by the '|' character for each category. The HDMs of every server are free to make their own rules as too where items should be placed, but be aware the DM client cannot see more than one step "deep" into the category tree.<br />
<br />
= Detect Magic =<br />
Most magical items will automatically register to Detect Magic correctly. The spell looks at the item's properties and cross-references spell effects and enhancements against 2DA information to assign the proper school and spell power.<br />
The following are advanced options for items without properties or for which you want to register an aura in addition to what Detect Magic cross-references from item properties.<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the item should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For items that use an i_tag_eventsuffix script to be called on a Cast Spell: Unique Power event, the automatic report to the caster will read only "Something has an aura too complex to be unravel." If you want the item to register a spell aura in addition to that message, you must place the above variables.<br />
<br />
For instance, for a uniquely scripted Hairbrush using the i_tag_ac that fires on activate to perform a uniquely scripted buff to CHA that simulates a casting of Eagle's Splendor as well as actions or effects you couldn't get by just adding Cast Spell: Eagle's Splendor to the Hairbrush, you would set ACR_SPELLSCHOOL to 8 and ACR_SPELLPOWER to 2. <br />
<br />
If the caster passes a spellcraft check, in addition to the "Too Complex" message generated by the fact of the unique power event, if the item was loose on the floor this would return a message that reads "Hairbrush has a Faint aura of Transmutation", or "Something in the Cabinet's inventory (or Princess Penelope Prettygirl's inventory) has a Faint aura of Transmutation" if the hairbrush is in something/somebody's inventory. <br />
<br />
If the caster does not pass the spellcraft check, s/he doesn't get the school of magic. The item returns only "Hairbrush has a Faint aura" or "Something in X's inventory has a Faint aura."<br />
<br />
= Item Tips =<br />
* When creating Creature items, make sure the item is checked as identified, otherwise the creature cannot equip or use the item.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Items&diff=3941Building Items2023-01-30T22:05:08Z<p>Wynna: </p>
<hr />
<div>[[Category:Technical Manuals]]<br />
=Nomenclature=<br />
All items should be priced according to 3.5 edition canon (Player's Hand Book, Dungeon Master's Guide, etc), and to the ALFA specific exceptions set forth by ALFA [[Standards]]. '''Do not make items worth less than 1gp yet!''' Our currency system for silver and copper pieces is not yet ready, and we may not know how it will work until we have the client in our hands.<br />
<br />
'''Premise''': An item should be identifiable from it's tag/resref.<br />
<br />
'''<prefix>_it_<type>_<description>_<ID>'''<br />
<br />
'''<prefix>''' is either "abr" (minus the quotes) for default ALFA items, or a three digit code of the server.<br />
<br />
'''<type>''' is a three-letter abbreviation describing the slot occupied by the item.<br />
<br />
'''<description>''' is the number of fields necessary to describe any additional properties on the item.<br />
<br />
'''<ID>''' is an optional two-digit number used to distinguish items with identical properties. Leave the <ID> off of tags - it goes on resrefs only.<br />
<br />
Item tags should NEVER be longer than 28 characters. The game allows 32, so don't use them all.<br />
<br />
'''Scripting''': For information on how to script items, go here.<br />
<br />
'''Examples''': A standard longsword would be, '''Tag''': abr_it_wpn_longsword '''ResRef''': abr_it_wpn_longword_01<br />
<br />
=Materials=<br />
* Abyssal Bloodiron ay<br />
* Adamantine ad<br />
* Alchemical Silver sa<br />
* Arandur aa<br />
* Astral Driftmetal as<br />
* Aurorum au<br />
* Bluewood bw<br />
* Cold Iron ci<br />
* Copper co<br />
* Darksteel dk<br />
* Darkwood (Zalantar) za<br />
* Dlarun dl<br />
* Dragonbone db<br />
* Dragonfang df<br />
* Dragonhide dh<br />
* Dragonscale ds<br />
* Duskwood du<br />
* Fever Iron fr<br />
* Fiendbone fb<br />
* Frystalline fy<br />
* Gold go<br />
* Hide hi<br />
* Hizagkuur hz<br />
* Laminated Steel ls<br />
* Living Metal lm<br />
* Mithral mi<br />
* Obsidian ob<br />
* Pandemonic Silver ps<br />
* Platinum pt<br />
* Serren se<br />
* Silver sv<br />
* Solarian Truesteel tr<br />
* Sondarr so<br />
* Suzailian Chainweave ch<br />
* Weirwood ww<br />
* Ysgardian Heartwire ys<br />
<br />
=Quality=<br />
* Arcane Spell Failure -10% asf1<br />
* Drowcraft dc<br />
* Masterwork mw<br />
* Plus one e1<br />
* Poor po<br />
* Armour Class +1 ac1<br />
* Bonus Spell, Level 0 sb0<br />
* Bonus Spell, Levels 0, 1, 2 sb012<br />
* Damage Resistance 1 dr1<br />
* Damage Resistance 5/magic dr5m<br />
* Damage Resistance Fire 5 drf5<br />
* Feat: Alertness fale<br />
* Feat: Ambidexterity famb<br />
* Feat: Combat Casting fcca<br />
* Feat: Darkvision fdar<br />
* Feat: Dodge fdod<br />
* Feat: Extra Turning fext<br />
* Feat: Mobility fmob<br />
* Feat: Spell Focus (One) fsf1<br />
* Feat: Spell Penetration fpen<br />
* Feat: Two Weapon Fighting ftwf<br />
* Feat: Weapon Finesse fwfi<br />
* Spell Immunity, Level 0 si0<br />
* Spell Resistance 12 sr12<br />
* Freedom of Movement fom<br />
* Immunity: Death Magic ide<br />
* Immunity: Disease idi<br />
* Immunity: Drain idr<br />
* Immunity: Fear ife<br />
* Immunity: Gas iga<br />
* Immunity: Magic Missle imm<br />
* Immunity: Paralysis ipa<br />
* Immunity: Poison ipo<br />
* Save, Acid +1 sac1<br />
* Save, Cold +1 sco1<br />
* Save, Death +1 sde1<br />
* Save, Disease +1 sds1<br />
* Save, Fear +1 sfe1<br />
* Save, Fire +1 sfi1<br />
* Save, Fort +1 sfo1<br />
* Save, Mind +1 smi1<br />
* Save, Negative +1 sne1<br />
* Save, Poison +1 spo1<br />
* Save, Reflex +1 sre1<br />
* Save, Sonic +1 sso1<br />
* Save, Universal +1 sa1<br />
* Save, Will +1 swi1<br />
* Hide +1 hi1<br />
* Damage, Acid +1 da1<br />
* Damage, Bludgeoning +1 db1<br />
* Damage, Cold +1 dc1<br />
* Damage, Divine +1 dd1<br />
* Damage, Fire +1 df1<br />
* Damage, Magic +1 dm1<br />
* Damage, Negative +1 dn1<br />
* Damage, Piercing +1 dp1<br />
* Damage, Slashing +1 ds1<br />
* Damage, Sonic +1 do1<br />
* Feat: Cleave fcle<br />
* Feat: Disarm fdis<br />
* Feat: Improved Critical ficr<br />
* Feat: Point Blank Shot fpbs<br />
* Feat: Rapid Shot frap<br />
* Feat: Weapon Specialisation fwsp<br />
* Keen ke<br />
* Massive Criticals +1 mc1<br />
* Mighty +1 m1<br />
* Sure Striking sst<br />
* Vampiric +1 dv1<br />
* Wounding +1 dw1<br />
<br />
This is added in the toolset with a string separated by the '|' character for each category. The HDMs of every server are free to make their own rules as too where items should be placed, but be aware the DM client cannot see more than one step "deep" into the category tree.<br />
<br />
= Detect Magic =<br />
Most magical items will automatically register to Detect Magic correctly. The spell looks at the item's properties and cross-references spell effects and enhancements against 2DA information to assign the proper school and spell power.<br />
The following are advanced options for items without properties or for which you want to register an aura in addition to what Detect Magic cross-references from item properties.<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the item should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For items that use an i_tag_eventsuffix script to be called on a Cast Spell: Unique Power event, the automatic report to the caster will read only "Something has an aura too complex to be understood immediately." If you want the item to register a spell aura in addition to that message, you must place the above variables.<br />
<br />
For instance, for a uniquely scripted Hairbrush using the i_tag_ac that fires on activate to perform a uniquely scripted buff to CHA that simulates a casting of Eagle's Splendor as well as actions or effects you couldn't get by just adding Cast Spell: Eagle's Splendor to the Hairbrush, you would set ACR_SPELLSCHOOL to 8 and ACR_SPELLPOWER to 2. <br />
<br />
If the caster passes a spellcraft check, in addition to the "Too Complex" message generated by the fact of the unique power event, if the item was loose on the floor this would return a message that reads "Hairbrush has a Faint aura of Transmutation", or "Something in the Cabinet's inventory (or Princess Penelope Prettygirl's inventory) has a Faint aura of Transmutation" if the hairbrush is in something/somebody's inventory. <br />
<br />
If the caster does not pass the spellcraft check, s/he doesn't get the school of magic. The item returns only"Hairbrush has a Faint aura" or "Something in X's inventory has a Faint aura."<br />
<br />
= Item Tips =<br />
* When creating Creature items, make sure the item is checked as identified, otherwise the creature cannot equip or use the item.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Items&diff=3940Building Items2023-01-30T22:03:55Z<p>Wynna: /* ITEM TIPS */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
All items should be priced according to 3.5 edition canon (Player's Hand Book, Dungeon Master's Guide, etc), and to the ALFA specific exceptions set forth by ALFA [[Standards]]. '''Do not make items worth less than 1gp yet!''' Our currency system for silver and copper pieces is not yet ready, and we may not know how it will work until we have the client in our hands.<br />
<br />
'''Premise''': An item should be identifiable from it's tag/resref.<br />
<br />
'''<prefix>_it_<type>_<description>_<ID>'''<br />
<br />
'''<prefix>''' is either "abr" (minus the quotes) for default ALFA items, or a three digit code of the server.<br />
<br />
'''<type>''' is a three-letter abbreviation describing the slot occupied by the item.<br />
<br />
'''<description>''' is the number of fields necessary to describe any additional properties on the item.<br />
<br />
'''<ID>''' is an optional two-digit number used to distinguish items with identical properties. Leave the <ID> off of tags - it goes on resrefs only.<br />
<br />
Item tags should NEVER be longer than 28 characters. The game allows 32, so don't use them all.<br />
<br />
'''Scripting''': For information on how to script items, go here.<br />
<br />
'''Examples''': A standard longsword would be, '''Tag''': abr_it_wpn_longsword '''ResRef''': abr_it_wpn_longword_01<br />
<br />
'''Materials'''<br />
* Abyssal Bloodiron ay<br />
* Adamantine ad<br />
* Alchemical Silver sa<br />
* Arandur aa<br />
* Astral Driftmetal as<br />
* Aurorum au<br />
* Bluewood bw<br />
* Cold Iron ci<br />
* Copper co<br />
* Darksteel dk<br />
* Darkwood (Zalantar) za<br />
* Dlarun dl<br />
* Dragonbone db<br />
* Dragonfang df<br />
* Dragonhide dh<br />
* Dragonscale ds<br />
* Duskwood du<br />
* Fever Iron fr<br />
* Fiendbone fb<br />
* Frystalline fy<br />
* Gold go<br />
* Hide hi<br />
* Hizagkuur hz<br />
* Laminated Steel ls<br />
* Living Metal lm<br />
* Mithral mi<br />
* Obsidian ob<br />
* Pandemonic Silver ps<br />
* Platinum pt<br />
* Serren se<br />
* Silver sv<br />
* Solarian Truesteel tr<br />
* Sondarr so<br />
* Suzailian Chainweave ch<br />
* Weirwood ww<br />
* Ysgardian Heartwire ys<br />
<br />
'''Quality'''<br />
* Arcane Spell Failure -10% asf1<br />
* Drowcraft dc<br />
* Masterwork mw<br />
* Plus one e1<br />
* Poor po<br />
* Armour Class +1 ac1<br />
* Bonus Spell, Level 0 sb0<br />
* Bonus Spell, Levels 0, 1, 2 sb012<br />
* Damage Resistance 1 dr1<br />
* Damage Resistance 5/magic dr5m<br />
* Damage Resistance Fire 5 drf5<br />
* Feat: Alertness fale<br />
* Feat: Ambidexterity famb<br />
* Feat: Combat Casting fcca<br />
* Feat: Darkvision fdar<br />
* Feat: Dodge fdod<br />
* Feat: Extra Turning fext<br />
* Feat: Mobility fmob<br />
* Feat: Spell Focus (One) fsf1<br />
* Feat: Spell Penetration fpen<br />
* Feat: Two Weapon Fighting ftwf<br />
* Feat: Weapon Finesse fwfi<br />
* Spell Immunity, Level 0 si0<br />
* Spell Resistance 12 sr12<br />
* Freedom of Movement fom<br />
* Immunity: Death Magic ide<br />
* Immunity: Disease idi<br />
* Immunity: Drain idr<br />
* Immunity: Fear ife<br />
* Immunity: Gas iga<br />
* Immunity: Magic Missle imm<br />
* Immunity: Paralysis ipa<br />
* Immunity: Poison ipo<br />
* Save, Acid +1 sac1<br />
* Save, Cold +1 sco1<br />
* Save, Death +1 sde1<br />
* Save, Disease +1 sds1<br />
* Save, Fear +1 sfe1<br />
* Save, Fire +1 sfi1<br />
* Save, Fort +1 sfo1<br />
* Save, Mind +1 smi1<br />
* Save, Negative +1 sne1<br />
* Save, Poison +1 spo1<br />
* Save, Reflex +1 sre1<br />
* Save, Sonic +1 sso1<br />
* Save, Universal +1 sa1<br />
* Save, Will +1 swi1<br />
* Hide +1 hi1<br />
* Damage, Acid +1 da1<br />
* Damage, Bludgeoning +1 db1<br />
* Damage, Cold +1 dc1<br />
* Damage, Divine +1 dd1<br />
* Damage, Fire +1 df1<br />
* Damage, Magic +1 dm1<br />
* Damage, Negative +1 dn1<br />
* Damage, Piercing +1 dp1<br />
* Damage, Slashing +1 ds1<br />
* Damage, Sonic +1 do1<br />
* Feat: Cleave fcle<br />
* Feat: Disarm fdis<br />
* Feat: Improved Critical ficr<br />
* Feat: Point Blank Shot fpbs<br />
* Feat: Rapid Shot frap<br />
* Feat: Weapon Specialisation fwsp<br />
* Keen ke<br />
* Massive Criticals +1 mc1<br />
* Mighty +1 m1<br />
* Sure Striking sst<br />
* Vampiric +1 dv1<br />
* Wounding +1 dw1<br />
<br />
This is added in the toolset with a string separated by the '|' character for each category. The HDMs of every server are free to make their own rules as too where items should be placed, but be aware the DM client cannot see more than one step "deep" into the category tree.<br />
<br />
= Detect Magic =<br />
Most magical items will automatically register to Detect Magic correctly. The spell looks at the item's properties and cross-references spell effects and enhancements against 2DA information to assign the proper school and spell power.<br />
The following are advanced options for items without properties or for which you want to register an aura in addition to what Detect Magic cross-references from item properties.<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the item should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For items that use an i_tag_eventsuffix script to be called on a Cast Spell: Unique Power event, the automatic report to the caster will read only "Something has an aura too complex to be understood immediately." If you want the item to register a spell aura in addition to that message, you must place the above variables.<br />
<br />
For instance, for a uniquely scripted Hairbrush using the i_tag_ac that fires on activate to perform a uniquely scripted buff to CHA that simulates a casting of Eagle's Splendor as well as actions or effects you couldn't get by just adding Cast Spell: Eagle's Splendor to the Hairbrush, you would set ACR_SPELLSCHOOL to 8 and ACR_SPELLPOWER to 2. <br />
<br />
If the caster passes a spellcraft check, in addition to the "Too Complex" message generated by the fact of the unique power event, if the item was loose on the floor this would return a message that reads "Hairbrush has a Faint aura of Transmutation", or "Something in the Cabinet's inventory (or Princess Penelope Prettygirl's inventory) has a Faint aura of Transmutation" if the hairbrush is in something/somebody's inventory. <br />
<br />
If the caster does not pass the spellcraft check, s/he doesn't get the school of magic. The item returns only"Hairbrush has a Faint aura" or "Something in X's inventory has a Faint aura."<br />
<br />
= Item Tips =<br />
* When creating Creature items, make sure the item is checked as identified, otherwise the creature cannot equip or use the item.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Items&diff=3939Building Items2023-01-30T22:03:32Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
All items should be priced according to 3.5 edition canon (Player's Hand Book, Dungeon Master's Guide, etc), and to the ALFA specific exceptions set forth by ALFA [[Standards]]. '''Do not make items worth less than 1gp yet!''' Our currency system for silver and copper pieces is not yet ready, and we may not know how it will work until we have the client in our hands.<br />
<br />
'''Premise''': An item should be identifiable from it's tag/resref.<br />
<br />
'''<prefix>_it_<type>_<description>_<ID>'''<br />
<br />
'''<prefix>''' is either "abr" (minus the quotes) for default ALFA items, or a three digit code of the server.<br />
<br />
'''<type>''' is a three-letter abbreviation describing the slot occupied by the item.<br />
<br />
'''<description>''' is the number of fields necessary to describe any additional properties on the item.<br />
<br />
'''<ID>''' is an optional two-digit number used to distinguish items with identical properties. Leave the <ID> off of tags - it goes on resrefs only.<br />
<br />
Item tags should NEVER be longer than 28 characters. The game allows 32, so don't use them all.<br />
<br />
'''Scripting''': For information on how to script items, go here.<br />
<br />
'''Examples''': A standard longsword would be, '''Tag''': abr_it_wpn_longsword '''ResRef''': abr_it_wpn_longword_01<br />
<br />
'''Materials'''<br />
* Abyssal Bloodiron ay<br />
* Adamantine ad<br />
* Alchemical Silver sa<br />
* Arandur aa<br />
* Astral Driftmetal as<br />
* Aurorum au<br />
* Bluewood bw<br />
* Cold Iron ci<br />
* Copper co<br />
* Darksteel dk<br />
* Darkwood (Zalantar) za<br />
* Dlarun dl<br />
* Dragonbone db<br />
* Dragonfang df<br />
* Dragonhide dh<br />
* Dragonscale ds<br />
* Duskwood du<br />
* Fever Iron fr<br />
* Fiendbone fb<br />
* Frystalline fy<br />
* Gold go<br />
* Hide hi<br />
* Hizagkuur hz<br />
* Laminated Steel ls<br />
* Living Metal lm<br />
* Mithral mi<br />
* Obsidian ob<br />
* Pandemonic Silver ps<br />
* Platinum pt<br />
* Serren se<br />
* Silver sv<br />
* Solarian Truesteel tr<br />
* Sondarr so<br />
* Suzailian Chainweave ch<br />
* Weirwood ww<br />
* Ysgardian Heartwire ys<br />
<br />
'''Quality'''<br />
* Arcane Spell Failure -10% asf1<br />
* Drowcraft dc<br />
* Masterwork mw<br />
* Plus one e1<br />
* Poor po<br />
* Armour Class +1 ac1<br />
* Bonus Spell, Level 0 sb0<br />
* Bonus Spell, Levels 0, 1, 2 sb012<br />
* Damage Resistance 1 dr1<br />
* Damage Resistance 5/magic dr5m<br />
* Damage Resistance Fire 5 drf5<br />
* Feat: Alertness fale<br />
* Feat: Ambidexterity famb<br />
* Feat: Combat Casting fcca<br />
* Feat: Darkvision fdar<br />
* Feat: Dodge fdod<br />
* Feat: Extra Turning fext<br />
* Feat: Mobility fmob<br />
* Feat: Spell Focus (One) fsf1<br />
* Feat: Spell Penetration fpen<br />
* Feat: Two Weapon Fighting ftwf<br />
* Feat: Weapon Finesse fwfi<br />
* Spell Immunity, Level 0 si0<br />
* Spell Resistance 12 sr12<br />
* Freedom of Movement fom<br />
* Immunity: Death Magic ide<br />
* Immunity: Disease idi<br />
* Immunity: Drain idr<br />
* Immunity: Fear ife<br />
* Immunity: Gas iga<br />
* Immunity: Magic Missle imm<br />
* Immunity: Paralysis ipa<br />
* Immunity: Poison ipo<br />
* Save, Acid +1 sac1<br />
* Save, Cold +1 sco1<br />
* Save, Death +1 sde1<br />
* Save, Disease +1 sds1<br />
* Save, Fear +1 sfe1<br />
* Save, Fire +1 sfi1<br />
* Save, Fort +1 sfo1<br />
* Save, Mind +1 smi1<br />
* Save, Negative +1 sne1<br />
* Save, Poison +1 spo1<br />
* Save, Reflex +1 sre1<br />
* Save, Sonic +1 sso1<br />
* Save, Universal +1 sa1<br />
* Save, Will +1 swi1<br />
* Hide +1 hi1<br />
* Damage, Acid +1 da1<br />
* Damage, Bludgeoning +1 db1<br />
* Damage, Cold +1 dc1<br />
* Damage, Divine +1 dd1<br />
* Damage, Fire +1 df1<br />
* Damage, Magic +1 dm1<br />
* Damage, Negative +1 dn1<br />
* Damage, Piercing +1 dp1<br />
* Damage, Slashing +1 ds1<br />
* Damage, Sonic +1 do1<br />
* Feat: Cleave fcle<br />
* Feat: Disarm fdis<br />
* Feat: Improved Critical ficr<br />
* Feat: Point Blank Shot fpbs<br />
* Feat: Rapid Shot frap<br />
* Feat: Weapon Specialisation fwsp<br />
* Keen ke<br />
* Massive Criticals +1 mc1<br />
* Mighty +1 m1<br />
* Sure Striking sst<br />
* Vampiric +1 dv1<br />
* Wounding +1 dw1<br />
<br />
This is added in the toolset with a string separated by the '|' character for each category. The HDMs of every server are free to make their own rules as too where items should be placed, but be aware the DM client cannot see more than one step "deep" into the category tree.<br />
<br />
= Detect Magic =<br />
Most magical items will automatically register to Detect Magic correctly. The spell looks at the item's properties and cross-references spell effects and enhancements against 2DA information to assign the proper school and spell power.<br />
The following are advanced options for items without properties or for which you want to register an aura in addition to what Detect Magic cross-references from item properties.<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the item should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For items that use an i_tag_eventsuffix script to be called on a Cast Spell: Unique Power event, the automatic report to the caster will read only "Something has an aura too complex to be understood immediately." If you want the item to register a spell aura in addition to that message, you must place the above variables.<br />
<br />
For instance, for a uniquely scripted Hairbrush using the i_tag_ac that fires on activate to perform a uniquely scripted buff to CHA that simulates a casting of Eagle's Splendor as well as actions or effects you couldn't get by just adding Cast Spell: Eagle's Splendor to the Hairbrush, you would set ACR_SPELLSCHOOL to 8 and ACR_SPELLPOWER to 2. <br />
<br />
If the caster passes a spellcraft check, in addition to the "Too Complex" message generated by the fact of the unique power event, if the item was loose on the floor this would return a message that reads "Hairbrush has a Faint aura of Transmutation", or "Something in the Cabinet's inventory (or Princess Penelope Prettygirl's inventory) has a Faint aura of Transmutation" if the hairbrush is in something/somebody's inventory. <br />
<br />
If the caster does not pass the spellcraft check, s/he doesn't get the school of magic. The item returns only"Hairbrush has a Faint aura" or "Something in X's inventory has a Faint aura."<br />
<br />
== ITEM TIPS ==<br />
* When creating Creature items, make sure the item is checked as identified, otherwise the creature cannot equip or use the item.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Items&diff=3938Building Items2023-01-30T22:03:08Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
All items should be priced according to 3.5 edition canon (Player's Hand Book, Dungeon Master's Guide, etc), and to the ALFA specific exceptions set forth by ALFA [[Standards]]. '''Do not make items worth less than 1gp yet!''' Our currency system for silver and copper pieces is not yet ready, and we may not know how it will work until we have the client in our hands.<br />
<br />
'''Premise''': An item should be identifiable from it's tag/resref.<br />
<br />
'''<prefix>_it_<type>_<description>_<ID>'''<br />
<br />
'''<prefix>''' is either "abr" (minus the quotes) for default ALFA items, or a three digit code of the server.<br />
<br />
'''<type>''' is a three-letter abbreviation describing the slot occupied by the item.<br />
<br />
'''<description>''' is the number of fields necessary to describe any additional properties on the item.<br />
<br />
'''<ID>''' is an optional two-digit number used to distinguish items with identical properties. Leave the <ID> off of tags - it goes on resrefs only.<br />
<br />
Item tags should NEVER be longer than 28 characters. The game allows 32, so don't use them all.<br />
<br />
'''Scripting''': For information on how to script items, go here.<br />
<br />
'''Examples''': A standard longsword would be, '''Tag''': abr_it_wpn_longsword '''ResRef''': abr_it_wpn_longword_01<br />
<br />
'''Materials'''<br />
* Abyssal Bloodiron ay<br />
* Adamantine ad<br />
* Alchemical Silver sa<br />
* Arandur aa<br />
* Astral Driftmetal as<br />
* Aurorum au<br />
* Bluewood bw<br />
* Cold Iron ci<br />
* Copper co<br />
* Darksteel dk<br />
* Darkwood (Zalantar) za<br />
* Dlarun dl<br />
* Dragonbone db<br />
* Dragonfang df<br />
* Dragonhide dh<br />
* Dragonscale ds<br />
* Duskwood du<br />
* Fever Iron fr<br />
* Fiendbone fb<br />
* Frystalline fy<br />
* Gold go<br />
* Hide hi<br />
* Hizagkuur hz<br />
* Laminated Steel ls<br />
* Living Metal lm<br />
* Mithral mi<br />
* Obsidian ob<br />
* Pandemonic Silver ps<br />
* Platinum pt<br />
* Serren se<br />
* Silver sv<br />
* Solarian Truesteel tr<br />
* Sondarr so<br />
* Suzailian Chainweave ch<br />
* Weirwood ww<br />
* Ysgardian Heartwire ys<br />
<br />
'''Quality'''<br />
* Arcane Spell Failure -10% asf1<br />
* Drowcraft dc<br />
* Masterwork mw<br />
* Plus one e1<br />
* Poor po<br />
* Armour Class +1 ac1<br />
* Bonus Spell, Level 0 sb0<br />
* Bonus Spell, Levels 0, 1, 2 sb012<br />
* Damage Resistance 1 dr1<br />
* Damage Resistance 5/magic dr5m<br />
* Damage Resistance Fire 5 drf5<br />
* Feat: Alertness fale<br />
* Feat: Ambidexterity famb<br />
* Feat: Combat Casting fcca<br />
* Feat: Darkvision fdar<br />
* Feat: Dodge fdod<br />
* Feat: Extra Turning fext<br />
* Feat: Mobility fmob<br />
* Feat: Spell Focus (One) fsf1<br />
* Feat: Spell Penetration fpen<br />
* Feat: Two Weapon Fighting ftwf<br />
* Feat: Weapon Finesse fwfi<br />
* Spell Immunity, Level 0 si0<br />
* Spell Resistance 12 sr12<br />
* Freedom of Movement fom<br />
* Immunity: Death Magic ide<br />
* Immunity: Disease idi<br />
* Immunity: Drain idr<br />
* Immunity: Fear ife<br />
* Immunity: Gas iga<br />
* Immunity: Magic Missle imm<br />
* Immunity: Paralysis ipa<br />
* Immunity: Poison ipo<br />
* Save, Acid +1 sac1<br />
* Save, Cold +1 sco1<br />
* Save, Death +1 sde1<br />
* Save, Disease +1 sds1<br />
* Save, Fear +1 sfe1<br />
* Save, Fire +1 sfi1<br />
* Save, Fort +1 sfo1<br />
* Save, Mind +1 smi1<br />
* Save, Negative +1 sne1<br />
* Save, Poison +1 spo1<br />
* Save, Reflex +1 sre1<br />
* Save, Sonic +1 sso1<br />
* Save, Universal +1 sa1<br />
* Save, Will +1 swi1<br />
* Hide +1 hi1<br />
* Damage, Acid +1 da1<br />
* Damage, Bludgeoning +1 db1<br />
* Damage, Cold +1 dc1<br />
* Damage, Divine +1 dd1<br />
* Damage, Fire +1 df1<br />
* Damage, Magic +1 dm1<br />
* Damage, Negative +1 dn1<br />
* Damage, Piercing +1 dp1<br />
* Damage, Slashing +1 ds1<br />
* Damage, Sonic +1 do1<br />
* Feat: Cleave fcle<br />
* Feat: Disarm fdis<br />
* Feat: Improved Critical ficr<br />
* Feat: Point Blank Shot fpbs<br />
* Feat: Rapid Shot frap<br />
* Feat: Weapon Specialisation fwsp<br />
* Keen ke<br />
* Massive Criticals +1 mc1<br />
* Mighty +1 m1<br />
* Sure Striking sst<br />
* Vampiric +1 dv1<br />
* Wounding +1 dw1<br />
<br />
This is added in the toolset with a string separated by the '|' character for each category. The HDMs of every server are free to make their own rules as too where items should be placed, but be aware the DM client cannot see more than one step "deep" into the category tree.<br />
<br />
=== Detect Magic ===<br />
Most magical items will automatically register to Detect Magic correctly. The spell looks at the item's properties and cross-references spell effects and enhancements against 2DA information to assign the proper school and spell power.<br />
The following are advanced options for items without properties or for which you want to register an aura in addition to what Detect Magic cross-references from item properties.<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the item should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the trigger should register an aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the trigger should register a second aura not automatically determined by item properties to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
For items that use an i_tag_eventsuffix script to be called on a Cast Spell: Unique Power event, the automatic report to the caster will read only "Something has an aura too complex to be understood immediately." If you want the item to register a spell aura in addition to that message, you must place the above variables.<br />
<br />
For instance, for a uniquely scripted Hairbrush using the i_tag_ac that fires on activate to perform a uniquely scripted buff to CHA that simulates a casting of Eagle's Splendor as well as actions or effects you couldn't get by just adding Cast Spell: Eagle's Splendor to the Hairbrush, you would set ACR_SPELLSCHOOL to 8 and ACR_SPELLPOWER to 2. <br />
<br />
If the caster passes a spellcraft check, in addition to the "Too Complex" message generated by the fact of the unique power event, if the item was loose on the floor this would return a message that reads "Hairbrush has a Faint aura of Transmutation", or "Something in the Cabinet's inventory (or Princess Penelope Prettygirl's inventory) has a Faint aura of Transmutation" if the hairbrush is in something/somebody's inventory. <br />
<br />
If the caster does not pass the spellcraft check, s/he doesn't get the school of magic. The item returns only"Hairbrush has a Faint aura" or "Something in X's inventory has a Faint aura."<br />
<br />
== ITEM TIPS ==<br />
* When creating Creature items, make sure the item is checked as identified, otherwise the creature cannot equip or use the item.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Doors&diff=3937Building Doors2023-01-30T22:02:23Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
While the basemod contains every door listed in the DMG with appropriate settings, builders may wish to create their own doors. ALFA has scripts which provide a number of mechanics not ordinarily found in NWN, and every door has an extra set of options because of this.<br />
<br />
As with creating new creatures, items, and so forth, the easiest way to make a new door is to copy/edit an existing one. For information on editing the settings of an existing door, skip the next section.<br />
<br />
== Creating a New Door ==<br />
If you aren't editing an existing door, you will have to configure a number of options. To start off with, you'll need to make sure all of the door's event scripts are set correctly. ALFA's event scripts for doors are as follows: // Update for longer NWN2 file names<br />
* <code>acf_door_onclosed</code><br />
* <code>acf_door_onconversation</code><br />
* <code>acf_door_ondamaged</code><br />
* <code>acf_door_ondeath</code><br />
* <code>acf_door_ondisarm</code><br />
* <code>acf_door_onheartbeat</code><br />
* <code>acf_door_onlock</code><br />
* <code>acf_door_onmeleeattacked</code><br />
* <code>acf_door_onopen</code><br />
* <code>acf_door_onspellcastat</code><br />
* <code>acf_door_ontraptriggered</code><br />
* <code>acf_door_onunlock</code><br />
* <code>acf_door_onused</code><br />
* <code>acf_door_onuserdefined</code><br />
* <code>acf_door_onclick</code><br />
* <code>acf_door_onfailtoopen</code><br />
<br />
If you want to add custom event scripts to your doors, you can of course do so. Just make sure each event script includes the file [[acr_door_i.nss]], and calls the appropriate function for that event, listed here.<br />
* <code>ACR_DoorOnClosed()</code><br />
* <code>ACR_DoorOnConversation()</code><br />
* <code>ACR_DoorOnDamaged()</code><br />
* <code>ACR_DoorOnDeath()</code><br />
* <code>ACR_DoorOnDisarm()</code><br />
* <code>ACR_DoorOnHeartbeat()</code><br />
* <code>ACR_DoorOnLock()</code><br />
* <code>ACR_DoorOnMeleeAttacked()</code><br />
* <code>ACR_DoorOnOpen()</code><br />
* <code>ACR_DoorOnSpellCastAt()</code><br />
* <code>ACR_DoorOnTrapTriggered()</code><br />
* <code>ACR_DoorOnUnlock()</code><br />
* <code>ACR_DoorOnUsed()</code><br />
* <code>ACR_DoorOnUserDefined()</code><br />
* <code>ACR_DoorOnClick()</code><br />
* <code>ACR_DoorOnFailToOpen()</code><br />
<br />
Again, the easiest way to do this is to edit an existing acr_door_* file and save it under a different name. Failure to properly call ALFA's door scripts can break multiple systems of the ACR. So make sure you've got them in there.<br />
<br />
= Editing Door Settings =<br />
: ''See also: [[Using Local Variables]]<br />
Aside from the standard NWN options of doors, we've provided a few more to give PCs and builders more options. These options can be accessed by editing the door's local variables.<br />
* <code>'''ACR_DOOR_CLOSE_DELAY'''</code> (float) The number of seconds a door will stay open before automatically closing itself. If set to zero or less than zero, the door will not close itself automatically.<br />
* <code>'''ACR_DOOR_CLOSE_NEAR_PCS'''</code> (integer) If set to 1, the door will auto-close regardless of any nearby PCs. If set to 0 (the default), the door will wait until PCs are out of visual range before closing itself.<br />
* <code>'''ACR_DOOR_STUCK_DC'''</code> (integer) If non-zero, the door is considered "stuck", and therefore cannot be opened unless forced. The value defined is the strength-check DC to "un-stick" the door. If someone tries to force a locked and stuck door open, the strength DC used is the higher of this value and <code>'''ACR_DOOR_BREAK_DC'''</code>. The default value is 0.<br />
* <code>'''ACR_DOOR_BREAK_DC'''</code> (integer) The DC to break open this door, as per DMG rules. Breaking open a door does not destroy it like doing damage to it would in NWN, but it does keep the door from being able to be locked again. If this value is zero, the door cannot be forced open. Valid values are from 0 to 255.<br />
* <code>'''ACR_DOOR_FAIL_OPEN_MESSAGE'''</code> (string) This is a custom message sent to PCs who try to open the door and fail. This can be used in conjunction with * <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> to setup doors that require a spoken password to access (even useful for door riddles).<br />
* <code>'''ACR_DOOR_OPEN_MESSAGE'''</code> (string) This message is "spoken" by the door when it is opened. It is usually used to give the PCs a description of the area beyond an AT, if any.<br />
* <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door unlocks itself. Generally used for shops and things which are only open during certain hours of the day. It will only unlock once, so if something else locks it afterwards, it will remain locked until either another creature unlocks it, or its next unlock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_LOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_LOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door locks itself. Generally used for shops and things which are only open during certain hours of the day. It will only lock once, so if something else unlocks it afterwards, it will remain unlocked until either another creature locks it, or its next lock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_UNLOCK_SPELLID'''</code> (int) This is the Spell ID for doors that require a specific spell to unlock. This will only work for spell IDs greater than 0. Be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> (string) This is what a player must speak to gain access to a password protected door. Leave this empty to require no password. Otherwise, be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_AUTO_LOCK'''</code> (integer) If non-zero, the door will automatically lock itself each time it is shut.<br />
* <code>'''ACR_DOOR_LISTEN_DC_MOD'''</code> (integer) This modifier is applied to creatures trying to listen to conversations occuring behind a closed doors. The DMG lists this a +5 for every door, but some customization is allowed for different door types. If undefined or set to 0, the door cannot be listened through.<br />
* <code>'''ACR_DOOR_KNOCK_IMMUNE'''</code> (integer) If nonzero, this door is immune to the spell knock. If zero, it is not immune.<br />
* <code>'''ACR_DOOR_UNMOVABLE'''</code> (integer) If nonzero, the door cannot be opened or closed by a non-DM creature, even if unlocked. Scripts can still open or close it, however. This setting is often used to represent large doors which a PC could not realistically close on their own even if they were unlocked, like the huge gates on castles and other fortifications.<br />
* <code>'''ACR_AT_SIZE'''</code> (integer) If nonzero, this setting specifies the maximum sized creature which can fit through this doorway. Anything large will be given a message saying it is too large to fit inside. Valid values are as follows:<br />
*# Fine<br />
*# Diminutive<br />
*# Tiny<br />
*# Small<br />
*# Medium<br />
*# Large<br />
*# Huge<br />
*# Gargantuan<br />
*# Colossal<br />
<br />
Note that currently, NWN2 does not support creature sizes of fine, diminutive, gargantuan or colossal. These values are provided here for future compatibility.<br />
<br />
Note that if none of these variables are defined, they default to zero. So a door without them would never close or lock itself, wouldn't be stuck or barred at all, would not be able to be forced open, and wouldn't have any sort of a custom message printed if a PC failed to open it.<br />
<br />
= Detect Magic =<br />
These are advanced options for doors to register as magical to Detect Magic. A door with these variables will report to the caster if the caster passes spellcraft checks based on the power of the spell. For instance: "Abjuration Dorm has a Faint aura of Transmutation."<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the [https://www.alandfaraway.info/wiki/Detect_Magic#SpellSchool_Variables Detect Magic: SpellSchool Variables] page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
=Tips/Troubleshooting=<br />
<br />
* If your doorway does not seem to function properly:<br />
*- make sure the doorway is within a walkmesh area<br />
*- make sure there is no open doorway behind it, as in a tileset doorway vs a placeable doorway<br />
*- a door must have current hit points >0 for it to function<br />
*- If your static door looks fine in the toolset but does not fill the doorway ingame, the door model defaults in static mode. Instead do not make door static and set it to locked, requires key to open to get it to look right ingame. This is especially true when you have changed the size of the door to fit the doorway. Some models work better than others. There are now placeable doors also available in the toolset.<br />
*- If a Half-orc cannot got through your AT make sure the receiving end is not set to position lock. Also make sure there is plenty of cleared space around the receiving door. Too little space will keep orcs and half-orcs from being able to traverse the doorway.<br />
* When resizing doors scales 1st and 2nd should be the same size. Otherwise your door will be a weird size when it opens. This how ever might be a useful trick when you want to emulate a door folding up or to the side.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Doors&diff=3936Building Doors2023-01-30T22:00:24Z<p>Wynna: /* Editing Door Settings */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
While the basemod contains every door listed in the DMG with appropriate settings, builders may wish to create their own doors. ALFA has scripts which provide a number of mechanics not ordinarily found in NWN, and every door has an extra set of options because of this.<br />
<br />
As with creating new creatures, items, and so forth, the easiest way to make a new door is to copy/edit an existing one. For information on editing the settings of an existing door, skip the next section.<br />
<br />
== Creating a New Door ==<br />
If you aren't editing an existing door, you will have to configure a number of options. To start off with, you'll need to make sure all of the door's event scripts are set correctly. ALFA's event scripts for doors are as follows: // Update for longer NWN2 file names<br />
* <code>acf_door_onclosed</code><br />
* <code>acf_door_onconversation</code><br />
* <code>acf_door_ondamaged</code><br />
* <code>acf_door_ondeath</code><br />
* <code>acf_door_ondisarm</code><br />
* <code>acf_door_onheartbeat</code><br />
* <code>acf_door_onlock</code><br />
* <code>acf_door_onmeleeattacked</code><br />
* <code>acf_door_onopen</code><br />
* <code>acf_door_onspellcastat</code><br />
* <code>acf_door_ontraptriggered</code><br />
* <code>acf_door_onunlock</code><br />
* <code>acf_door_onused</code><br />
* <code>acf_door_onuserdefined</code><br />
* <code>acf_door_onclick</code><br />
* <code>acf_door_onfailtoopen</code><br />
<br />
If you want to add custom event scripts to your doors, you can of course do so. Just make sure each event script includes the file [[acr_door_i.nss]], and calls the appropriate function for that event, listed here.<br />
* <code>ACR_DoorOnClosed()</code><br />
* <code>ACR_DoorOnConversation()</code><br />
* <code>ACR_DoorOnDamaged()</code><br />
* <code>ACR_DoorOnDeath()</code><br />
* <code>ACR_DoorOnDisarm()</code><br />
* <code>ACR_DoorOnHeartbeat()</code><br />
* <code>ACR_DoorOnLock()</code><br />
* <code>ACR_DoorOnMeleeAttacked()</code><br />
* <code>ACR_DoorOnOpen()</code><br />
* <code>ACR_DoorOnSpellCastAt()</code><br />
* <code>ACR_DoorOnTrapTriggered()</code><br />
* <code>ACR_DoorOnUnlock()</code><br />
* <code>ACR_DoorOnUsed()</code><br />
* <code>ACR_DoorOnUserDefined()</code><br />
* <code>ACR_DoorOnClick()</code><br />
* <code>ACR_DoorOnFailToOpen()</code><br />
<br />
Again, the easiest way to do this is to edit an existing acr_door_* file and save it under a different name. Failure to properly call ALFA's door scripts can break multiple systems of the ACR. So make sure you've got them in there.<br />
<br />
= Editing Door Settings =<br />
: ''See also: [[Using Local Variables]]<br />
Aside from the standard NWN options of doors, we've provided a few more to give PCs and builders more options. These options can be accessed by editing the door's local variables.<br />
* <code>'''ACR_DOOR_CLOSE_DELAY'''</code> (float) The number of seconds a door will stay open before automatically closing itself. If set to zero or less than zero, the door will not close itself automatically.<br />
* <code>'''ACR_DOOR_CLOSE_NEAR_PCS'''</code> (integer) If set to 1, the door will auto-close regardless of any nearby PCs. If set to 0 (the default), the door will wait until PCs are out of visual range before closing itself.<br />
* <code>'''ACR_DOOR_STUCK_DC'''</code> (integer) If non-zero, the door is considered "stuck", and therefore cannot be opened unless forced. The value defined is the strength-check DC to "un-stick" the door. If someone tries to force a locked and stuck door open, the strength DC used is the higher of this value and <code>'''ACR_DOOR_BREAK_DC'''</code>. The default value is 0.<br />
* <code>'''ACR_DOOR_BREAK_DC'''</code> (integer) The DC to break open this door, as per DMG rules. Breaking open a door does not destroy it like doing damage to it would in NWN, but it does keep the door from being able to be locked again. If this value is zero, the door cannot be forced open. Valid values are from 0 to 255.<br />
* <code>'''ACR_DOOR_FAIL_OPEN_MESSAGE'''</code> (string) This is a custom message sent to PCs who try to open the door and fail. This can be used in conjunction with * <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> to setup doors that require a spoken password to access (even useful for door riddles).<br />
* <code>'''ACR_DOOR_OPEN_MESSAGE'''</code> (string) This message is "spoken" by the door when it is opened. It is usually used to give the PCs a description of the area beyond an AT, if any.<br />
* <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door unlocks itself. Generally used for shops and things which are only open during certain hours of the day. It will only unlock once, so if something else locks it afterwards, it will remain locked until either another creature unlocks it, or its next unlock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_LOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_LOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door locks itself. Generally used for shops and things which are only open during certain hours of the day. It will only lock once, so if something else unlocks it afterwards, it will remain unlocked until either another creature locks it, or its next lock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_UNLOCK_SPELLID'''</code> (int) This is the Spell ID for doors that require a specific spell to unlock. This will only work for spell IDs greater than 0. Be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> (string) This is what a player must speak to gain access to a password protected door. Leave this empty to require no password. Otherwise, be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_AUTO_LOCK'''</code> (integer) If non-zero, the door will automatically lock itself each time it is shut.<br />
* <code>'''ACR_DOOR_LISTEN_DC_MOD'''</code> (integer) This modifier is applied to creatures trying to listen to conversations occuring behind a closed doors. The DMG lists this a +5 for every door, but some customization is allowed for different door types. If undefined or set to 0, the door cannot be listened through.<br />
* <code>'''ACR_DOOR_KNOCK_IMMUNE'''</code> (integer) If nonzero, this door is immune to the spell knock. If zero, it is not immune.<br />
* <code>'''ACR_DOOR_UNMOVABLE'''</code> (integer) If nonzero, the door cannot be opened or closed by a non-DM creature, even if unlocked. Scripts can still open or close it, however. This setting is often used to represent large doors which a PC could not realistically close on their own even if they were unlocked, like the huge gates on castles and other fortifications.<br />
* <code>'''ACR_AT_SIZE'''</code> (integer) If nonzero, this setting specifies the maximum sized creature which can fit through this doorway. Anything large will be given a message saying it is too large to fit inside. Valid values are as follows:<br />
*# Fine<br />
*# Diminutive<br />
*# Tiny<br />
*# Small<br />
*# Medium<br />
*# Large<br />
*# Huge<br />
*# Gargantuan<br />
*# Colossal<br />
<br />
Note that currently, NWN2 does not support creature sizes of fine, diminutive, gargantuan or colossal. These values are provided here for future compatibility.<br />
<br />
Note that if none of these variables are defined, they default to zero. So a door without them would never close or lock itself, wouldn't be stuck or barred at all, would not be able to be forced open, and wouldn't have any sort of a custom message printed if a PC failed to open it.<br />
<br />
= Detect Magic =<br />
These are advanced options for doors to register as magical to Detect Magic. A door with these variables will report to the caster if the caster passes spellcraft checks based on the power of the spell. For instance: "Abjuration Dorm has a Faint aura of Transmutation."<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
<br />
=Tips/Troubleshooting=<br />
<br />
* If your doorway does not seem to function properly:<br />
*- make sure the doorway is within a walkmesh area<br />
*- make sure there is no open doorway behind it, as in a tileset doorway vs a placeable doorway<br />
*- a door must have current hit points >0 for it to function<br />
*- If your static door looks fine in the toolset but does not fill the doorway ingame, the door model defaults in static mode. Instead do not make door static and set it to locked, requires key to open to get it to look right ingame. This is especially true when you have changed the size of the door to fit the doorway. Some models work better than others. There are now placeable doors also available in the toolset.<br />
*- If a Half-orc cannot got through your AT make sure the receiving end is not set to position lock. Also make sure there is plenty of cleared space around the receiving door. Too little space will keep orcs and half-orcs from being able to traverse the doorway.<br />
* When resizing doors scales 1st and 2nd should be the same size. Otherwise your door will be a weird size when it opens. This how ever might be a useful trick when you want to emulate a door folding up or to the side.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Doors&diff=3935Building Doors2023-01-30T22:00:09Z<p>Wynna: /* TIPS/TROUBLESHOOTING */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
While the basemod contains every door listed in the DMG with appropriate settings, builders may wish to create their own doors. ALFA has scripts which provide a number of mechanics not ordinarily found in NWN, and every door has an extra set of options because of this.<br />
<br />
As with creating new creatures, items, and so forth, the easiest way to make a new door is to copy/edit an existing one. For information on editing the settings of an existing door, skip the next section.<br />
<br />
== Creating a New Door ==<br />
If you aren't editing an existing door, you will have to configure a number of options. To start off with, you'll need to make sure all of the door's event scripts are set correctly. ALFA's event scripts for doors are as follows: // Update for longer NWN2 file names<br />
* <code>acf_door_onclosed</code><br />
* <code>acf_door_onconversation</code><br />
* <code>acf_door_ondamaged</code><br />
* <code>acf_door_ondeath</code><br />
* <code>acf_door_ondisarm</code><br />
* <code>acf_door_onheartbeat</code><br />
* <code>acf_door_onlock</code><br />
* <code>acf_door_onmeleeattacked</code><br />
* <code>acf_door_onopen</code><br />
* <code>acf_door_onspellcastat</code><br />
* <code>acf_door_ontraptriggered</code><br />
* <code>acf_door_onunlock</code><br />
* <code>acf_door_onused</code><br />
* <code>acf_door_onuserdefined</code><br />
* <code>acf_door_onclick</code><br />
* <code>acf_door_onfailtoopen</code><br />
<br />
If you want to add custom event scripts to your doors, you can of course do so. Just make sure each event script includes the file [[acr_door_i.nss]], and calls the appropriate function for that event, listed here.<br />
* <code>ACR_DoorOnClosed()</code><br />
* <code>ACR_DoorOnConversation()</code><br />
* <code>ACR_DoorOnDamaged()</code><br />
* <code>ACR_DoorOnDeath()</code><br />
* <code>ACR_DoorOnDisarm()</code><br />
* <code>ACR_DoorOnHeartbeat()</code><br />
* <code>ACR_DoorOnLock()</code><br />
* <code>ACR_DoorOnMeleeAttacked()</code><br />
* <code>ACR_DoorOnOpen()</code><br />
* <code>ACR_DoorOnSpellCastAt()</code><br />
* <code>ACR_DoorOnTrapTriggered()</code><br />
* <code>ACR_DoorOnUnlock()</code><br />
* <code>ACR_DoorOnUsed()</code><br />
* <code>ACR_DoorOnUserDefined()</code><br />
* <code>ACR_DoorOnClick()</code><br />
* <code>ACR_DoorOnFailToOpen()</code><br />
<br />
Again, the easiest way to do this is to edit an existing acr_door_* file and save it under a different name. Failure to properly call ALFA's door scripts can break multiple systems of the ACR. So make sure you've got them in there.<br />
<br />
== Editing Door Settings ==<br />
: ''See also: [[Using Local Variables]]<br />
Aside from the standard NWN options of doors, we've provided a few more to give PCs and builders more options. These options can be accessed by editing the door's local variables.<br />
* <code>'''ACR_DOOR_CLOSE_DELAY'''</code> (float) The number of seconds a door will stay open before automatically closing itself. If set to zero or less than zero, the door will not close itself automatically.<br />
* <code>'''ACR_DOOR_CLOSE_NEAR_PCS'''</code> (integer) If set to 1, the door will auto-close regardless of any nearby PCs. If set to 0 (the default), the door will wait until PCs are out of visual range before closing itself.<br />
* <code>'''ACR_DOOR_STUCK_DC'''</code> (integer) If non-zero, the door is considered "stuck", and therefore cannot be opened unless forced. The value defined is the strength-check DC to "un-stick" the door. If someone tries to force a locked and stuck door open, the strength DC used is the higher of this value and <code>'''ACR_DOOR_BREAK_DC'''</code>. The default value is 0.<br />
* <code>'''ACR_DOOR_BREAK_DC'''</code> (integer) The DC to break open this door, as per DMG rules. Breaking open a door does not destroy it like doing damage to it would in NWN, but it does keep the door from being able to be locked again. If this value is zero, the door cannot be forced open. Valid values are from 0 to 255.<br />
* <code>'''ACR_DOOR_FAIL_OPEN_MESSAGE'''</code> (string) This is a custom message sent to PCs who try to open the door and fail. This can be used in conjunction with * <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> to setup doors that require a spoken password to access (even useful for door riddles).<br />
* <code>'''ACR_DOOR_OPEN_MESSAGE'''</code> (string) This message is "spoken" by the door when it is opened. It is usually used to give the PCs a description of the area beyond an AT, if any.<br />
* <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door unlocks itself. Generally used for shops and things which are only open during certain hours of the day. It will only unlock once, so if something else locks it afterwards, it will remain locked until either another creature unlocks it, or its next unlock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_LOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_LOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door locks itself. Generally used for shops and things which are only open during certain hours of the day. It will only lock once, so if something else unlocks it afterwards, it will remain unlocked until either another creature locks it, or its next lock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_UNLOCK_SPELLID'''</code> (int) This is the Spell ID for doors that require a specific spell to unlock. This will only work for spell IDs greater than 0. Be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> (string) This is what a player must speak to gain access to a password protected door. Leave this empty to require no password. Otherwise, be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_AUTO_LOCK'''</code> (integer) If non-zero, the door will automatically lock itself each time it is shut.<br />
* <code>'''ACR_DOOR_LISTEN_DC_MOD'''</code> (integer) This modifier is applied to creatures trying to listen to conversations occuring behind a closed doors. The DMG lists this a +5 for every door, but some customization is allowed for different door types. If undefined or set to 0, the door cannot be listened through.<br />
* <code>'''ACR_DOOR_KNOCK_IMMUNE'''</code> (integer) If nonzero, this door is immune to the spell knock. If zero, it is not immune.<br />
* <code>'''ACR_DOOR_UNMOVABLE'''</code> (integer) If nonzero, the door cannot be opened or closed by a non-DM creature, even if unlocked. Scripts can still open or close it, however. This setting is often used to represent large doors which a PC could not realistically close on their own even if they were unlocked, like the huge gates on castles and other fortifications.<br />
* <code>'''ACR_AT_SIZE'''</code> (integer) If nonzero, this setting specifies the maximum sized creature which can fit through this doorway. Anything large will be given a message saying it is too large to fit inside. Valid values are as follows:<br />
*# Fine<br />
*# Diminutive<br />
*# Tiny<br />
*# Small<br />
*# Medium<br />
*# Large<br />
*# Huge<br />
*# Gargantuan<br />
*# Colossal<br />
<br />
Note that currently, NWN2 does not support creature sizes of fine, diminutive, gargantuan or colossal. These values are provided here for future compatibility.<br />
<br />
Note that if none of these variables are defined, they default to zero. So a door without them would never close or lock itself, wouldn't be stuck or barred at all, would not be able to be forced open, and wouldn't have any sort of a custom message printed if a PC failed to open it.<br />
<br />
= Detect Magic =<br />
These are advanced options for doors to register as magical to Detect Magic. A door with these variables will report to the caster if the caster passes spellcraft checks based on the power of the spell. For instance: "Abjuration Dorm has a Faint aura of Transmutation."<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
<br />
=Tips/Troubleshooting=<br />
<br />
* If your doorway does not seem to function properly:<br />
*- make sure the doorway is within a walkmesh area<br />
*- make sure there is no open doorway behind it, as in a tileset doorway vs a placeable doorway<br />
*- a door must have current hit points >0 for it to function<br />
*- If your static door looks fine in the toolset but does not fill the doorway ingame, the door model defaults in static mode. Instead do not make door static and set it to locked, requires key to open to get it to look right ingame. This is especially true when you have changed the size of the door to fit the doorway. Some models work better than others. There are now placeable doors also available in the toolset.<br />
*- If a Half-orc cannot got through your AT make sure the receiving end is not set to position lock. Also make sure there is plenty of cleared space around the receiving door. Too little space will keep orcs and half-orcs from being able to traverse the doorway.<br />
* When resizing doors scales 1st and 2nd should be the same size. Otherwise your door will be a weird size when it opens. This how ever might be a useful trick when you want to emulate a door folding up or to the side.</div>Wynnahttps://www.alandfaraway.info/Wiki/index.php?title=Building_Doors&diff=3934Building Doors2023-01-30T21:59:31Z<p>Wynna: /* Detect Magic */</p>
<hr />
<div>[[Category:Technical Manuals]]<br />
[[Category:Articles Needing Attention]]<br />
While the basemod contains every door listed in the DMG with appropriate settings, builders may wish to create their own doors. ALFA has scripts which provide a number of mechanics not ordinarily found in NWN, and every door has an extra set of options because of this.<br />
<br />
As with creating new creatures, items, and so forth, the easiest way to make a new door is to copy/edit an existing one. For information on editing the settings of an existing door, skip the next section.<br />
<br />
== Creating a New Door ==<br />
If you aren't editing an existing door, you will have to configure a number of options. To start off with, you'll need to make sure all of the door's event scripts are set correctly. ALFA's event scripts for doors are as follows: // Update for longer NWN2 file names<br />
* <code>acf_door_onclosed</code><br />
* <code>acf_door_onconversation</code><br />
* <code>acf_door_ondamaged</code><br />
* <code>acf_door_ondeath</code><br />
* <code>acf_door_ondisarm</code><br />
* <code>acf_door_onheartbeat</code><br />
* <code>acf_door_onlock</code><br />
* <code>acf_door_onmeleeattacked</code><br />
* <code>acf_door_onopen</code><br />
* <code>acf_door_onspellcastat</code><br />
* <code>acf_door_ontraptriggered</code><br />
* <code>acf_door_onunlock</code><br />
* <code>acf_door_onused</code><br />
* <code>acf_door_onuserdefined</code><br />
* <code>acf_door_onclick</code><br />
* <code>acf_door_onfailtoopen</code><br />
<br />
If you want to add custom event scripts to your doors, you can of course do so. Just make sure each event script includes the file [[acr_door_i.nss]], and calls the appropriate function for that event, listed here.<br />
* <code>ACR_DoorOnClosed()</code><br />
* <code>ACR_DoorOnConversation()</code><br />
* <code>ACR_DoorOnDamaged()</code><br />
* <code>ACR_DoorOnDeath()</code><br />
* <code>ACR_DoorOnDisarm()</code><br />
* <code>ACR_DoorOnHeartbeat()</code><br />
* <code>ACR_DoorOnLock()</code><br />
* <code>ACR_DoorOnMeleeAttacked()</code><br />
* <code>ACR_DoorOnOpen()</code><br />
* <code>ACR_DoorOnSpellCastAt()</code><br />
* <code>ACR_DoorOnTrapTriggered()</code><br />
* <code>ACR_DoorOnUnlock()</code><br />
* <code>ACR_DoorOnUsed()</code><br />
* <code>ACR_DoorOnUserDefined()</code><br />
* <code>ACR_DoorOnClick()</code><br />
* <code>ACR_DoorOnFailToOpen()</code><br />
<br />
Again, the easiest way to do this is to edit an existing acr_door_* file and save it under a different name. Failure to properly call ALFA's door scripts can break multiple systems of the ACR. So make sure you've got them in there.<br />
<br />
== Editing Door Settings ==<br />
: ''See also: [[Using Local Variables]]<br />
Aside from the standard NWN options of doors, we've provided a few more to give PCs and builders more options. These options can be accessed by editing the door's local variables.<br />
* <code>'''ACR_DOOR_CLOSE_DELAY'''</code> (float) The number of seconds a door will stay open before automatically closing itself. If set to zero or less than zero, the door will not close itself automatically.<br />
* <code>'''ACR_DOOR_CLOSE_NEAR_PCS'''</code> (integer) If set to 1, the door will auto-close regardless of any nearby PCs. If set to 0 (the default), the door will wait until PCs are out of visual range before closing itself.<br />
* <code>'''ACR_DOOR_STUCK_DC'''</code> (integer) If non-zero, the door is considered "stuck", and therefore cannot be opened unless forced. The value defined is the strength-check DC to "un-stick" the door. If someone tries to force a locked and stuck door open, the strength DC used is the higher of this value and <code>'''ACR_DOOR_BREAK_DC'''</code>. The default value is 0.<br />
* <code>'''ACR_DOOR_BREAK_DC'''</code> (integer) The DC to break open this door, as per DMG rules. Breaking open a door does not destroy it like doing damage to it would in NWN, but it does keep the door from being able to be locked again. If this value is zero, the door cannot be forced open. Valid values are from 0 to 255.<br />
* <code>'''ACR_DOOR_FAIL_OPEN_MESSAGE'''</code> (string) This is a custom message sent to PCs who try to open the door and fail. This can be used in conjunction with * <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> to setup doors that require a spoken password to access (even useful for door riddles).<br />
* <code>'''ACR_DOOR_OPEN_MESSAGE'''</code> (string) This message is "spoken" by the door when it is opened. It is usually used to give the PCs a description of the area beyond an AT, if any.<br />
* <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door unlocks itself. Generally used for shops and things which are only open during certain hours of the day. It will only unlock once, so if something else locks it afterwards, it will remain locked until either another creature unlocks it, or its next unlock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_LOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_LOCK_HOUR'''</code> (integer) This is the time of day (in hours) the door locks itself. Generally used for shops and things which are only open during certain hours of the day. It will only lock once, so if something else unlocks it afterwards, it will remain unlocked until either another creature locks it, or its next lock time. Valid values are 0 to 23. If you don't wish the door locking or unlocking itself automatically, leave both this variable and <code>'''ACR_DOOR_UNLOCK_HOUR'''</code> set to 0 (the default value).<br />
* <code>'''ACR_DOOR_UNLOCK_SPELLID'''</code> (int) This is the Spell ID for doors that require a specific spell to unlock. This will only work for spell IDs greater than 0. Be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_UNLOCK_PASSWORD'''</code> (string) This is what a player must speak to gain access to a password protected door. Leave this empty to require no password. Otherwise, be sure to set the door's default lock status to locked.<br />
* <code>'''ACR_DOOR_AUTO_LOCK'''</code> (integer) If non-zero, the door will automatically lock itself each time it is shut.<br />
* <code>'''ACR_DOOR_LISTEN_DC_MOD'''</code> (integer) This modifier is applied to creatures trying to listen to conversations occuring behind a closed doors. The DMG lists this a +5 for every door, but some customization is allowed for different door types. If undefined or set to 0, the door cannot be listened through.<br />
* <code>'''ACR_DOOR_KNOCK_IMMUNE'''</code> (integer) If nonzero, this door is immune to the spell knock. If zero, it is not immune.<br />
* <code>'''ACR_DOOR_UNMOVABLE'''</code> (integer) If nonzero, the door cannot be opened or closed by a non-DM creature, even if unlocked. Scripts can still open or close it, however. This setting is often used to represent large doors which a PC could not realistically close on their own even if they were unlocked, like the huge gates on castles and other fortifications.<br />
* <code>'''ACR_AT_SIZE'''</code> (integer) If nonzero, this setting specifies the maximum sized creature which can fit through this doorway. Anything large will be given a message saying it is too large to fit inside. Valid values are as follows:<br />
*# Fine<br />
*# Diminutive<br />
*# Tiny<br />
*# Small<br />
*# Medium<br />
*# Large<br />
*# Huge<br />
*# Gargantuan<br />
*# Colossal<br />
<br />
Note that currently, NWN2 does not support creature sizes of fine, diminutive, gargantuan or colossal. These values are provided here for future compatibility.<br />
<br />
Note that if none of these variables are defined, they default to zero. So a door without them would never close or lock itself, wouldn't be stuck or barred at all, would not be able to be forced open, and wouldn't have any sort of a custom message printed if a PC failed to open it.<br />
<br />
= Detect Magic =<br />
These are advanced options for doors to register as magical to Detect Magic. A door with these variables will report to the caster if the caster passes spellcraft checks based on the power of the spell. For instance: "Abjuration Dorm has a Faint aura of Transmutation."<br />
* <code>'''ACR_SPELLSCHOOL'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER'''</code> (integer) If the door should register to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
* <code>'''ACR_SPELLSCHOOL2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the school of magic of the aura. See the Detect Magic page for which integer calls which school of magic.<br />
* <code>'''ACR_SPELLPOWER2'''</code> (integer) If the door should register a second aura to Detect Magic, use integer 1 - 9 for the spell level of the aura. See the Detect Magic page for more information.<br />
<br />
<br />
=TIPS/TROUBLESHOOTING=<br />
<br />
* If your doorway does not seem to function properly:<br />
*- make sure the doorway is within a walkmesh area<br />
*- make sure there is no open doorway behind it, as in a tileset doorway vs a placeable doorway<br />
*- a door must have current hit points >0 for it to function<br />
*- If your static door looks fine in the toolset but does not fill the doorway ingame, the door model defaults in static mode. Instead do not make door static and set it to locked, requires key to open to get it to look right ingame. This is especially true when you have changed the size of the door to fit the doorway. Some models work better than others. There are now placeable doors also available in the toolset.<br />
*- If a Half-orc cannot got through your AT make sure the receiving end is not set to position lock. Also make sure there is plenty of cleared space around the receiving door. Too little space will keep orcs and half-orcs from being able to traverse the doorway.<br />
* When resizing doors scales 1st and 2nd should be the same size. Otherwise your door will be a weird size when it opens. This how ever might be a useful trick when you want to emulate a door folding up or to the side.</div>Wynna