Updated Area Switches for PRC Teleport System (markdown)

Area-Switches-for-PRC-Teleport-System.md

@@ -1,8 +1,104 @@
-           
-PRC_DISABLE_TELEPORTATION_IN_AREA - Need in any area you want to modify teleportation.
+/**
+ * Defines the maximum number of teleport target locations a PC may store.
+ * Default: 50
+ */
+const string PRC_TELEPORT_MAX_TARGET_LOCATIONS          = "PRC_TELEPORT_MAX_TARGET_LOCATIONS";
 
-PRC_DISABLE_TELEPORTATION_WITHIN_AREA - Stop intra-area teleportation, like Dimension Door.
+/**
+ * If this is set, all spells/powers/effects with the [Teleportation] descriptor
+ * (ie, their scripts use GetCanTeleport()) fail.
+ *
+ * Default: Off
+ */
+const string PRC_DISABLE_TELEPORTATION                  = "PRC_DISABLE_TELEPORTATION";
 
-PRC_DISABLE_TELEPORTATION_TO_AREA - Disables entering the area via teleportation.
+/**
+ * If a local integer variable by this name is set on an area, certain
+ * teleportation destinations are unavailable based on the value of the variable.
+ * This affects the return value of GetCanTeleport() when the bMovesCreature parameter
+ * is true.
+ *
+ * Possible values are a bitwise combinations of the following:
+ * PRC_DISABLE_TELEPORTATION_FROM_AREA
+ * PRC_DISABLE_TELEPORTATION_TO_AREA
+ * PRC_DISABLE_TELEPORTATION_WITHIN_AREA
+ */
+const string PRC_DISABLE_TELEPORTATION_IN_AREA          = "PRC_DISABLE_TELEPORTATION_IN_AREA";
 
-PRC_DISABLE_TELEPORTATION_FROM_AREA - Disables leaving the area via teleportation.
+/**
+ * A value of PRC_DISABLE_TELEPORTATION_IN_AREA. This disables teleporting
+ * from the area in question to other areas.
+ */
+const int PRC_DISABLE_TELEPORTATION_FROM_AREA           = 0x1;
+
+/**
+ * A value of PRC_DISABLE_TELEPORTATION_IN_AREA. This disables teleporting
+ * from other areas to the area in question.
+ */
+const int PRC_DISABLE_TELEPORTATION_TO_AREA             = 0x2;
+
+/**
+ * A value of PRC_DISABLE_TELEPORTATION_IN_AREA. This disables both teleporting
+ * from area in question to another location in that same area.
+ */
+const int PRC_DISABLE_TELEPORTATION_WITHIN_AREA         = 0x4;
+
+/**
+ * Forces spells/powers/effects that use GetTeleportError() to behave in a
+ * specific way when their destination is in an area on which this local
+ * variable is set.
+ * Based on the value of this variable, such a spell/power will always behave in
+ * a way described by one of the entries of Teleport results table. This happens
+ * even if the spell/power would normally ignore the table.
+ *
+ * Default: Each spell / power behaves by it's normal specification.
+ *
+ * Values:
+ * PRC_FORCE_TELEPORTATION_RESULT_ONTARGET
+ * PRC_FORCE_TELEPORTATION_RESULT_OFFTARGET
+ * PRC_FORCE_TELEPORTATION_RESULT_WAYOFFTARGET
+ * PRC_FORCE_TELEPORTATION_RESULT_MISHAP
+ */
+const string PRC_FORCE_TELEPORTATION_RESULT             = "PRC_FORCE_TELEPORTATION_RESULT";
+
+/**
+ * A value of PRC_FORCE_TELEPORTATION_RESULT. This makes the spells affected by
+ * the variable always succeed.
+ */
+const int PRC_FORCE_TELEPORTATION_RESULT_ONTARGET       = 1;
+
+/**
+ * A value of PRC_FORCE_TELEPORTATION_RESULT. This makes the spells affected by
+ * the variable always dump the target(s) in a random location in the same area.
+ */
+const int PRC_FORCE_TELEPORTATION_RESULT_OFFTARGET      = 2;
+
+/**
+ * A value of PRC_FORCE_TELEPORTATION_RESULT. This makes the spells affected by
+ * the variable always dump the target(s) in a random location among the users's
+ * stored teleport choices, or if there are no others, just stay where the user is.
+ */
+const int PRC_FORCE_TELEPORTATION_RESULT_WAYOFFTARGET   = 3;
+
+/**
+ * A value of PRC_FORCE_TELEPORTATION_RESULT. This makes the spells affected by
+ * the variable always do the following:
+ * // Mishap:
+ * // You and anyone else teleporting with you have gotten “scrambled.”
+ * // You each take 1d10 points of damage, and you reroll on the chart to see where you wind up.
+ * // For these rerolls, roll 1d20+80. Each time “Mishap” comes up, the characters take more damage and must reroll.
+ */
+const int PRC_FORCE_TELEPORTATION_RESULT_MISHAP         = 4;
+
+/**
+ * If a variable by this name is non-zero on a creature, that creature cannot
+ * teleport. If you use this in your own scripts, please do not set it to
+ * a static value or directly remove it.
+ * Instead, increase it's value by one when the disabling occurs and decrease
+ * by one when the disabling turns off. This is required in order to be able to
+ * handle overlapping sources of forbiddance.
+ *
+ * Note: This stops all effects with the [Teleportation] descriptor, by causing
+ * GetCanTeleport() to always return FALSE.
+ */
+const string PRC_DISABLE_CREATURE_TELEPORT              = "PRC_DISABLE_CREATURE_TELEPORT";