https://wiki.thedarkmod.com/api.php?action=feedcontributions&feedformat=atom&user=SparhawkThe DarkMod Wiki - User contributions [en]2026-04-29T00:20:05ZUser contributionsMediaWiki 1.45.3https://wiki.thedarkmod.com/index.php?title=The_Dark_Mod_Gameplay&diff=17650The Dark Mod Gameplay2014-03-02T10:34:18Z<p>Sparhawk: /* Doors */</p>
<hr />
<div>{{red|Updates for versions after v1.00 are listed in red, so players can quickly see changes to gameplay since their last read.}}<br />
<br />
Since The Dark Mod is designed to simulate the stealth gameplay of Thief, many things will be very familiar to Thief players. There are some features that work differently, however, and some things that are entirely new to TDM. <br />
<br />
If you have never played Stealth Games before, start with the [[Basics of Stealth Gaming]].<br />
<br />
Veteran stealth gamers can read the various sections below for more detail:<br />
<br />
= The Game Menus =<br />
<br />
Your experience with The Dark Mod will start with the Main Menu, where you may wish to adjust some settings before starting your first mission. If you already have saved games from a currently installed mission, you can load them from the Load/Save menu. <br />
<br />
{{red|Note: While missions remain compatible with all updates, your saved games will not necessarily work after updating, due to code changes.}}<br />
<br />
== Starting a Mission ==<br />
[[Image:new_mission.jpg|thumb|The New Mission menu.]]<br />
<br />
# Select ''New Mission'' from the Main Menu.<br />
# Click "Download" to see a list of missions available to download. You can even read details and see screenshots from the mission before downloading it. {{red|(1.04)}}<br />
# Select a Mission from the Available Mission list on the right (start with the Training Mission if this is your first time) and click ''Install Mission''.<br />
# TDM will install the mission and restart. Select ''New Mission'' again, and click ''Start Mission'' <br />
# You will see a briefing that introduces the mission. Click ''Objectives'' to proceed.<br />
# Read your objectives, and choose your Difficulty Level. Then select ''Buy Equipment'' (or ''Start Mission'' in some missions).<br />
# After purchasing desired equipment, hit ''Start Mission''. (The option to ''Drop'' starting items is available, but use with caution...dropping some items may make a mission impossible to complete)<br />
# The Mission Loading screen should appear. Be patient...loading a mission for the first time can take several minutes.<br />
<br />
To call the Main Menu during the game, press {{ESC}}) .<br />
<br />
See [[Installing and Running Fan Missions]] for more information.<br />
<br />
== Changing Settings ==<br />
<br />
# Select ''Settings'' from the Main Menu<br />
# Select the type of setting you wish to adjust: ''Audio'', ''Video'', ''Controls'', or ''Gameplay''<br />
# The controls are set to defaults familiar to ''Thief'' players, however there are new keys/features that are worth reviewing.<br />
#There are difficulty settings for many things, including lockpicking and {{red| combat. (1.01)}} <br />
# New graphic settings have been added for better graphic quality and bloom. {{red|(1.03)}}<br />
#{{red|A new "AI Vision" option has been added. This controls how quickly AI realize you are an enemy when they spot you. (2.0)}}<br />
<br />
== Objectives ==<br />
<br />
When you call the Main Menu during a mission (by hitting {{ESC}}), you will see an option for "Objectives". This is where you can check your progress.<br />
<br />
Your objectives are also displayed after the Mission Briefing when you first start a mission.<br />
<br />
You can also check your Objectives without going to the menus. Hitting {{key|O}} will bring up your objectives on screen. You can use the mouse wheel to scroll up and down. Note that this method ''does not pause the game''. {{red| (1.01)}}<br />
<br />
When you complete an objective, a chime will sound and “Objective Completed” will be displayed at the top of the screen. <br />
<br />
When you have completed all objectives, the map will close and a “Mission Succeeded” screen will appear. Likewise, if you fail an objective or are killed, a “Failed Mission” screen will appear. You can restart the map by selecting the "Restart" option or via the Main Menu.<br />
<br />
<br />
----<br />
<br />
= HUD Display =<br />
<br />
[[Image:hud.jpg|thumb|The Game Screen indicators.]]<br />
<br />
1. WEAPON ICON: An icon of your currently selected weapon is displayed in the bottom left corner of the screen.<br />
<br />
2. BREATH INDICATOR: When you are underwater a small blue bar will appear above the lightgem. This bar measures how much air you have left. When the blue bar runs out, you start to take damage. Surfacing or using a Breath Potion will restore your air bar. <br />
<br />
3. LIGHTGEM: The lightgem at the bottom of the screen indicates how easy you are to see. This is primarily due to how much light is hitting you, but also includes things like whether you are crouched, moving, or have a weapon drawn. {{red|Being under water also reduces your lightgem. (1.03)}}<br />
<br />
The wings on either side of the gem are a crouch indicator. When you are crouched, the wings 'crouch' down as well. {{red| (1.01) }}<br />
<br />
4. HEALTH INDICATOR: When you are injured, a small red healthbar appears below the lightgem. It will remain visible until you are returned to full health.<br />
<br />
5. INVENTORY ICON: Your currently selected inventory object (or your loot total) is displayed as an icon in the bottom right.<br />
<br />
== Weapons ==<br />
<br />
Weapon hotkeys were changed at the last minute, so this list may need modifying:<br />
* {{key|`}} Put away weapons<br />
* {{key|1}} Blackjack<br />
* {{key|2}} Short Sword<br />
[[Image:arrows.jpg|thumb|A selection of arrows you can choose from.]]<br />
* {{key|3}} Broadheads<br />
* {{key|4}} [[Water Arrows]]<br />
* {{key|5}} [[Fire Arrows]]<br />
* {{key|6}} [[Rope Arrows]] <br />
* {{key|7}} [[Gas Arrows]] <br />
* {{key|8}} [[Noise Arrows]]<br />
* {{key|9}} [[Moss Arrows]]<br />
* {{key|0}} [[Vine Arrows]] {{red| (1.07)}}<br />
<br />
''(note that there has been a report that linux users cannot use the {{key|`}} as it is mapped to the console. Linux users will need to select a different key for 'Put away weapons'.)''<br />
<br />
== Inventory Objects ==<br />
Cycle through your inventory using the Inventory Prev/Next keys (default: {{key|[}} or {{key|TAB}} for next item and {{key|]}} for prev item). Inventory objects are stored in groups, so all keys will be stored together, all readables, etc. You can cycle through groups with the Prev/Next Group keys.<br />
<br />
To ‘use’ an inventory object, select it and then hit the Use key (default: {{key|U}}). This will drink potions, throw mines, activate the spyglass, etc. To "use" objects on other objects (like using a key on a door), select the object in inventory, highlight the thing you want to use it on, and hit Use. <br />
<br />
You can drop inventory items by hitting the Drop key (default: {{key|R}}) twice. See the section "Holding Junk Objects" for more information. Note that mappers may designate some important inventory items as undroppable.<br />
<br />
You can clear the inventory selection by hitting the {{key| ← &nbsp; &nbsp; &nbsp;}} (backspace) key.<br />
<br />
To set hotkeys for your inventory items, please see [[Custom Settings for Players]].<br />
<br />
=== Inventory Object: Flashbomb === <br />
[[Image:equipment.jpg|thumb|The tools of a professional burglar.]]<br />
Activate a flashbomb by selecting it in inventory and hitting Use. Flashbombs detonate on impact. A short tap will cause it to fall and go off at your feet where it won't blind you. Holding down the Use key will throw the flashbomb farther away. If you use the Drop key to put the flashbomb down, it is not activated at all.<br />
<br />
An AI must be looking at the flashbomb to be blinded. Don't look at the point of impact or you'll be blinded too.<br />
<br />
AI are only blinded for a few seconds, and they are alerted by the flash, so this tool is most useful for getting away when you've been spotted, or stunning an enemy before an attack.<br />
<br />
Flashbombs have no effect on the undead.<br />
<br />
=== Inventory Object: Holy Water ===<br />
<br />
Select your holy water in inventory and hit the Use key. This puts holy water into your water arrows, making them lethal to undead. The effect only lasts 30 seconds, so use it wisely.<br />
<br />
=== Inventory Objects: Keys === <br />
Some doors or chests require keys to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
You can also assign a key to ''Cycle Keys'' to quickly cycle through all keys in your inventory. This is a very useful way to get to your keys quickly when you have a lot of other items in your inventory.<br />
<br />
=== Inventory Objects: Lockpicks === <br />
See [[#Lockpicking|Lockpicking]] for more information on lockpicks.<br />
<br />
=== Inventory Objects: Maps and Readables === <br />
<br />
In The Dark Mod, both maps and most readables (books, scrolls, etc) are inventory items. To read them, you scroll to the object in your inventory and then hit the Use key. The map or readable will be displayed on screen. Note that '''this does not pause the game'''. Unlike Thief, events continue to unfold around you, and you can be attacked while reading if not careful. You can see your environment around the edges of the map/readable, but the best suggestion is to find a safe place to read. With multi-page readables (distinguishable by folded corners on the page), use the next/prev inventory or next/prev weapon keys to scroll through pages. Hitting Use or Attack will put the readable away.<br />
<br />
The Map key (default: {{key|M}}) will also automatically bring up your map, if you have one. You can also define a readables key (default: not mapped) to cycle through any readables you have.<br />
<br />
=== Inventory Object: Mines === <br />
<br />
Place a mine by selecting it in inventory and hitting Use. A short tap will drop the mine at your feet. Holding down Use will throw the mine farther away. After a few seconds, the mine is armed and {{red| starts making a distinct ticking sound (1.07) }}. Once you hear the ticking, it will go off if stepped on. <br />
<br />
{{red| Map authors can place a mine and arm it at mission start. It behaves the same as any mine you've thrown: it will explode on contact, and it can be disarmed. So don't assume that any mine you come across is safe to pick up. Listen for the tell-tale armed ticking sound. (1.07) }}<br />
<br />
If you use the Drop key to put the mine down, it is not armed.<br />
<br />
Note that you can set armed mines off by shooting them with an arrow.<br />
<br />
You can disarm an armed mine by using a lockpick on it, the same as you would on a locked door. {{red| (1.07) }} Armed mines give off a distinct ticking sound, which stops when the mine is disarmed. After disarming a mine, you can frob it to put it back into your inventory.<br />
<br />
=== Inventory Object: Player Lantern === <br />
<br />
Light is usually the bane of thieves everywhere, but there are times when you need just a little to make your way around. To this end, some thieves carry a covered lantern with a hood that can be closed to block out the light. To use the lantern, select it in inventory and hit Use. This will lift the cover if the lantern is currently off, or close the cover if it is currently lit. There is also a hotkey for using the lantern; by default this is {{key|L}}. This lantern is clipped to your belt so your hands are free, and it can even be used underwater for short periods.<br />
<br />
Obviously using the lantern makes you clearly visible to any nearby opponents.<br />
<br />
=== Inventory Object: Potions ===<br />
<br />
Potions are used by selecting them in inventory and hitting Use. Healing potions will restore hit points (the effect is somewhat gradual). Breath potions increase the player's breath meter, allowing them to stay underwater longer.<br />
<br />
=== Inventory Object: Spyglass === <br />
<br />
A good Thief likes to scout ahead. To use the spyglass, select it in inventory and hit Use. Or use {{key|G}} as a shortcut. You can use the next/prev weapon keys to zoom in and out. You cannot use weapons or frob objects while using the spyglass.<br />
<br />
= Movement =<br />
<br />
Movement in The Dark Mod is not that different than Thief. You can run, walk, or creep, as well as do any of the three while crouching. The faster you move, the more noise you make.<br />
<br />
== Climbing ==<br />
<br />
In addition to ladders and ropes, many missions allow you to climb vines, pipes and chains.<br />
<br />
Move or jump onto a ladder or vines to "attach" to them. Moving "forward" will move in the direction of your view, be it up, down or to the side. "Back" will reverse, and you may strafe to the side. Move away or jump off to detach.<br />
<br />
Holding crouch will let you slide down a rope or ladder. Release to stop sliding, or hold it down to slide all the way to the bottom.<br />
<br />
=== Swinging on Ropes ===<br />
<br />
Tapping the "attack" key while on a rope or chain will cause the rope to swing forward. You can actually gain more momentum by continuing to tap it every time you start swinging forward (think of it like swinging your legs forward on a swing). This can allow you to jump off the rope and grab ledges that are otherwise too far away.<br />
<br />
Note that the further down the rope you are, the more distance you can travel when swinging (just like a real rope).<br />
<br />
== Mantling ==<br />
There are two different ways to mantle (pull yourself up onto ledges) in The Dark Mod. One is by holding down the Jump key, which Thief players will be familiar with. There is also a key specifically for mantling (default: {{key|<br />
C}}), so that failing to mantle will not result in jumping and making noise. Ideally there should be no difference in these methods, but occasionally one method will work when the other will not.<br />
Mantling is affected by where you are looking, so a successful mantle is more likely if you are looking directly at the edge of the object you wish to climb. To climb on a chair, look down at the seat then press the mantle control. By this means you can clamber over relatively low but awkward obstructions and even select one ledge above/below another.<br />
<br />
You cannot mantle while carrying a junk object or body.<br />
<br />
= Interacting With Your Environment =<br />
<br />
The Dark Mod gives you far more flexibility than previous Thief games when it comes to interacting with things.<br />
<br />
== Manipulating Held Objects ==<br />
This is one area that works quite differently from the Thief series. "Held Objects"(anything that you can carry that doesn’t go into inventory, like chairs, candles, or bodies) are held out in front of you when frobbed. Unlike in Thief, they take up physical space, and can be used to push or manipulate other objects. They can also bump into other objects, making noise (or being knocked out of your hands), so be careful.<br />
<br />
To grab a held object, frob it as normal. The object will stop highlighting, and any weapons you have selected will lower. At this point, you can use the next/prev weapon keys (default: mousewheel up/down) to move the object closer/further away from you, and moving your mouse around will move the object (it stays basically in the center of your screen). <br />
<br />
The heavier the object, the slower it moves, so you may notice a ‘lag’ if you turn quickly with heavy objects. It can take a while to get used to this.<br />
<br />
To drop an object, hit the Drop key (default: {{key|R}}). By crouching and angling your view down gently, you'll find that you can easily set down objects without making noise. You can also throw a held object by hitting the Attack key. Tapping the Attack key throws the object a short distance; holding the Attack key down and releasing it will throw it further.<br />
<br />
To rotate a held object, hold down the {{key|Z}} key or middle mouse button, and move your mouse. <br />
(By default, horizontal movement of the mouse yaws the object around the vertical axis, and vertical movement pitches the object up and down. Holding down the Run key makes horizontal mouse movement roll the object around the forward axis.) This can be useful for replacing objects that have been knocked over, or for placing moveable objects in creative ways (like putting a plank over a gap, or stacking chairs).<br />
It is possible to “drop” inventory items into your hands, where they can be manipulated as if they were held objects. Select the object in your inventory, and hit the Drop key {{key|R}}. The object will appear in front of you like a held object, and you can rotate it, set it down, etc. To put it back into your inventory, you must "use" the item again ({{key|U}}) or scroll to the next inventory item ({{key|TAB}} or {{key|[}}/{{key|]}}).<br />
[[Image:candles6.jpg|thumb|[http://www.youtube.com/watch?v=922ArtrKgC4 Click to see TDM candles in action.] ]]<br />
AI will hear junk objects that are dropped or banged around. It takes some skill to pick up objects on a crowded table without knocking them into each other. Remember than an object moves to the center of the screen when you pick it up. If you are looking slightly above the object, it will jump up to center screen (usually a good thing). If you're looking slightly below the object, it will jump down, banging whatever surface it rests on (a bad thing). A little practice may be required to smoothly and quietly sort through objects.<br />
<br />
Some objects that are too heavy to lift may still be movable (like large crates). Walking or running into such objects may (mapper's choice) push them along the ground.<br />
<br />
=== Held Objects: Candles ===<br />
<br />
Lit candles can be frobbed and carried around to light your way (obviously you will be easily spotted while carrying a lit candle). They can also be used to light flammable objects like other candles or torches. Click the caption on the right for a demonstration.<br />
<br />
Candles can be extinguished by water, or you can pinch them out by picking them up and clicking the Use key. (Note that this method can also be used on some movable lanterns). {{red|Candles will usually go out after a few seconds if they get knocked over. (1.06) }}<br />
<br />
Be aware that multiple light sources can cause a significant drain on your framerate. If you go around a room lighting six or seven new candles, don't be surprised if your framerate drops significantly.<br />
<br />
=== Held Objects: Bodies ===<br />
<br />
Bodies work differently than most other objects. There are two ways to deal with dead or unconscious bodies in The Dark Mod. You can both drag them and carry them.<br />
<br />
To drag a body, you must ‘frob’ it (which probably requires crouching), and then move your mouse around. The body will drag along with you until you frob it again or the body gets stuck on something. <br />
<br />
This is not the most graceful way of moving bodies and is not recommended for long distances. Bodies can catch on things and get pulled out of your hands. It can be useful for quickly shifting a body into a shadow, however. You can even move individual limbs to put a flailing arm back into a shadow.<br />
<br />
You can also carry a body over your shoulder. While a body is being dragged, hitting the Use button will lift it up over your shoulder. While carrying a body you move more slowly and cannot use weapons or inventory objects (though you can open doors). When you are ready to drop the body, hit Use again. If there is not enough room, you will hear a grunt and nothing will happen. Back up a bit and try again. When you drop a body, it will be the opposite orientation from the way you picked it up (if a body is face-up when you lift it, it will be face-down when you drop it). This allows you to easily search a body for keys or other objects.<br />
<br />
=== Held Objects: Food ===<br />
<br />
Some food can be eaten. When holding a piece of food (such as an apple) hit the "use" key. If the food is edible, you will 'eat' it. Discard any left-overs. Some of the healthy food will heal you by 1 HP.<br />
<br />
== Doors == <br />
You can interrupt a door opening or closing by frobbing it again. Frobbing a moving door stops it, allowing you to open a door just a crack to peer beyond.<br />
<br />
You can lean into a door (use the lean left/right keys) to press your ear up against it and hear what's on the other side. Note that while you're concentrating on what's beyond the door you'll be less able to hear the sounds in the room you're currently in.<br />
<br />
Some doors or chests are locked and require keys (or lockpicks, see below) to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
Depending on how important a specific door is, the mapper can choose to set flags on it. Check out the [[#AI_Behaviour| AI Behaviour]] section, for details on how the AI responds in such cases.<br />
<br />
== Lockpicking ==<br />
You will definitely want to practice lockpicking in the Training Mission before trying a real map. Just reading the instructions is probably not enough to get the hang of it. <br />
<br />
There are two types of lockpicks, 'triangle' and 'snake'. To begin, you must have the correct lockpick selected in inventory. If you do not, you will see a red flash behind the lockpick icon when you frob the locked door. To pick a lock, move close enough to highlight the door and hold the Use key. You will start to hear a sequence of clicks, and see the door handle (or lock pin) jiggle in sync.<br />
<br />
The clicks are a random pattern. At the end of the pattern is a brief period of silence, then the pattern will begin again. To be successful you must hit the Attack key (or release the Use key if you prefer) at the start of that silence. If you hit the Attack key at the wrong time there is a dull 'fail' sound and the pattern begins again. Your goal is to learn the sequence of clicks so that you can anticipate when it will end. This requires concentration.<br />
<br />
Some locks are more difficult than others and have multiple pins (which may require switching lockpicks). You can make lockpicking harder or easier in the Settings Menu, by adjusting how much silence there is between each pattern (the more silence, the easier it is to react in time). Setting Lockpicking to "Auto" will make locks open automatically after the pattern repeats 3 times.<br />
<br />
{{red| Armed mines can be disarmed by lockpicking them. Afterward, they can be frobbed and put into inventory. Either lockpick type can be used. (1.07) }}<br />
<br />
== Chests ==<br />
It can sometimes be a little awkward frobbing items inside deep chests. Leaning forward (or even sideways) will usually help.<br />
<br />
If you get too close to a chest, you can sometimes get in the way of the lid opening or closing. Back up a little if the lid is not moving as expected.<br />
<br />
<br />
----<br />
<br />
= Combat =<br />
<br />
There are a number of ways that combat is different in The Dark Mod.<br />
<br />
Keep in mind that you are not a warrior. Guards are generally better trained than you are, and while you might win a few one-on-one battles, you will almost certainly die if facing two guards at once.<br />
<br />
== Blackjacking ==<br />
<br />
Your blackjack is more effective if your opponent is relaxed and not expecting trouble.<br />
<br />
You must hit an AI on the head to knock them out. Hitting an AI anywhere else will simply alert them. For best results, don't get too close to the AI, or you may hit them with your elbow instead of your blackjack.<br />
<br />
'''You can successfully knock out:'''<br />
<br />
'''1. Unarmed civilian AI from any direction, any time.'''<br />
<br />
'''2. Bare-headed guards from any direction when relaxed, or from behind when their weapon is out.'''<br />
<br />
'''3. Helmeted guards from behind when relaxed (helmeted guards cannot be knocked out when their weapon is out).'''<br />
<br />
All armed AI are harder to knock out when the AI has drawn a weapon, because they are assumed to be ready for you. Either they have searched for you or been warned by a friend that something is wrong.<br />
<br />
The blackjack does a small amount of damage, so you could theoretically beat someone to death with it, if you have a lot of time on your hands.<br />
<br />
Undead and some animals cannot be knocked out with the blackjack.<br />
<br />
{{update|1.01|Certain heavy-duty helmets make their wearer immune to the blackjack. These can be identified by a face grill and a low back, which protects the base of the neck.}}<br />
<br />
'''Note:''' the blackjack makes an overhead swing, so if there is something low in the way (like a doorframe) you might hit it instead of your target, especially if you are looking upwards.<br />
<br />
== Melee Combat ==<br />
[[image:combat1.jpg|thumb|A guard winds up for an overhead attack]]<br />
There is a combat arena in the Training Map for practicing combat. After a few rounds you will have a much better feel for how it works.<br />
<br />
{{update|1.01|Different AI have different skill levels (novice, trained, skilled) when it comes to combat. An armed commoner will not fight as well as an elite guard. You can also change the overall combat difficulty in the Settings menu.}}<br />
<br />
You can use your shortsword to attack an enemy, as well as block enemy weapons. Attacking a relaxed enemy (ie, backstabbing) does extra damage. <br />
To attack, hit the Attack key. This will make a left-to-right, slashing attack. If you move the mouse while clicking the Attack key, you can select other kinds of attacks. Moving the mouse down will cause an overhead swing. Moving the mouse up will cause a thrust attack. Moving the mouse left or right will cause a right-to-left or left-to-right slash, respectively. <br />
<br />
AI can parry your swings (unless they are using a dagger), and they will do this more easily if you keep using the same kind of attack, so you will want to mix it up. <br />
<br />
The amount of damage you do varies depending on where you hit. Hitting an AI in the head will do more damage than hitting their arm or leg. Armour also plays a factor. Your sword can't penetrate plate armour, and even chainmail or leather armour will provide the AI some protection.<br />
<br />
To block an enemy strike, hold the Parry key. You must hit the parry key ''after'' the AI starts winding up for their attack. Too early and the AI will see the block and choose a different attack. Obviously, you must also be facing the AI...holding up a block while looking off to the side won't help.<br />
<br />
If you are using Manual Parry (select in the Settings menu), you need to select the appropriate block. If your opponent is making an overhead attack, you must select an overhead block. Select blocks by moving the mouse while holding the Parry button down, just as you would for an attack. <br />
<br />
If you successfully block an attack or damage your opponent the AI will be temporarily "flat-footed". They can still attack and defend, but they will not chase you if you turn to run. The effect lasts only a second or two, but that can sometimes be enough time to give you a head start.<br />
<br />
The trick to a successful combat is timing. You need to try to anticipate your opponent's attacks, and then launch counter-attacks before he has a chance to parry.<br />
<br />
AI will usually try to flee if they are badly wounded.<br />
<br />
{{update|1.07|Different weapons do different amounts of damage when they hit you. A longsword is one of the most damaging weapons, while short swords do less damage and daggers even less.}}<br />
<br />
'''Note:''' It is possible to hit walls or ceilings instead of your target. Keep track of how much space is around you when choosing your swing.<br />
<br />
== Missile Combat ==<br />
<br />
Your broadhead arrows cannot penetrate plate armour, and will do less damage if they hit chain or leather armour. The best result is to hit unarmoured flesh. A single arrow to the head will kill a relaxed guard. Alert guards are assumed to be taking measures to minimize the damage from incoming arrows. <br />
<br />
If you are hit while trying to fire an arrow, your attack will be canceled.<br />
<br />
AI will switch to missile combat if they can see you but cannot reach you. If they don't have a missile weapon, they will become angry and start throwing things at you.<br />
<br />
AI archers will fire arrows at you. Some AI are better shots than others. When you get within melee range of an archer, they will pull out their melee weapon to fight with it instead.<br />
<br />
<br />
----<br />
<br />
= AI =<br />
<br />
== AI Senses ==<br />
<br />
AI can see you if your lightgem is not totally black. The longer you're in their field of vision and the closer you are, the more likely they are to notice you and come and investigate. <br />
<br />
Some AI have hoods, eyepatches, or other things that block their field of vision. These can be exploited by clever thieves. {{red| (1.01) }}<br />
<br />
AI can hear your footsteps, and noise that you make from banging into things or dropping objects. {{update|2.0|They can also hear the sound of falling bodies, so be careful where you knock out opponents.}}<br />
<br />
AI can also feel you if you bump into them, or vice versa.<br />
<br />
TDM AI are fairly intelligent about searching. They can identify good hiding spots and will check them out first.<br />
<br />
When AI become alert, their senses get slightly better. A shadow that is sufficient to hide you from a relaxed AI might not be enough for an AI that is alert and actively looking for trouble.<br />
<br />
AI do not forget about you after giving up the search. They remain in an alert state, with heightened senses and their weapons out.<br />
<br />
== AI Behaviour ==<br />
<br />
AI don't necessarily patrol the exact same route every time, or stand for the same amount of time at every spot they go to. Mappers can add as much randomness to the AI as they wish.<br />
<br />
AI need to see evidence in order to react to it. If a bloodstain or missing loot is in shadow, an AI won't notice it.<br />
<br />
AI can react to missing objects, but only if mappers set the objects as noteworthy.<br />
<br />
AI become suspicious if they find a weapon lying around. Finding blood or a body will cause them to go fully alert.<br />
<br />
AI can hear broadhead arrow impacts. If you shoot an arrow and it hits a wall nearby, the AI will notice. AI will also react to water arrows if you fire them too close (or if you hit an AI with one). {{update|1.07|AI will notice and be suspicious of arrows that are left sticking into things.}}<br />
<br />
<br />
AI do not yet notice moss arrow impacts, broken objects or moss patches. These things will likely cause minor alerts in the future.<br />
<br />
{{update|1.06| AI can notice and comment on lights that have been put out, and may relight ones that the mapper has set as important. AI will start to become suspicious of an intruder if this happens frequently.}}<br />
<br />
{{update|1.07| AI that see a rope from a rope arrow will walk over to investigate, and will treat it as evidence of an intruder.}}<br />
<br />
{{update|1.07| AI can notice important doors (set by mapper) that have been left open, and will start to become suspicious.}}<br />
<br />
{{red| AI will turn towards doors that they see opening, and may get suspicious if they don't see anyone responsible. (2.00) }} <br />
<br />
AI will look for 2s at a door opening in their FOV, unless they’re in combat mode.<br />
<br />
An AI will not look at an open door if they were the last one to handle it.<br />
<br />
===For an unsuspicious door:===<br />
<br />
The door starts to open, stims the AI, but the AI ignores it, because the door is < 20% open. One second later, when the next stim hits him, if the door is < 20% open, he'll continue to ignore it. Otherwise, he'll look at the door for 2 seconds. Non-suspicious doors can be cracked open indefinitely w/o nearby AI noticing.<br />
<br />
===For a suspicious door:===<br />
<br />
<br />
Allow player to crack open (< 20%) a suspicious door to peek out w/o grabbing the attention of a nearby AI. After 5s, the AI will notice the cracked open door.<br />
<br />
When the door is >20%, it stims the AI, and the AI immediately starts to look at it for 2 seconds. 1 to 1.5 seconds after the stim, while looking at the door, if no friendlies are apparent, the AI will bark and walk toward the door and begin his search.}}<br />
<br />
<br />
<br />
<br />
[[Category:Gameplay]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=The_Dark_Mod_Gameplay&diff=17649The Dark Mod Gameplay2014-03-02T10:32:59Z<p>Sparhawk: /* Doors */</p>
<hr />
<div>{{red|Updates for versions after v1.00 are listed in red, so players can quickly see changes to gameplay since their last read.}}<br />
<br />
Since The Dark Mod is designed to simulate the stealth gameplay of Thief, many things will be very familiar to Thief players. There are some features that work differently, however, and some things that are entirely new to TDM. <br />
<br />
If you have never played Stealth Games before, start with the [[Basics of Stealth Gaming]].<br />
<br />
Veteran stealth gamers can read the various sections below for more detail:<br />
<br />
= The Game Menus =<br />
<br />
Your experience with The Dark Mod will start with the Main Menu, where you may wish to adjust some settings before starting your first mission. If you already have saved games from a currently installed mission, you can load them from the Load/Save menu. <br />
<br />
{{red|Note: While missions remain compatible with all updates, your saved games will not necessarily work after updating, due to code changes.}}<br />
<br />
== Starting a Mission ==<br />
[[Image:new_mission.jpg|thumb|The New Mission menu.]]<br />
<br />
# Select ''New Mission'' from the Main Menu.<br />
# Click "Download" to see a list of missions available to download. You can even read details and see screenshots from the mission before downloading it. {{red|(1.04)}}<br />
# Select a Mission from the Available Mission list on the right (start with the Training Mission if this is your first time) and click ''Install Mission''.<br />
# TDM will install the mission and restart. Select ''New Mission'' again, and click ''Start Mission'' <br />
# You will see a briefing that introduces the mission. Click ''Objectives'' to proceed.<br />
# Read your objectives, and choose your Difficulty Level. Then select ''Buy Equipment'' (or ''Start Mission'' in some missions).<br />
# After purchasing desired equipment, hit ''Start Mission''. (The option to ''Drop'' starting items is available, but use with caution...dropping some items may make a mission impossible to complete)<br />
# The Mission Loading screen should appear. Be patient...loading a mission for the first time can take several minutes.<br />
<br />
To call the Main Menu during the game, press {{ESC}}) .<br />
<br />
See [[Installing and Running Fan Missions]] for more information.<br />
<br />
== Changing Settings ==<br />
<br />
# Select ''Settings'' from the Main Menu<br />
# Select the type of setting you wish to adjust: ''Audio'', ''Video'', ''Controls'', or ''Gameplay''<br />
# The controls are set to defaults familiar to ''Thief'' players, however there are new keys/features that are worth reviewing.<br />
#There are difficulty settings for many things, including lockpicking and {{red| combat. (1.01)}} <br />
# New graphic settings have been added for better graphic quality and bloom. {{red|(1.03)}}<br />
#{{red|A new "AI Vision" option has been added. This controls how quickly AI realize you are an enemy when they spot you. (2.0)}}<br />
<br />
== Objectives ==<br />
<br />
When you call the Main Menu during a mission (by hitting {{ESC}}), you will see an option for "Objectives". This is where you can check your progress.<br />
<br />
Your objectives are also displayed after the Mission Briefing when you first start a mission.<br />
<br />
You can also check your Objectives without going to the menus. Hitting {{key|O}} will bring up your objectives on screen. You can use the mouse wheel to scroll up and down. Note that this method ''does not pause the game''. {{red| (1.01)}}<br />
<br />
When you complete an objective, a chime will sound and “Objective Completed” will be displayed at the top of the screen. <br />
<br />
When you have completed all objectives, the map will close and a “Mission Succeeded” screen will appear. Likewise, if you fail an objective or are killed, a “Failed Mission” screen will appear. You can restart the map by selecting the "Restart" option or via the Main Menu.<br />
<br />
<br />
----<br />
<br />
= HUD Display =<br />
<br />
[[Image:hud.jpg|thumb|The Game Screen indicators.]]<br />
<br />
1. WEAPON ICON: An icon of your currently selected weapon is displayed in the bottom left corner of the screen.<br />
<br />
2. BREATH INDICATOR: When you are underwater a small blue bar will appear above the lightgem. This bar measures how much air you have left. When the blue bar runs out, you start to take damage. Surfacing or using a Breath Potion will restore your air bar. <br />
<br />
3. LIGHTGEM: The lightgem at the bottom of the screen indicates how easy you are to see. This is primarily due to how much light is hitting you, but also includes things like whether you are crouched, moving, or have a weapon drawn. {{red|Being under water also reduces your lightgem. (1.03)}}<br />
<br />
The wings on either side of the gem are a crouch indicator. When you are crouched, the wings 'crouch' down as well. {{red| (1.01) }}<br />
<br />
4. HEALTH INDICATOR: When you are injured, a small red healthbar appears below the lightgem. It will remain visible until you are returned to full health.<br />
<br />
5. INVENTORY ICON: Your currently selected inventory object (or your loot total) is displayed as an icon in the bottom right.<br />
<br />
== Weapons ==<br />
<br />
Weapon hotkeys were changed at the last minute, so this list may need modifying:<br />
* {{key|`}} Put away weapons<br />
* {{key|1}} Blackjack<br />
* {{key|2}} Short Sword<br />
[[Image:arrows.jpg|thumb|A selection of arrows you can choose from.]]<br />
* {{key|3}} Broadheads<br />
* {{key|4}} [[Water Arrows]]<br />
* {{key|5}} [[Fire Arrows]]<br />
* {{key|6}} [[Rope Arrows]] <br />
* {{key|7}} [[Gas Arrows]] <br />
* {{key|8}} [[Noise Arrows]]<br />
* {{key|9}} [[Moss Arrows]]<br />
* {{key|0}} [[Vine Arrows]] {{red| (1.07)}}<br />
<br />
''(note that there has been a report that linux users cannot use the {{key|`}} as it is mapped to the console. Linux users will need to select a different key for 'Put away weapons'.)''<br />
<br />
== Inventory Objects ==<br />
Cycle through your inventory using the Inventory Prev/Next keys (default: {{key|[}} or {{key|TAB}} for next item and {{key|]}} for prev item). Inventory objects are stored in groups, so all keys will be stored together, all readables, etc. You can cycle through groups with the Prev/Next Group keys.<br />
<br />
To ‘use’ an inventory object, select it and then hit the Use key (default: {{key|U}}). This will drink potions, throw mines, activate the spyglass, etc. To "use" objects on other objects (like using a key on a door), select the object in inventory, highlight the thing you want to use it on, and hit Use. <br />
<br />
You can drop inventory items by hitting the Drop key (default: {{key|R}}) twice. See the section "Holding Junk Objects" for more information. Note that mappers may designate some important inventory items as undroppable.<br />
<br />
You can clear the inventory selection by hitting the {{key| ← &nbsp; &nbsp; &nbsp;}} (backspace) key.<br />
<br />
To set hotkeys for your inventory items, please see [[Custom Settings for Players]].<br />
<br />
=== Inventory Object: Flashbomb === <br />
[[Image:equipment.jpg|thumb|The tools of a professional burglar.]]<br />
Activate a flashbomb by selecting it in inventory and hitting Use. Flashbombs detonate on impact. A short tap will cause it to fall and go off at your feet where it won't blind you. Holding down the Use key will throw the flashbomb farther away. If you use the Drop key to put the flashbomb down, it is not activated at all.<br />
<br />
An AI must be looking at the flashbomb to be blinded. Don't look at the point of impact or you'll be blinded too.<br />
<br />
AI are only blinded for a few seconds, and they are alerted by the flash, so this tool is most useful for getting away when you've been spotted, or stunning an enemy before an attack.<br />
<br />
Flashbombs have no effect on the undead.<br />
<br />
=== Inventory Object: Holy Water ===<br />
<br />
Select your holy water in inventory and hit the Use key. This puts holy water into your water arrows, making them lethal to undead. The effect only lasts 30 seconds, so use it wisely.<br />
<br />
=== Inventory Objects: Keys === <br />
Some doors or chests require keys to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
You can also assign a key to ''Cycle Keys'' to quickly cycle through all keys in your inventory. This is a very useful way to get to your keys quickly when you have a lot of other items in your inventory.<br />
<br />
=== Inventory Objects: Lockpicks === <br />
See [[#Lockpicking|Lockpicking]] for more information on lockpicks.<br />
<br />
=== Inventory Objects: Maps and Readables === <br />
<br />
In The Dark Mod, both maps and most readables (books, scrolls, etc) are inventory items. To read them, you scroll to the object in your inventory and then hit the Use key. The map or readable will be displayed on screen. Note that '''this does not pause the game'''. Unlike Thief, events continue to unfold around you, and you can be attacked while reading if not careful. You can see your environment around the edges of the map/readable, but the best suggestion is to find a safe place to read. With multi-page readables (distinguishable by folded corners on the page), use the next/prev inventory or next/prev weapon keys to scroll through pages. Hitting Use or Attack will put the readable away.<br />
<br />
The Map key (default: {{key|M}}) will also automatically bring up your map, if you have one. You can also define a readables key (default: not mapped) to cycle through any readables you have.<br />
<br />
=== Inventory Object: Mines === <br />
<br />
Place a mine by selecting it in inventory and hitting Use. A short tap will drop the mine at your feet. Holding down Use will throw the mine farther away. After a few seconds, the mine is armed and {{red| starts making a distinct ticking sound (1.07) }}. Once you hear the ticking, it will go off if stepped on. <br />
<br />
{{red| Map authors can place a mine and arm it at mission start. It behaves the same as any mine you've thrown: it will explode on contact, and it can be disarmed. So don't assume that any mine you come across is safe to pick up. Listen for the tell-tale armed ticking sound. (1.07) }}<br />
<br />
If you use the Drop key to put the mine down, it is not armed.<br />
<br />
Note that you can set armed mines off by shooting them with an arrow.<br />
<br />
You can disarm an armed mine by using a lockpick on it, the same as you would on a locked door. {{red| (1.07) }} Armed mines give off a distinct ticking sound, which stops when the mine is disarmed. After disarming a mine, you can frob it to put it back into your inventory.<br />
<br />
=== Inventory Object: Player Lantern === <br />
<br />
Light is usually the bane of thieves everywhere, but there are times when you need just a little to make your way around. To this end, some thieves carry a covered lantern with a hood that can be closed to block out the light. To use the lantern, select it in inventory and hit Use. This will lift the cover if the lantern is currently off, or close the cover if it is currently lit. There is also a hotkey for using the lantern; by default this is {{key|L}}. This lantern is clipped to your belt so your hands are free, and it can even be used underwater for short periods.<br />
<br />
Obviously using the lantern makes you clearly visible to any nearby opponents.<br />
<br />
=== Inventory Object: Potions ===<br />
<br />
Potions are used by selecting them in inventory and hitting Use. Healing potions will restore hit points (the effect is somewhat gradual). Breath potions increase the player's breath meter, allowing them to stay underwater longer.<br />
<br />
=== Inventory Object: Spyglass === <br />
<br />
A good Thief likes to scout ahead. To use the spyglass, select it in inventory and hit Use. Or use {{key|G}} as a shortcut. You can use the next/prev weapon keys to zoom in and out. You cannot use weapons or frob objects while using the spyglass.<br />
<br />
= Movement =<br />
<br />
Movement in The Dark Mod is not that different than Thief. You can run, walk, or creep, as well as do any of the three while crouching. The faster you move, the more noise you make.<br />
<br />
== Climbing ==<br />
<br />
In addition to ladders and ropes, many missions allow you to climb vines, pipes and chains.<br />
<br />
Move or jump onto a ladder or vines to "attach" to them. Moving "forward" will move in the direction of your view, be it up, down or to the side. "Back" will reverse, and you may strafe to the side. Move away or jump off to detach.<br />
<br />
Holding crouch will let you slide down a rope or ladder. Release to stop sliding, or hold it down to slide all the way to the bottom.<br />
<br />
=== Swinging on Ropes ===<br />
<br />
Tapping the "attack" key while on a rope or chain will cause the rope to swing forward. You can actually gain more momentum by continuing to tap it every time you start swinging forward (think of it like swinging your legs forward on a swing). This can allow you to jump off the rope and grab ledges that are otherwise too far away.<br />
<br />
Note that the further down the rope you are, the more distance you can travel when swinging (just like a real rope).<br />
<br />
== Mantling ==<br />
There are two different ways to mantle (pull yourself up onto ledges) in The Dark Mod. One is by holding down the Jump key, which Thief players will be familiar with. There is also a key specifically for mantling (default: {{key|<br />
C}}), so that failing to mantle will not result in jumping and making noise. Ideally there should be no difference in these methods, but occasionally one method will work when the other will not.<br />
Mantling is affected by where you are looking, so a successful mantle is more likely if you are looking directly at the edge of the object you wish to climb. To climb on a chair, look down at the seat then press the mantle control. By this means you can clamber over relatively low but awkward obstructions and even select one ledge above/below another.<br />
<br />
You cannot mantle while carrying a junk object or body.<br />
<br />
= Interacting With Your Environment =<br />
<br />
The Dark Mod gives you far more flexibility than previous Thief games when it comes to interacting with things.<br />
<br />
== Manipulating Held Objects ==<br />
This is one area that works quite differently from the Thief series. "Held Objects"(anything that you can carry that doesn’t go into inventory, like chairs, candles, or bodies) are held out in front of you when frobbed. Unlike in Thief, they take up physical space, and can be used to push or manipulate other objects. They can also bump into other objects, making noise (or being knocked out of your hands), so be careful.<br />
<br />
To grab a held object, frob it as normal. The object will stop highlighting, and any weapons you have selected will lower. At this point, you can use the next/prev weapon keys (default: mousewheel up/down) to move the object closer/further away from you, and moving your mouse around will move the object (it stays basically in the center of your screen). <br />
<br />
The heavier the object, the slower it moves, so you may notice a ‘lag’ if you turn quickly with heavy objects. It can take a while to get used to this.<br />
<br />
To drop an object, hit the Drop key (default: {{key|R}}). By crouching and angling your view down gently, you'll find that you can easily set down objects without making noise. You can also throw a held object by hitting the Attack key. Tapping the Attack key throws the object a short distance; holding the Attack key down and releasing it will throw it further.<br />
<br />
To rotate a held object, hold down the {{key|Z}} key or middle mouse button, and move your mouse. <br />
(By default, horizontal movement of the mouse yaws the object around the vertical axis, and vertical movement pitches the object up and down. Holding down the Run key makes horizontal mouse movement roll the object around the forward axis.) This can be useful for replacing objects that have been knocked over, or for placing moveable objects in creative ways (like putting a plank over a gap, or stacking chairs).<br />
It is possible to “drop” inventory items into your hands, where they can be manipulated as if they were held objects. Select the object in your inventory, and hit the Drop key {{key|R}}. The object will appear in front of you like a held object, and you can rotate it, set it down, etc. To put it back into your inventory, you must "use" the item again ({{key|U}}) or scroll to the next inventory item ({{key|TAB}} or {{key|[}}/{{key|]}}).<br />
[[Image:candles6.jpg|thumb|[http://www.youtube.com/watch?v=922ArtrKgC4 Click to see TDM candles in action.] ]]<br />
AI will hear junk objects that are dropped or banged around. It takes some skill to pick up objects on a crowded table without knocking them into each other. Remember than an object moves to the center of the screen when you pick it up. If you are looking slightly above the object, it will jump up to center screen (usually a good thing). If you're looking slightly below the object, it will jump down, banging whatever surface it rests on (a bad thing). A little practice may be required to smoothly and quietly sort through objects.<br />
<br />
Some objects that are too heavy to lift may still be movable (like large crates). Walking or running into such objects may (mapper's choice) push them along the ground.<br />
<br />
=== Held Objects: Candles ===<br />
<br />
Lit candles can be frobbed and carried around to light your way (obviously you will be easily spotted while carrying a lit candle). They can also be used to light flammable objects like other candles or torches. Click the caption on the right for a demonstration.<br />
<br />
Candles can be extinguished by water, or you can pinch them out by picking them up and clicking the Use key. (Note that this method can also be used on some movable lanterns). {{red|Candles will usually go out after a few seconds if they get knocked over. (1.06) }}<br />
<br />
Be aware that multiple light sources can cause a significant drain on your framerate. If you go around a room lighting six or seven new candles, don't be surprised if your framerate drops significantly.<br />
<br />
=== Held Objects: Bodies ===<br />
<br />
Bodies work differently than most other objects. There are two ways to deal with dead or unconscious bodies in The Dark Mod. You can both drag them and carry them.<br />
<br />
To drag a body, you must ‘frob’ it (which probably requires crouching), and then move your mouse around. The body will drag along with you until you frob it again or the body gets stuck on something. <br />
<br />
This is not the most graceful way of moving bodies and is not recommended for long distances. Bodies can catch on things and get pulled out of your hands. It can be useful for quickly shifting a body into a shadow, however. You can even move individual limbs to put a flailing arm back into a shadow.<br />
<br />
You can also carry a body over your shoulder. While a body is being dragged, hitting the Use button will lift it up over your shoulder. While carrying a body you move more slowly and cannot use weapons or inventory objects (though you can open doors). When you are ready to drop the body, hit Use again. If there is not enough room, you will hear a grunt and nothing will happen. Back up a bit and try again. When you drop a body, it will be the opposite orientation from the way you picked it up (if a body is face-up when you lift it, it will be face-down when you drop it). This allows you to easily search a body for keys or other objects.<br />
<br />
=== Held Objects: Food ===<br />
<br />
Some food can be eaten. When holding a piece of food (such as an apple) hit the "use" key. If the food is edible, you will 'eat' it. Discard any left-overs. Some of the healthy food will heal you by 1 HP.<br />
<br />
== Doors == <br />
You can interrupt a door opening or closing by frobbing it again. Frobbing a moving door stops it, allowing you to open a door just a crack to peer beyond.<br />
<br />
You can lean into a door (use the lean left/right keys) to press your ear up against it and hear what's on the other side. Note that while you're concentrating on what's beyond the door you'll be less able to hear the sounds in the room you're currently in.<br />
<br />
Some doors or chests are locked and require keys (or lockpicks, see below) to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
Depending on how important a specific door is, the mapper can choose to set flags on it. Check out the [[AI_Behaviour]] section, for details on how the AI responds in such cases.<br />
<br />
== Lockpicking ==<br />
You will definitely want to practice lockpicking in the Training Mission before trying a real map. Just reading the instructions is probably not enough to get the hang of it. <br />
<br />
There are two types of lockpicks, 'triangle' and 'snake'. To begin, you must have the correct lockpick selected in inventory. If you do not, you will see a red flash behind the lockpick icon when you frob the locked door. To pick a lock, move close enough to highlight the door and hold the Use key. You will start to hear a sequence of clicks, and see the door handle (or lock pin) jiggle in sync.<br />
<br />
The clicks are a random pattern. At the end of the pattern is a brief period of silence, then the pattern will begin again. To be successful you must hit the Attack key (or release the Use key if you prefer) at the start of that silence. If you hit the Attack key at the wrong time there is a dull 'fail' sound and the pattern begins again. Your goal is to learn the sequence of clicks so that you can anticipate when it will end. This requires concentration.<br />
<br />
Some locks are more difficult than others and have multiple pins (which may require switching lockpicks). You can make lockpicking harder or easier in the Settings Menu, by adjusting how much silence there is between each pattern (the more silence, the easier it is to react in time). Setting Lockpicking to "Auto" will make locks open automatically after the pattern repeats 3 times.<br />
<br />
{{red| Armed mines can be disarmed by lockpicking them. Afterward, they can be frobbed and put into inventory. Either lockpick type can be used. (1.07) }}<br />
<br />
== Chests ==<br />
It can sometimes be a little awkward frobbing items inside deep chests. Leaning forward (or even sideways) will usually help.<br />
<br />
If you get too close to a chest, you can sometimes get in the way of the lid opening or closing. Back up a little if the lid is not moving as expected.<br />
<br />
<br />
----<br />
<br />
= Combat =<br />
<br />
There are a number of ways that combat is different in The Dark Mod.<br />
<br />
Keep in mind that you are not a warrior. Guards are generally better trained than you are, and while you might win a few one-on-one battles, you will almost certainly die if facing two guards at once.<br />
<br />
== Blackjacking ==<br />
<br />
Your blackjack is more effective if your opponent is relaxed and not expecting trouble.<br />
<br />
You must hit an AI on the head to knock them out. Hitting an AI anywhere else will simply alert them. For best results, don't get too close to the AI, or you may hit them with your elbow instead of your blackjack.<br />
<br />
'''You can successfully knock out:'''<br />
<br />
'''1. Unarmed civilian AI from any direction, any time.'''<br />
<br />
'''2. Bare-headed guards from any direction when relaxed, or from behind when their weapon is out.'''<br />
<br />
'''3. Helmeted guards from behind when relaxed (helmeted guards cannot be knocked out when their weapon is out).'''<br />
<br />
All armed AI are harder to knock out when the AI has drawn a weapon, because they are assumed to be ready for you. Either they have searched for you or been warned by a friend that something is wrong.<br />
<br />
The blackjack does a small amount of damage, so you could theoretically beat someone to death with it, if you have a lot of time on your hands.<br />
<br />
Undead and some animals cannot be knocked out with the blackjack.<br />
<br />
{{update|1.01|Certain heavy-duty helmets make their wearer immune to the blackjack. These can be identified by a face grill and a low back, which protects the base of the neck.}}<br />
<br />
'''Note:''' the blackjack makes an overhead swing, so if there is something low in the way (like a doorframe) you might hit it instead of your target, especially if you are looking upwards.<br />
<br />
== Melee Combat ==<br />
[[image:combat1.jpg|thumb|A guard winds up for an overhead attack]]<br />
There is a combat arena in the Training Map for practicing combat. After a few rounds you will have a much better feel for how it works.<br />
<br />
{{update|1.01|Different AI have different skill levels (novice, trained, skilled) when it comes to combat. An armed commoner will not fight as well as an elite guard. You can also change the overall combat difficulty in the Settings menu.}}<br />
<br />
You can use your shortsword to attack an enemy, as well as block enemy weapons. Attacking a relaxed enemy (ie, backstabbing) does extra damage. <br />
To attack, hit the Attack key. This will make a left-to-right, slashing attack. If you move the mouse while clicking the Attack key, you can select other kinds of attacks. Moving the mouse down will cause an overhead swing. Moving the mouse up will cause a thrust attack. Moving the mouse left or right will cause a right-to-left or left-to-right slash, respectively. <br />
<br />
AI can parry your swings (unless they are using a dagger), and they will do this more easily if you keep using the same kind of attack, so you will want to mix it up. <br />
<br />
The amount of damage you do varies depending on where you hit. Hitting an AI in the head will do more damage than hitting their arm or leg. Armour also plays a factor. Your sword can't penetrate plate armour, and even chainmail or leather armour will provide the AI some protection.<br />
<br />
To block an enemy strike, hold the Parry key. You must hit the parry key ''after'' the AI starts winding up for their attack. Too early and the AI will see the block and choose a different attack. Obviously, you must also be facing the AI...holding up a block while looking off to the side won't help.<br />
<br />
If you are using Manual Parry (select in the Settings menu), you need to select the appropriate block. If your opponent is making an overhead attack, you must select an overhead block. Select blocks by moving the mouse while holding the Parry button down, just as you would for an attack. <br />
<br />
If you successfully block an attack or damage your opponent the AI will be temporarily "flat-footed". They can still attack and defend, but they will not chase you if you turn to run. The effect lasts only a second or two, but that can sometimes be enough time to give you a head start.<br />
<br />
The trick to a successful combat is timing. You need to try to anticipate your opponent's attacks, and then launch counter-attacks before he has a chance to parry.<br />
<br />
AI will usually try to flee if they are badly wounded.<br />
<br />
{{update|1.07|Different weapons do different amounts of damage when they hit you. A longsword is one of the most damaging weapons, while short swords do less damage and daggers even less.}}<br />
<br />
'''Note:''' It is possible to hit walls or ceilings instead of your target. Keep track of how much space is around you when choosing your swing.<br />
<br />
== Missile Combat ==<br />
<br />
Your broadhead arrows cannot penetrate plate armour, and will do less damage if they hit chain or leather armour. The best result is to hit unarmoured flesh. A single arrow to the head will kill a relaxed guard. Alert guards are assumed to be taking measures to minimize the damage from incoming arrows. <br />
<br />
If you are hit while trying to fire an arrow, your attack will be canceled.<br />
<br />
AI will switch to missile combat if they can see you but cannot reach you. If they don't have a missile weapon, they will become angry and start throwing things at you.<br />
<br />
AI archers will fire arrows at you. Some AI are better shots than others. When you get within melee range of an archer, they will pull out their melee weapon to fight with it instead.<br />
<br />
<br />
----<br />
<br />
= AI =<br />
<br />
== AI Senses ==<br />
<br />
AI can see you if your lightgem is not totally black. The longer you're in their field of vision and the closer you are, the more likely they are to notice you and come and investigate. <br />
<br />
Some AI have hoods, eyepatches, or other things that block their field of vision. These can be exploited by clever thieves. {{red| (1.01) }}<br />
<br />
AI can hear your footsteps, and noise that you make from banging into things or dropping objects. {{update|2.0|They can also hear the sound of falling bodies, so be careful where you knock out opponents.}}<br />
<br />
AI can also feel you if you bump into them, or vice versa.<br />
<br />
TDM AI are fairly intelligent about searching. They can identify good hiding spots and will check them out first.<br />
<br />
When AI become alert, their senses get slightly better. A shadow that is sufficient to hide you from a relaxed AI might not be enough for an AI that is alert and actively looking for trouble.<br />
<br />
AI do not forget about you after giving up the search. They remain in an alert state, with heightened senses and their weapons out.<br />
<br />
== AI Behaviour ==<br />
<br />
AI don't necessarily patrol the exact same route every time, or stand for the same amount of time at every spot they go to. Mappers can add as much randomness to the AI as they wish.<br />
<br />
AI need to see evidence in order to react to it. If a bloodstain or missing loot is in shadow, an AI won't notice it.<br />
<br />
AI can react to missing objects, but only if mappers set the objects as noteworthy.<br />
<br />
AI become suspicious if they find a weapon lying around. Finding blood or a body will cause them to go fully alert.<br />
<br />
AI can hear broadhead arrow impacts. If you shoot an arrow and it hits a wall nearby, the AI will notice. AI will also react to water arrows if you fire them too close (or if you hit an AI with one). {{update|1.07|AI will notice and be suspicious of arrows that are left sticking into things.}}<br />
<br />
<br />
AI do not yet notice moss arrow impacts, broken objects or moss patches. These things will likely cause minor alerts in the future.<br />
<br />
{{update|1.06| AI can notice and comment on lights that have been put out, and may relight ones that the mapper has set as important. AI will start to become suspicious of an intruder if this happens frequently.}}<br />
<br />
{{update|1.07| AI that see a rope from a rope arrow will walk over to investigate, and will treat it as evidence of an intruder.}}<br />
<br />
{{update|1.07| AI can notice important doors (set by mapper) that have been left open, and will start to become suspicious.}}<br />
<br />
{{red| AI will turn towards doors that they see opening, and may get suspicious if they don't see anyone responsible. (2.00) }} <br />
<br />
AI will look for 2s at a door opening in their FOV, unless they’re in combat mode.<br />
<br />
An AI will not look at an open door if they were the last one to handle it.<br />
<br />
===For an unsuspicious door:===<br />
<br />
The door starts to open, stims the AI, but the AI ignores it, because the door is < 20% open. One second later, when the next stim hits him, if the door is < 20% open, he'll continue to ignore it. Otherwise, he'll look at the door for 2 seconds. Non-suspicious doors can be cracked open indefinitely w/o nearby AI noticing.<br />
<br />
===For a suspicious door:===<br />
<br />
<br />
Allow player to crack open (< 20%) a suspicious door to peek out w/o grabbing the attention of a nearby AI. After 5s, the AI will notice the cracked open door.<br />
<br />
When the door is >20%, it stims the AI, and the AI immediately starts to look at it for 2 seconds. 1 to 1.5 seconds after the stim, while looking at the door, if no friendlies are apparent, the AI will bark and walk toward the door and begin his search.}}<br />
<br />
<br />
<br />
<br />
[[Category:Gameplay]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=The_Dark_Mod_Gameplay&diff=17648The Dark Mod Gameplay2014-03-02T10:31:44Z<p>Sparhawk: /* Doors */</p>
<hr />
<div>{{red|Updates for versions after v1.00 are listed in red, so players can quickly see changes to gameplay since their last read.}}<br />
<br />
Since The Dark Mod is designed to simulate the stealth gameplay of Thief, many things will be very familiar to Thief players. There are some features that work differently, however, and some things that are entirely new to TDM. <br />
<br />
If you have never played Stealth Games before, start with the [[Basics of Stealth Gaming]].<br />
<br />
Veteran stealth gamers can read the various sections below for more detail:<br />
<br />
= The Game Menus =<br />
<br />
Your experience with The Dark Mod will start with the Main Menu, where you may wish to adjust some settings before starting your first mission. If you already have saved games from a currently installed mission, you can load them from the Load/Save menu. <br />
<br />
{{red|Note: While missions remain compatible with all updates, your saved games will not necessarily work after updating, due to code changes.}}<br />
<br />
== Starting a Mission ==<br />
[[Image:new_mission.jpg|thumb|The New Mission menu.]]<br />
<br />
# Select ''New Mission'' from the Main Menu.<br />
# Click "Download" to see a list of missions available to download. You can even read details and see screenshots from the mission before downloading it. {{red|(1.04)}}<br />
# Select a Mission from the Available Mission list on the right (start with the Training Mission if this is your first time) and click ''Install Mission''.<br />
# TDM will install the mission and restart. Select ''New Mission'' again, and click ''Start Mission'' <br />
# You will see a briefing that introduces the mission. Click ''Objectives'' to proceed.<br />
# Read your objectives, and choose your Difficulty Level. Then select ''Buy Equipment'' (or ''Start Mission'' in some missions).<br />
# After purchasing desired equipment, hit ''Start Mission''. (The option to ''Drop'' starting items is available, but use with caution...dropping some items may make a mission impossible to complete)<br />
# The Mission Loading screen should appear. Be patient...loading a mission for the first time can take several minutes.<br />
<br />
To call the Main Menu during the game, press {{ESC}}) .<br />
<br />
See [[Installing and Running Fan Missions]] for more information.<br />
<br />
== Changing Settings ==<br />
<br />
# Select ''Settings'' from the Main Menu<br />
# Select the type of setting you wish to adjust: ''Audio'', ''Video'', ''Controls'', or ''Gameplay''<br />
# The controls are set to defaults familiar to ''Thief'' players, however there are new keys/features that are worth reviewing.<br />
#There are difficulty settings for many things, including lockpicking and {{red| combat. (1.01)}} <br />
# New graphic settings have been added for better graphic quality and bloom. {{red|(1.03)}}<br />
#{{red|A new "AI Vision" option has been added. This controls how quickly AI realize you are an enemy when they spot you. (2.0)}}<br />
<br />
== Objectives ==<br />
<br />
When you call the Main Menu during a mission (by hitting {{ESC}}), you will see an option for "Objectives". This is where you can check your progress.<br />
<br />
Your objectives are also displayed after the Mission Briefing when you first start a mission.<br />
<br />
You can also check your Objectives without going to the menus. Hitting {{key|O}} will bring up your objectives on screen. You can use the mouse wheel to scroll up and down. Note that this method ''does not pause the game''. {{red| (1.01)}}<br />
<br />
When you complete an objective, a chime will sound and “Objective Completed” will be displayed at the top of the screen. <br />
<br />
When you have completed all objectives, the map will close and a “Mission Succeeded” screen will appear. Likewise, if you fail an objective or are killed, a “Failed Mission” screen will appear. You can restart the map by selecting the "Restart" option or via the Main Menu.<br />
<br />
<br />
----<br />
<br />
= HUD Display =<br />
<br />
[[Image:hud.jpg|thumb|The Game Screen indicators.]]<br />
<br />
1. WEAPON ICON: An icon of your currently selected weapon is displayed in the bottom left corner of the screen.<br />
<br />
2. BREATH INDICATOR: When you are underwater a small blue bar will appear above the lightgem. This bar measures how much air you have left. When the blue bar runs out, you start to take damage. Surfacing or using a Breath Potion will restore your air bar. <br />
<br />
3. LIGHTGEM: The lightgem at the bottom of the screen indicates how easy you are to see. This is primarily due to how much light is hitting you, but also includes things like whether you are crouched, moving, or have a weapon drawn. {{red|Being under water also reduces your lightgem. (1.03)}}<br />
<br />
The wings on either side of the gem are a crouch indicator. When you are crouched, the wings 'crouch' down as well. {{red| (1.01) }}<br />
<br />
4. HEALTH INDICATOR: When you are injured, a small red healthbar appears below the lightgem. It will remain visible until you are returned to full health.<br />
<br />
5. INVENTORY ICON: Your currently selected inventory object (or your loot total) is displayed as an icon in the bottom right.<br />
<br />
== Weapons ==<br />
<br />
Weapon hotkeys were changed at the last minute, so this list may need modifying:<br />
* {{key|`}} Put away weapons<br />
* {{key|1}} Blackjack<br />
* {{key|2}} Short Sword<br />
[[Image:arrows.jpg|thumb|A selection of arrows you can choose from.]]<br />
* {{key|3}} Broadheads<br />
* {{key|4}} [[Water Arrows]]<br />
* {{key|5}} [[Fire Arrows]]<br />
* {{key|6}} [[Rope Arrows]] <br />
* {{key|7}} [[Gas Arrows]] <br />
* {{key|8}} [[Noise Arrows]]<br />
* {{key|9}} [[Moss Arrows]]<br />
* {{key|0}} [[Vine Arrows]] {{red| (1.07)}}<br />
<br />
''(note that there has been a report that linux users cannot use the {{key|`}} as it is mapped to the console. Linux users will need to select a different key for 'Put away weapons'.)''<br />
<br />
== Inventory Objects ==<br />
Cycle through your inventory using the Inventory Prev/Next keys (default: {{key|[}} or {{key|TAB}} for next item and {{key|]}} for prev item). Inventory objects are stored in groups, so all keys will be stored together, all readables, etc. You can cycle through groups with the Prev/Next Group keys.<br />
<br />
To ‘use’ an inventory object, select it and then hit the Use key (default: {{key|U}}). This will drink potions, throw mines, activate the spyglass, etc. To "use" objects on other objects (like using a key on a door), select the object in inventory, highlight the thing you want to use it on, and hit Use. <br />
<br />
You can drop inventory items by hitting the Drop key (default: {{key|R}}) twice. See the section "Holding Junk Objects" for more information. Note that mappers may designate some important inventory items as undroppable.<br />
<br />
You can clear the inventory selection by hitting the {{key| ← &nbsp; &nbsp; &nbsp;}} (backspace) key.<br />
<br />
To set hotkeys for your inventory items, please see [[Custom Settings for Players]].<br />
<br />
=== Inventory Object: Flashbomb === <br />
[[Image:equipment.jpg|thumb|The tools of a professional burglar.]]<br />
Activate a flashbomb by selecting it in inventory and hitting Use. Flashbombs detonate on impact. A short tap will cause it to fall and go off at your feet where it won't blind you. Holding down the Use key will throw the flashbomb farther away. If you use the Drop key to put the flashbomb down, it is not activated at all.<br />
<br />
An AI must be looking at the flashbomb to be blinded. Don't look at the point of impact or you'll be blinded too.<br />
<br />
AI are only blinded for a few seconds, and they are alerted by the flash, so this tool is most useful for getting away when you've been spotted, or stunning an enemy before an attack.<br />
<br />
Flashbombs have no effect on the undead.<br />
<br />
=== Inventory Object: Holy Water ===<br />
<br />
Select your holy water in inventory and hit the Use key. This puts holy water into your water arrows, making them lethal to undead. The effect only lasts 30 seconds, so use it wisely.<br />
<br />
=== Inventory Objects: Keys === <br />
Some doors or chests require keys to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
You can also assign a key to ''Cycle Keys'' to quickly cycle through all keys in your inventory. This is a very useful way to get to your keys quickly when you have a lot of other items in your inventory.<br />
<br />
=== Inventory Objects: Lockpicks === <br />
See [[#Lockpicking|Lockpicking]] for more information on lockpicks.<br />
<br />
=== Inventory Objects: Maps and Readables === <br />
<br />
In The Dark Mod, both maps and most readables (books, scrolls, etc) are inventory items. To read them, you scroll to the object in your inventory and then hit the Use key. The map or readable will be displayed on screen. Note that '''this does not pause the game'''. Unlike Thief, events continue to unfold around you, and you can be attacked while reading if not careful. You can see your environment around the edges of the map/readable, but the best suggestion is to find a safe place to read. With multi-page readables (distinguishable by folded corners on the page), use the next/prev inventory or next/prev weapon keys to scroll through pages. Hitting Use or Attack will put the readable away.<br />
<br />
The Map key (default: {{key|M}}) will also automatically bring up your map, if you have one. You can also define a readables key (default: not mapped) to cycle through any readables you have.<br />
<br />
=== Inventory Object: Mines === <br />
<br />
Place a mine by selecting it in inventory and hitting Use. A short tap will drop the mine at your feet. Holding down Use will throw the mine farther away. After a few seconds, the mine is armed and {{red| starts making a distinct ticking sound (1.07) }}. Once you hear the ticking, it will go off if stepped on. <br />
<br />
{{red| Map authors can place a mine and arm it at mission start. It behaves the same as any mine you've thrown: it will explode on contact, and it can be disarmed. So don't assume that any mine you come across is safe to pick up. Listen for the tell-tale armed ticking sound. (1.07) }}<br />
<br />
If you use the Drop key to put the mine down, it is not armed.<br />
<br />
Note that you can set armed mines off by shooting them with an arrow.<br />
<br />
You can disarm an armed mine by using a lockpick on it, the same as you would on a locked door. {{red| (1.07) }} Armed mines give off a distinct ticking sound, which stops when the mine is disarmed. After disarming a mine, you can frob it to put it back into your inventory.<br />
<br />
=== Inventory Object: Player Lantern === <br />
<br />
Light is usually the bane of thieves everywhere, but there are times when you need just a little to make your way around. To this end, some thieves carry a covered lantern with a hood that can be closed to block out the light. To use the lantern, select it in inventory and hit Use. This will lift the cover if the lantern is currently off, or close the cover if it is currently lit. There is also a hotkey for using the lantern; by default this is {{key|L}}. This lantern is clipped to your belt so your hands are free, and it can even be used underwater for short periods.<br />
<br />
Obviously using the lantern makes you clearly visible to any nearby opponents.<br />
<br />
=== Inventory Object: Potions ===<br />
<br />
Potions are used by selecting them in inventory and hitting Use. Healing potions will restore hit points (the effect is somewhat gradual). Breath potions increase the player's breath meter, allowing them to stay underwater longer.<br />
<br />
=== Inventory Object: Spyglass === <br />
<br />
A good Thief likes to scout ahead. To use the spyglass, select it in inventory and hit Use. Or use {{key|G}} as a shortcut. You can use the next/prev weapon keys to zoom in and out. You cannot use weapons or frob objects while using the spyglass.<br />
<br />
= Movement =<br />
<br />
Movement in The Dark Mod is not that different than Thief. You can run, walk, or creep, as well as do any of the three while crouching. The faster you move, the more noise you make.<br />
<br />
== Climbing ==<br />
<br />
In addition to ladders and ropes, many missions allow you to climb vines, pipes and chains.<br />
<br />
Move or jump onto a ladder or vines to "attach" to them. Moving "forward" will move in the direction of your view, be it up, down or to the side. "Back" will reverse, and you may strafe to the side. Move away or jump off to detach.<br />
<br />
Holding crouch will let you slide down a rope or ladder. Release to stop sliding, or hold it down to slide all the way to the bottom.<br />
<br />
=== Swinging on Ropes ===<br />
<br />
Tapping the "attack" key while on a rope or chain will cause the rope to swing forward. You can actually gain more momentum by continuing to tap it every time you start swinging forward (think of it like swinging your legs forward on a swing). This can allow you to jump off the rope and grab ledges that are otherwise too far away.<br />
<br />
Note that the further down the rope you are, the more distance you can travel when swinging (just like a real rope).<br />
<br />
== Mantling ==<br />
There are two different ways to mantle (pull yourself up onto ledges) in The Dark Mod. One is by holding down the Jump key, which Thief players will be familiar with. There is also a key specifically for mantling (default: {{key|<br />
C}}), so that failing to mantle will not result in jumping and making noise. Ideally there should be no difference in these methods, but occasionally one method will work when the other will not.<br />
Mantling is affected by where you are looking, so a successful mantle is more likely if you are looking directly at the edge of the object you wish to climb. To climb on a chair, look down at the seat then press the mantle control. By this means you can clamber over relatively low but awkward obstructions and even select one ledge above/below another.<br />
<br />
You cannot mantle while carrying a junk object or body.<br />
<br />
= Interacting With Your Environment =<br />
<br />
The Dark Mod gives you far more flexibility than previous Thief games when it comes to interacting with things.<br />
<br />
== Manipulating Held Objects ==<br />
This is one area that works quite differently from the Thief series. "Held Objects"(anything that you can carry that doesn’t go into inventory, like chairs, candles, or bodies) are held out in front of you when frobbed. Unlike in Thief, they take up physical space, and can be used to push or manipulate other objects. They can also bump into other objects, making noise (or being knocked out of your hands), so be careful.<br />
<br />
To grab a held object, frob it as normal. The object will stop highlighting, and any weapons you have selected will lower. At this point, you can use the next/prev weapon keys (default: mousewheel up/down) to move the object closer/further away from you, and moving your mouse around will move the object (it stays basically in the center of your screen). <br />
<br />
The heavier the object, the slower it moves, so you may notice a ‘lag’ if you turn quickly with heavy objects. It can take a while to get used to this.<br />
<br />
To drop an object, hit the Drop key (default: {{key|R}}). By crouching and angling your view down gently, you'll find that you can easily set down objects without making noise. You can also throw a held object by hitting the Attack key. Tapping the Attack key throws the object a short distance; holding the Attack key down and releasing it will throw it further.<br />
<br />
To rotate a held object, hold down the {{key|Z}} key or middle mouse button, and move your mouse. <br />
(By default, horizontal movement of the mouse yaws the object around the vertical axis, and vertical movement pitches the object up and down. Holding down the Run key makes horizontal mouse movement roll the object around the forward axis.) This can be useful for replacing objects that have been knocked over, or for placing moveable objects in creative ways (like putting a plank over a gap, or stacking chairs).<br />
It is possible to “drop” inventory items into your hands, where they can be manipulated as if they were held objects. Select the object in your inventory, and hit the Drop key {{key|R}}. The object will appear in front of you like a held object, and you can rotate it, set it down, etc. To put it back into your inventory, you must "use" the item again ({{key|U}}) or scroll to the next inventory item ({{key|TAB}} or {{key|[}}/{{key|]}}).<br />
[[Image:candles6.jpg|thumb|[http://www.youtube.com/watch?v=922ArtrKgC4 Click to see TDM candles in action.] ]]<br />
AI will hear junk objects that are dropped or banged around. It takes some skill to pick up objects on a crowded table without knocking them into each other. Remember than an object moves to the center of the screen when you pick it up. If you are looking slightly above the object, it will jump up to center screen (usually a good thing). If you're looking slightly below the object, it will jump down, banging whatever surface it rests on (a bad thing). A little practice may be required to smoothly and quietly sort through objects.<br />
<br />
Some objects that are too heavy to lift may still be movable (like large crates). Walking or running into such objects may (mapper's choice) push them along the ground.<br />
<br />
=== Held Objects: Candles ===<br />
<br />
Lit candles can be frobbed and carried around to light your way (obviously you will be easily spotted while carrying a lit candle). They can also be used to light flammable objects like other candles or torches. Click the caption on the right for a demonstration.<br />
<br />
Candles can be extinguished by water, or you can pinch them out by picking them up and clicking the Use key. (Note that this method can also be used on some movable lanterns). {{red|Candles will usually go out after a few seconds if they get knocked over. (1.06) }}<br />
<br />
Be aware that multiple light sources can cause a significant drain on your framerate. If you go around a room lighting six or seven new candles, don't be surprised if your framerate drops significantly.<br />
<br />
=== Held Objects: Bodies ===<br />
<br />
Bodies work differently than most other objects. There are two ways to deal with dead or unconscious bodies in The Dark Mod. You can both drag them and carry them.<br />
<br />
To drag a body, you must ‘frob’ it (which probably requires crouching), and then move your mouse around. The body will drag along with you until you frob it again or the body gets stuck on something. <br />
<br />
This is not the most graceful way of moving bodies and is not recommended for long distances. Bodies can catch on things and get pulled out of your hands. It can be useful for quickly shifting a body into a shadow, however. You can even move individual limbs to put a flailing arm back into a shadow.<br />
<br />
You can also carry a body over your shoulder. While a body is being dragged, hitting the Use button will lift it up over your shoulder. While carrying a body you move more slowly and cannot use weapons or inventory objects (though you can open doors). When you are ready to drop the body, hit Use again. If there is not enough room, you will hear a grunt and nothing will happen. Back up a bit and try again. When you drop a body, it will be the opposite orientation from the way you picked it up (if a body is face-up when you lift it, it will be face-down when you drop it). This allows you to easily search a body for keys or other objects.<br />
<br />
=== Held Objects: Food ===<br />
<br />
Some food can be eaten. When holding a piece of food (such as an apple) hit the "use" key. If the food is edible, you will 'eat' it. Discard any left-overs. Some of the healthy food will heal you by 1 HP.<br />
<br />
== Doors == <br />
You can interrupt a door opening or closing by frobbing it again. Frobbing a moving door stops it, allowing you to open a door just a crack to peer beyond.<br />
<br />
You can lean into a door (use the lean left/right keys) to press your ear up against it and hear what's on the other side. Note that while you're concentrating on what's beyond the door you'll be less able to hear the sounds in the room you're currently in.<br />
<br />
Some doors or chests are locked and require keys (or lockpicks, see below) to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
Depending on how important a specific door is, the mapper can choose to set flags on it. Check out the http://wiki.thedarkmod.com/index.php?title=The_Dark_Mod_Gameplay#AI_Behaviour section, for details on how the AI responds in such cases.<br />
<br />
== Lockpicking ==<br />
You will definitely want to practice lockpicking in the Training Mission before trying a real map. Just reading the instructions is probably not enough to get the hang of it. <br />
<br />
There are two types of lockpicks, 'triangle' and 'snake'. To begin, you must have the correct lockpick selected in inventory. If you do not, you will see a red flash behind the lockpick icon when you frob the locked door. To pick a lock, move close enough to highlight the door and hold the Use key. You will start to hear a sequence of clicks, and see the door handle (or lock pin) jiggle in sync.<br />
<br />
The clicks are a random pattern. At the end of the pattern is a brief period of silence, then the pattern will begin again. To be successful you must hit the Attack key (or release the Use key if you prefer) at the start of that silence. If you hit the Attack key at the wrong time there is a dull 'fail' sound and the pattern begins again. Your goal is to learn the sequence of clicks so that you can anticipate when it will end. This requires concentration.<br />
<br />
Some locks are more difficult than others and have multiple pins (which may require switching lockpicks). You can make lockpicking harder or easier in the Settings Menu, by adjusting how much silence there is between each pattern (the more silence, the easier it is to react in time). Setting Lockpicking to "Auto" will make locks open automatically after the pattern repeats 3 times.<br />
<br />
{{red| Armed mines can be disarmed by lockpicking them. Afterward, they can be frobbed and put into inventory. Either lockpick type can be used. (1.07) }}<br />
<br />
== Chests ==<br />
It can sometimes be a little awkward frobbing items inside deep chests. Leaning forward (or even sideways) will usually help.<br />
<br />
If you get too close to a chest, you can sometimes get in the way of the lid opening or closing. Back up a little if the lid is not moving as expected.<br />
<br />
<br />
----<br />
<br />
= Combat =<br />
<br />
There are a number of ways that combat is different in The Dark Mod.<br />
<br />
Keep in mind that you are not a warrior. Guards are generally better trained than you are, and while you might win a few one-on-one battles, you will almost certainly die if facing two guards at once.<br />
<br />
== Blackjacking ==<br />
<br />
Your blackjack is more effective if your opponent is relaxed and not expecting trouble.<br />
<br />
You must hit an AI on the head to knock them out. Hitting an AI anywhere else will simply alert them. For best results, don't get too close to the AI, or you may hit them with your elbow instead of your blackjack.<br />
<br />
'''You can successfully knock out:'''<br />
<br />
'''1. Unarmed civilian AI from any direction, any time.'''<br />
<br />
'''2. Bare-headed guards from any direction when relaxed, or from behind when their weapon is out.'''<br />
<br />
'''3. Helmeted guards from behind when relaxed (helmeted guards cannot be knocked out when their weapon is out).'''<br />
<br />
All armed AI are harder to knock out when the AI has drawn a weapon, because they are assumed to be ready for you. Either they have searched for you or been warned by a friend that something is wrong.<br />
<br />
The blackjack does a small amount of damage, so you could theoretically beat someone to death with it, if you have a lot of time on your hands.<br />
<br />
Undead and some animals cannot be knocked out with the blackjack.<br />
<br />
{{update|1.01|Certain heavy-duty helmets make their wearer immune to the blackjack. These can be identified by a face grill and a low back, which protects the base of the neck.}}<br />
<br />
'''Note:''' the blackjack makes an overhead swing, so if there is something low in the way (like a doorframe) you might hit it instead of your target, especially if you are looking upwards.<br />
<br />
== Melee Combat ==<br />
[[image:combat1.jpg|thumb|A guard winds up for an overhead attack]]<br />
There is a combat arena in the Training Map for practicing combat. After a few rounds you will have a much better feel for how it works.<br />
<br />
{{update|1.01|Different AI have different skill levels (novice, trained, skilled) when it comes to combat. An armed commoner will not fight as well as an elite guard. You can also change the overall combat difficulty in the Settings menu.}}<br />
<br />
You can use your shortsword to attack an enemy, as well as block enemy weapons. Attacking a relaxed enemy (ie, backstabbing) does extra damage. <br />
To attack, hit the Attack key. This will make a left-to-right, slashing attack. If you move the mouse while clicking the Attack key, you can select other kinds of attacks. Moving the mouse down will cause an overhead swing. Moving the mouse up will cause a thrust attack. Moving the mouse left or right will cause a right-to-left or left-to-right slash, respectively. <br />
<br />
AI can parry your swings (unless they are using a dagger), and they will do this more easily if you keep using the same kind of attack, so you will want to mix it up. <br />
<br />
The amount of damage you do varies depending on where you hit. Hitting an AI in the head will do more damage than hitting their arm or leg. Armour also plays a factor. Your sword can't penetrate plate armour, and even chainmail or leather armour will provide the AI some protection.<br />
<br />
To block an enemy strike, hold the Parry key. You must hit the parry key ''after'' the AI starts winding up for their attack. Too early and the AI will see the block and choose a different attack. Obviously, you must also be facing the AI...holding up a block while looking off to the side won't help.<br />
<br />
If you are using Manual Parry (select in the Settings menu), you need to select the appropriate block. If your opponent is making an overhead attack, you must select an overhead block. Select blocks by moving the mouse while holding the Parry button down, just as you would for an attack. <br />
<br />
If you successfully block an attack or damage your opponent the AI will be temporarily "flat-footed". They can still attack and defend, but they will not chase you if you turn to run. The effect lasts only a second or two, but that can sometimes be enough time to give you a head start.<br />
<br />
The trick to a successful combat is timing. You need to try to anticipate your opponent's attacks, and then launch counter-attacks before he has a chance to parry.<br />
<br />
AI will usually try to flee if they are badly wounded.<br />
<br />
{{update|1.07|Different weapons do different amounts of damage when they hit you. A longsword is one of the most damaging weapons, while short swords do less damage and daggers even less.}}<br />
<br />
'''Note:''' It is possible to hit walls or ceilings instead of your target. Keep track of how much space is around you when choosing your swing.<br />
<br />
== Missile Combat ==<br />
<br />
Your broadhead arrows cannot penetrate plate armour, and will do less damage if they hit chain or leather armour. The best result is to hit unarmoured flesh. A single arrow to the head will kill a relaxed guard. Alert guards are assumed to be taking measures to minimize the damage from incoming arrows. <br />
<br />
If you are hit while trying to fire an arrow, your attack will be canceled.<br />
<br />
AI will switch to missile combat if they can see you but cannot reach you. If they don't have a missile weapon, they will become angry and start throwing things at you.<br />
<br />
AI archers will fire arrows at you. Some AI are better shots than others. When you get within melee range of an archer, they will pull out their melee weapon to fight with it instead.<br />
<br />
<br />
----<br />
<br />
= AI =<br />
<br />
== AI Senses ==<br />
<br />
AI can see you if your lightgem is not totally black. The longer you're in their field of vision and the closer you are, the more likely they are to notice you and come and investigate. <br />
<br />
Some AI have hoods, eyepatches, or other things that block their field of vision. These can be exploited by clever thieves. {{red| (1.01) }}<br />
<br />
AI can hear your footsteps, and noise that you make from banging into things or dropping objects. {{update|2.0|They can also hear the sound of falling bodies, so be careful where you knock out opponents.}}<br />
<br />
AI can also feel you if you bump into them, or vice versa.<br />
<br />
TDM AI are fairly intelligent about searching. They can identify good hiding spots and will check them out first.<br />
<br />
When AI become alert, their senses get slightly better. A shadow that is sufficient to hide you from a relaxed AI might not be enough for an AI that is alert and actively looking for trouble.<br />
<br />
AI do not forget about you after giving up the search. They remain in an alert state, with heightened senses and their weapons out.<br />
<br />
== AI Behaviour ==<br />
<br />
AI don't necessarily patrol the exact same route every time, or stand for the same amount of time at every spot they go to. Mappers can add as much randomness to the AI as they wish.<br />
<br />
AI need to see evidence in order to react to it. If a bloodstain or missing loot is in shadow, an AI won't notice it.<br />
<br />
AI can react to missing objects, but only if mappers set the objects as noteworthy.<br />
<br />
AI become suspicious if they find a weapon lying around. Finding blood or a body will cause them to go fully alert.<br />
<br />
AI can hear broadhead arrow impacts. If you shoot an arrow and it hits a wall nearby, the AI will notice. AI will also react to water arrows if you fire them too close (or if you hit an AI with one). {{update|1.07|AI will notice and be suspicious of arrows that are left sticking into things.}}<br />
<br />
<br />
AI do not yet notice moss arrow impacts, broken objects or moss patches. These things will likely cause minor alerts in the future.<br />
<br />
{{update|1.06| AI can notice and comment on lights that have been put out, and may relight ones that the mapper has set as important. AI will start to become suspicious of an intruder if this happens frequently.}}<br />
<br />
{{update|1.07| AI that see a rope from a rope arrow will walk over to investigate, and will treat it as evidence of an intruder.}}<br />
<br />
{{update|1.07| AI can notice important doors (set by mapper) that have been left open, and will start to become suspicious.}}<br />
<br />
{{red| AI will turn towards doors that they see opening, and may get suspicious if they don't see anyone responsible. (2.00) }} <br />
<br />
AI will look for 2s at a door opening in their FOV, unless they’re in combat mode.<br />
<br />
An AI will not look at an open door if they were the last one to handle it.<br />
<br />
===For an unsuspicious door:===<br />
<br />
The door starts to open, stims the AI, but the AI ignores it, because the door is < 20% open. One second later, when the next stim hits him, if the door is < 20% open, he'll continue to ignore it. Otherwise, he'll look at the door for 2 seconds. Non-suspicious doors can be cracked open indefinitely w/o nearby AI noticing.<br />
<br />
===For a suspicious door:===<br />
<br />
<br />
Allow player to crack open (< 20%) a suspicious door to peek out w/o grabbing the attention of a nearby AI. After 5s, the AI will notice the cracked open door.<br />
<br />
When the door is >20%, it stims the AI, and the AI immediately starts to look at it for 2 seconds. 1 to 1.5 seconds after the stim, while looking at the door, if no friendlies are apparent, the AI will bark and walk toward the door and begin his search.}}<br />
<br />
<br />
<br />
<br />
[[Category:Gameplay]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=The_Dark_Mod_Gameplay&diff=17647The Dark Mod Gameplay2014-03-02T10:30:50Z<p>Sparhawk: </p>
<hr />
<div>{{red|Updates for versions after v1.00 are listed in red, so players can quickly see changes to gameplay since their last read.}}<br />
<br />
Since The Dark Mod is designed to simulate the stealth gameplay of Thief, many things will be very familiar to Thief players. There are some features that work differently, however, and some things that are entirely new to TDM. <br />
<br />
If you have never played Stealth Games before, start with the [[Basics of Stealth Gaming]].<br />
<br />
Veteran stealth gamers can read the various sections below for more detail:<br />
<br />
= The Game Menus =<br />
<br />
Your experience with The Dark Mod will start with the Main Menu, where you may wish to adjust some settings before starting your first mission. If you already have saved games from a currently installed mission, you can load them from the Load/Save menu. <br />
<br />
{{red|Note: While missions remain compatible with all updates, your saved games will not necessarily work after updating, due to code changes.}}<br />
<br />
== Starting a Mission ==<br />
[[Image:new_mission.jpg|thumb|The New Mission menu.]]<br />
<br />
# Select ''New Mission'' from the Main Menu.<br />
# Click "Download" to see a list of missions available to download. You can even read details and see screenshots from the mission before downloading it. {{red|(1.04)}}<br />
# Select a Mission from the Available Mission list on the right (start with the Training Mission if this is your first time) and click ''Install Mission''.<br />
# TDM will install the mission and restart. Select ''New Mission'' again, and click ''Start Mission'' <br />
# You will see a briefing that introduces the mission. Click ''Objectives'' to proceed.<br />
# Read your objectives, and choose your Difficulty Level. Then select ''Buy Equipment'' (or ''Start Mission'' in some missions).<br />
# After purchasing desired equipment, hit ''Start Mission''. (The option to ''Drop'' starting items is available, but use with caution...dropping some items may make a mission impossible to complete)<br />
# The Mission Loading screen should appear. Be patient...loading a mission for the first time can take several minutes.<br />
<br />
To call the Main Menu during the game, press {{ESC}}) .<br />
<br />
See [[Installing and Running Fan Missions]] for more information.<br />
<br />
== Changing Settings ==<br />
<br />
# Select ''Settings'' from the Main Menu<br />
# Select the type of setting you wish to adjust: ''Audio'', ''Video'', ''Controls'', or ''Gameplay''<br />
# The controls are set to defaults familiar to ''Thief'' players, however there are new keys/features that are worth reviewing.<br />
#There are difficulty settings for many things, including lockpicking and {{red| combat. (1.01)}} <br />
# New graphic settings have been added for better graphic quality and bloom. {{red|(1.03)}}<br />
#{{red|A new "AI Vision" option has been added. This controls how quickly AI realize you are an enemy when they spot you. (2.0)}}<br />
<br />
== Objectives ==<br />
<br />
When you call the Main Menu during a mission (by hitting {{ESC}}), you will see an option for "Objectives". This is where you can check your progress.<br />
<br />
Your objectives are also displayed after the Mission Briefing when you first start a mission.<br />
<br />
You can also check your Objectives without going to the menus. Hitting {{key|O}} will bring up your objectives on screen. You can use the mouse wheel to scroll up and down. Note that this method ''does not pause the game''. {{red| (1.01)}}<br />
<br />
When you complete an objective, a chime will sound and “Objective Completed” will be displayed at the top of the screen. <br />
<br />
When you have completed all objectives, the map will close and a “Mission Succeeded” screen will appear. Likewise, if you fail an objective or are killed, a “Failed Mission” screen will appear. You can restart the map by selecting the "Restart" option or via the Main Menu.<br />
<br />
<br />
----<br />
<br />
= HUD Display =<br />
<br />
[[Image:hud.jpg|thumb|The Game Screen indicators.]]<br />
<br />
1. WEAPON ICON: An icon of your currently selected weapon is displayed in the bottom left corner of the screen.<br />
<br />
2. BREATH INDICATOR: When you are underwater a small blue bar will appear above the lightgem. This bar measures how much air you have left. When the blue bar runs out, you start to take damage. Surfacing or using a Breath Potion will restore your air bar. <br />
<br />
3. LIGHTGEM: The lightgem at the bottom of the screen indicates how easy you are to see. This is primarily due to how much light is hitting you, but also includes things like whether you are crouched, moving, or have a weapon drawn. {{red|Being under water also reduces your lightgem. (1.03)}}<br />
<br />
The wings on either side of the gem are a crouch indicator. When you are crouched, the wings 'crouch' down as well. {{red| (1.01) }}<br />
<br />
4. HEALTH INDICATOR: When you are injured, a small red healthbar appears below the lightgem. It will remain visible until you are returned to full health.<br />
<br />
5. INVENTORY ICON: Your currently selected inventory object (or your loot total) is displayed as an icon in the bottom right.<br />
<br />
== Weapons ==<br />
<br />
Weapon hotkeys were changed at the last minute, so this list may need modifying:<br />
* {{key|`}} Put away weapons<br />
* {{key|1}} Blackjack<br />
* {{key|2}} Short Sword<br />
[[Image:arrows.jpg|thumb|A selection of arrows you can choose from.]]<br />
* {{key|3}} Broadheads<br />
* {{key|4}} [[Water Arrows]]<br />
* {{key|5}} [[Fire Arrows]]<br />
* {{key|6}} [[Rope Arrows]] <br />
* {{key|7}} [[Gas Arrows]] <br />
* {{key|8}} [[Noise Arrows]]<br />
* {{key|9}} [[Moss Arrows]]<br />
* {{key|0}} [[Vine Arrows]] {{red| (1.07)}}<br />
<br />
''(note that there has been a report that linux users cannot use the {{key|`}} as it is mapped to the console. Linux users will need to select a different key for 'Put away weapons'.)''<br />
<br />
== Inventory Objects ==<br />
Cycle through your inventory using the Inventory Prev/Next keys (default: {{key|[}} or {{key|TAB}} for next item and {{key|]}} for prev item). Inventory objects are stored in groups, so all keys will be stored together, all readables, etc. You can cycle through groups with the Prev/Next Group keys.<br />
<br />
To ‘use’ an inventory object, select it and then hit the Use key (default: {{key|U}}). This will drink potions, throw mines, activate the spyglass, etc. To "use" objects on other objects (like using a key on a door), select the object in inventory, highlight the thing you want to use it on, and hit Use. <br />
<br />
You can drop inventory items by hitting the Drop key (default: {{key|R}}) twice. See the section "Holding Junk Objects" for more information. Note that mappers may designate some important inventory items as undroppable.<br />
<br />
You can clear the inventory selection by hitting the {{key| ← &nbsp; &nbsp; &nbsp;}} (backspace) key.<br />
<br />
To set hotkeys for your inventory items, please see [[Custom Settings for Players]].<br />
<br />
=== Inventory Object: Flashbomb === <br />
[[Image:equipment.jpg|thumb|The tools of a professional burglar.]]<br />
Activate a flashbomb by selecting it in inventory and hitting Use. Flashbombs detonate on impact. A short tap will cause it to fall and go off at your feet where it won't blind you. Holding down the Use key will throw the flashbomb farther away. If you use the Drop key to put the flashbomb down, it is not activated at all.<br />
<br />
An AI must be looking at the flashbomb to be blinded. Don't look at the point of impact or you'll be blinded too.<br />
<br />
AI are only blinded for a few seconds, and they are alerted by the flash, so this tool is most useful for getting away when you've been spotted, or stunning an enemy before an attack.<br />
<br />
Flashbombs have no effect on the undead.<br />
<br />
=== Inventory Object: Holy Water ===<br />
<br />
Select your holy water in inventory and hit the Use key. This puts holy water into your water arrows, making them lethal to undead. The effect only lasts 30 seconds, so use it wisely.<br />
<br />
=== Inventory Objects: Keys === <br />
Some doors or chests require keys to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
You can also assign a key to ''Cycle Keys'' to quickly cycle through all keys in your inventory. This is a very useful way to get to your keys quickly when you have a lot of other items in your inventory.<br />
<br />
=== Inventory Objects: Lockpicks === <br />
See [[#Lockpicking|Lockpicking]] for more information on lockpicks.<br />
<br />
=== Inventory Objects: Maps and Readables === <br />
<br />
In The Dark Mod, both maps and most readables (books, scrolls, etc) are inventory items. To read them, you scroll to the object in your inventory and then hit the Use key. The map or readable will be displayed on screen. Note that '''this does not pause the game'''. Unlike Thief, events continue to unfold around you, and you can be attacked while reading if not careful. You can see your environment around the edges of the map/readable, but the best suggestion is to find a safe place to read. With multi-page readables (distinguishable by folded corners on the page), use the next/prev inventory or next/prev weapon keys to scroll through pages. Hitting Use or Attack will put the readable away.<br />
<br />
The Map key (default: {{key|M}}) will also automatically bring up your map, if you have one. You can also define a readables key (default: not mapped) to cycle through any readables you have.<br />
<br />
=== Inventory Object: Mines === <br />
<br />
Place a mine by selecting it in inventory and hitting Use. A short tap will drop the mine at your feet. Holding down Use will throw the mine farther away. After a few seconds, the mine is armed and {{red| starts making a distinct ticking sound (1.07) }}. Once you hear the ticking, it will go off if stepped on. <br />
<br />
{{red| Map authors can place a mine and arm it at mission start. It behaves the same as any mine you've thrown: it will explode on contact, and it can be disarmed. So don't assume that any mine you come across is safe to pick up. Listen for the tell-tale armed ticking sound. (1.07) }}<br />
<br />
If you use the Drop key to put the mine down, it is not armed.<br />
<br />
Note that you can set armed mines off by shooting them with an arrow.<br />
<br />
You can disarm an armed mine by using a lockpick on it, the same as you would on a locked door. {{red| (1.07) }} Armed mines give off a distinct ticking sound, which stops when the mine is disarmed. After disarming a mine, you can frob it to put it back into your inventory.<br />
<br />
=== Inventory Object: Player Lantern === <br />
<br />
Light is usually the bane of thieves everywhere, but there are times when you need just a little to make your way around. To this end, some thieves carry a covered lantern with a hood that can be closed to block out the light. To use the lantern, select it in inventory and hit Use. This will lift the cover if the lantern is currently off, or close the cover if it is currently lit. There is also a hotkey for using the lantern; by default this is {{key|L}}. This lantern is clipped to your belt so your hands are free, and it can even be used underwater for short periods.<br />
<br />
Obviously using the lantern makes you clearly visible to any nearby opponents.<br />
<br />
=== Inventory Object: Potions ===<br />
<br />
Potions are used by selecting them in inventory and hitting Use. Healing potions will restore hit points (the effect is somewhat gradual). Breath potions increase the player's breath meter, allowing them to stay underwater longer.<br />
<br />
=== Inventory Object: Spyglass === <br />
<br />
A good Thief likes to scout ahead. To use the spyglass, select it in inventory and hit Use. Or use {{key|G}} as a shortcut. You can use the next/prev weapon keys to zoom in and out. You cannot use weapons or frob objects while using the spyglass.<br />
<br />
= Movement =<br />
<br />
Movement in The Dark Mod is not that different than Thief. You can run, walk, or creep, as well as do any of the three while crouching. The faster you move, the more noise you make.<br />
<br />
== Climbing ==<br />
<br />
In addition to ladders and ropes, many missions allow you to climb vines, pipes and chains.<br />
<br />
Move or jump onto a ladder or vines to "attach" to them. Moving "forward" will move in the direction of your view, be it up, down or to the side. "Back" will reverse, and you may strafe to the side. Move away or jump off to detach.<br />
<br />
Holding crouch will let you slide down a rope or ladder. Release to stop sliding, or hold it down to slide all the way to the bottom.<br />
<br />
=== Swinging on Ropes ===<br />
<br />
Tapping the "attack" key while on a rope or chain will cause the rope to swing forward. You can actually gain more momentum by continuing to tap it every time you start swinging forward (think of it like swinging your legs forward on a swing). This can allow you to jump off the rope and grab ledges that are otherwise too far away.<br />
<br />
Note that the further down the rope you are, the more distance you can travel when swinging (just like a real rope).<br />
<br />
== Mantling ==<br />
There are two different ways to mantle (pull yourself up onto ledges) in The Dark Mod. One is by holding down the Jump key, which Thief players will be familiar with. There is also a key specifically for mantling (default: {{key|<br />
C}}), so that failing to mantle will not result in jumping and making noise. Ideally there should be no difference in these methods, but occasionally one method will work when the other will not.<br />
Mantling is affected by where you are looking, so a successful mantle is more likely if you are looking directly at the edge of the object you wish to climb. To climb on a chair, look down at the seat then press the mantle control. By this means you can clamber over relatively low but awkward obstructions and even select one ledge above/below another.<br />
<br />
You cannot mantle while carrying a junk object or body.<br />
<br />
= Interacting With Your Environment =<br />
<br />
The Dark Mod gives you far more flexibility than previous Thief games when it comes to interacting with things.<br />
<br />
== Manipulating Held Objects ==<br />
This is one area that works quite differently from the Thief series. "Held Objects"(anything that you can carry that doesn’t go into inventory, like chairs, candles, or bodies) are held out in front of you when frobbed. Unlike in Thief, they take up physical space, and can be used to push or manipulate other objects. They can also bump into other objects, making noise (or being knocked out of your hands), so be careful.<br />
<br />
To grab a held object, frob it as normal. The object will stop highlighting, and any weapons you have selected will lower. At this point, you can use the next/prev weapon keys (default: mousewheel up/down) to move the object closer/further away from you, and moving your mouse around will move the object (it stays basically in the center of your screen). <br />
<br />
The heavier the object, the slower it moves, so you may notice a ‘lag’ if you turn quickly with heavy objects. It can take a while to get used to this.<br />
<br />
To drop an object, hit the Drop key (default: {{key|R}}). By crouching and angling your view down gently, you'll find that you can easily set down objects without making noise. You can also throw a held object by hitting the Attack key. Tapping the Attack key throws the object a short distance; holding the Attack key down and releasing it will throw it further.<br />
<br />
To rotate a held object, hold down the {{key|Z}} key or middle mouse button, and move your mouse. <br />
(By default, horizontal movement of the mouse yaws the object around the vertical axis, and vertical movement pitches the object up and down. Holding down the Run key makes horizontal mouse movement roll the object around the forward axis.) This can be useful for replacing objects that have been knocked over, or for placing moveable objects in creative ways (like putting a plank over a gap, or stacking chairs).<br />
It is possible to “drop” inventory items into your hands, where they can be manipulated as if they were held objects. Select the object in your inventory, and hit the Drop key {{key|R}}. The object will appear in front of you like a held object, and you can rotate it, set it down, etc. To put it back into your inventory, you must "use" the item again ({{key|U}}) or scroll to the next inventory item ({{key|TAB}} or {{key|[}}/{{key|]}}).<br />
[[Image:candles6.jpg|thumb|[http://www.youtube.com/watch?v=922ArtrKgC4 Click to see TDM candles in action.] ]]<br />
AI will hear junk objects that are dropped or banged around. It takes some skill to pick up objects on a crowded table without knocking them into each other. Remember than an object moves to the center of the screen when you pick it up. If you are looking slightly above the object, it will jump up to center screen (usually a good thing). If you're looking slightly below the object, it will jump down, banging whatever surface it rests on (a bad thing). A little practice may be required to smoothly and quietly sort through objects.<br />
<br />
Some objects that are too heavy to lift may still be movable (like large crates). Walking or running into such objects may (mapper's choice) push them along the ground.<br />
<br />
=== Held Objects: Candles ===<br />
<br />
Lit candles can be frobbed and carried around to light your way (obviously you will be easily spotted while carrying a lit candle). They can also be used to light flammable objects like other candles or torches. Click the caption on the right for a demonstration.<br />
<br />
Candles can be extinguished by water, or you can pinch them out by picking them up and clicking the Use key. (Note that this method can also be used on some movable lanterns). {{red|Candles will usually go out after a few seconds if they get knocked over. (1.06) }}<br />
<br />
Be aware that multiple light sources can cause a significant drain on your framerate. If you go around a room lighting six or seven new candles, don't be surprised if your framerate drops significantly.<br />
<br />
=== Held Objects: Bodies ===<br />
<br />
Bodies work differently than most other objects. There are two ways to deal with dead or unconscious bodies in The Dark Mod. You can both drag them and carry them.<br />
<br />
To drag a body, you must ‘frob’ it (which probably requires crouching), and then move your mouse around. The body will drag along with you until you frob it again or the body gets stuck on something. <br />
<br />
This is not the most graceful way of moving bodies and is not recommended for long distances. Bodies can catch on things and get pulled out of your hands. It can be useful for quickly shifting a body into a shadow, however. You can even move individual limbs to put a flailing arm back into a shadow.<br />
<br />
You can also carry a body over your shoulder. While a body is being dragged, hitting the Use button will lift it up over your shoulder. While carrying a body you move more slowly and cannot use weapons or inventory objects (though you can open doors). When you are ready to drop the body, hit Use again. If there is not enough room, you will hear a grunt and nothing will happen. Back up a bit and try again. When you drop a body, it will be the opposite orientation from the way you picked it up (if a body is face-up when you lift it, it will be face-down when you drop it). This allows you to easily search a body for keys or other objects.<br />
<br />
=== Held Objects: Food ===<br />
<br />
Some food can be eaten. When holding a piece of food (such as an apple) hit the "use" key. If the food is edible, you will 'eat' it. Discard any left-overs. Some of the healthy food will heal you by 1 HP.<br />
<br />
== Doors == <br />
You can interrupt a door opening or closing by frobbing it again. Frobbing a moving door stops it, allowing you to open a door just a crack to peer beyond.<br />
<br />
You can lean into a door (use the lean left/right keys) to press your ear up against it and hear what's on the other side. Note that while you're concentrating on what's beyond the door you'll be less able to hear the sounds in the room you're currently in.<br />
<br />
Some doors or chests are locked and require keys (or lockpicks, see below) to open. To open a locked door, select the appropriate key by scrolling to it in your inventory and hit the Use key (or the Frob key if you wish) while highlighting the door. Note that certain types of door locks (like padlocks) might have to be frobbed separately.<br />
<br />
Depending on how important a specific door is, the mapper can choose to set flags on it. Check out the "AI Behaviour" section, for details on how the AI responds in such cases.<br />
<br />
== Lockpicking ==<br />
You will definitely want to practice lockpicking in the Training Mission before trying a real map. Just reading the instructions is probably not enough to get the hang of it. <br />
<br />
There are two types of lockpicks, 'triangle' and 'snake'. To begin, you must have the correct lockpick selected in inventory. If you do not, you will see a red flash behind the lockpick icon when you frob the locked door. To pick a lock, move close enough to highlight the door and hold the Use key. You will start to hear a sequence of clicks, and see the door handle (or lock pin) jiggle in sync.<br />
<br />
The clicks are a random pattern. At the end of the pattern is a brief period of silence, then the pattern will begin again. To be successful you must hit the Attack key (or release the Use key if you prefer) at the start of that silence. If you hit the Attack key at the wrong time there is a dull 'fail' sound and the pattern begins again. Your goal is to learn the sequence of clicks so that you can anticipate when it will end. This requires concentration.<br />
<br />
Some locks are more difficult than others and have multiple pins (which may require switching lockpicks). You can make lockpicking harder or easier in the Settings Menu, by adjusting how much silence there is between each pattern (the more silence, the easier it is to react in time). Setting Lockpicking to "Auto" will make locks open automatically after the pattern repeats 3 times.<br />
<br />
{{red| Armed mines can be disarmed by lockpicking them. Afterward, they can be frobbed and put into inventory. Either lockpick type can be used. (1.07) }}<br />
<br />
== Chests ==<br />
It can sometimes be a little awkward frobbing items inside deep chests. Leaning forward (or even sideways) will usually help.<br />
<br />
If you get too close to a chest, you can sometimes get in the way of the lid opening or closing. Back up a little if the lid is not moving as expected.<br />
<br />
<br />
----<br />
<br />
= Combat =<br />
<br />
There are a number of ways that combat is different in The Dark Mod.<br />
<br />
Keep in mind that you are not a warrior. Guards are generally better trained than you are, and while you might win a few one-on-one battles, you will almost certainly die if facing two guards at once.<br />
<br />
== Blackjacking ==<br />
<br />
Your blackjack is more effective if your opponent is relaxed and not expecting trouble.<br />
<br />
You must hit an AI on the head to knock them out. Hitting an AI anywhere else will simply alert them. For best results, don't get too close to the AI, or you may hit them with your elbow instead of your blackjack.<br />
<br />
'''You can successfully knock out:'''<br />
<br />
'''1. Unarmed civilian AI from any direction, any time.'''<br />
<br />
'''2. Bare-headed guards from any direction when relaxed, or from behind when their weapon is out.'''<br />
<br />
'''3. Helmeted guards from behind when relaxed (helmeted guards cannot be knocked out when their weapon is out).'''<br />
<br />
All armed AI are harder to knock out when the AI has drawn a weapon, because they are assumed to be ready for you. Either they have searched for you or been warned by a friend that something is wrong.<br />
<br />
The blackjack does a small amount of damage, so you could theoretically beat someone to death with it, if you have a lot of time on your hands.<br />
<br />
Undead and some animals cannot be knocked out with the blackjack.<br />
<br />
{{update|1.01|Certain heavy-duty helmets make their wearer immune to the blackjack. These can be identified by a face grill and a low back, which protects the base of the neck.}}<br />
<br />
'''Note:''' the blackjack makes an overhead swing, so if there is something low in the way (like a doorframe) you might hit it instead of your target, especially if you are looking upwards.<br />
<br />
== Melee Combat ==<br />
[[image:combat1.jpg|thumb|A guard winds up for an overhead attack]]<br />
There is a combat arena in the Training Map for practicing combat. After a few rounds you will have a much better feel for how it works.<br />
<br />
{{update|1.01|Different AI have different skill levels (novice, trained, skilled) when it comes to combat. An armed commoner will not fight as well as an elite guard. You can also change the overall combat difficulty in the Settings menu.}}<br />
<br />
You can use your shortsword to attack an enemy, as well as block enemy weapons. Attacking a relaxed enemy (ie, backstabbing) does extra damage. <br />
To attack, hit the Attack key. This will make a left-to-right, slashing attack. If you move the mouse while clicking the Attack key, you can select other kinds of attacks. Moving the mouse down will cause an overhead swing. Moving the mouse up will cause a thrust attack. Moving the mouse left or right will cause a right-to-left or left-to-right slash, respectively. <br />
<br />
AI can parry your swings (unless they are using a dagger), and they will do this more easily if you keep using the same kind of attack, so you will want to mix it up. <br />
<br />
The amount of damage you do varies depending on where you hit. Hitting an AI in the head will do more damage than hitting their arm or leg. Armour also plays a factor. Your sword can't penetrate plate armour, and even chainmail or leather armour will provide the AI some protection.<br />
<br />
To block an enemy strike, hold the Parry key. You must hit the parry key ''after'' the AI starts winding up for their attack. Too early and the AI will see the block and choose a different attack. Obviously, you must also be facing the AI...holding up a block while looking off to the side won't help.<br />
<br />
If you are using Manual Parry (select in the Settings menu), you need to select the appropriate block. If your opponent is making an overhead attack, you must select an overhead block. Select blocks by moving the mouse while holding the Parry button down, just as you would for an attack. <br />
<br />
If you successfully block an attack or damage your opponent the AI will be temporarily "flat-footed". They can still attack and defend, but they will not chase you if you turn to run. The effect lasts only a second or two, but that can sometimes be enough time to give you a head start.<br />
<br />
The trick to a successful combat is timing. You need to try to anticipate your opponent's attacks, and then launch counter-attacks before he has a chance to parry.<br />
<br />
AI will usually try to flee if they are badly wounded.<br />
<br />
{{update|1.07|Different weapons do different amounts of damage when they hit you. A longsword is one of the most damaging weapons, while short swords do less damage and daggers even less.}}<br />
<br />
'''Note:''' It is possible to hit walls or ceilings instead of your target. Keep track of how much space is around you when choosing your swing.<br />
<br />
== Missile Combat ==<br />
<br />
Your broadhead arrows cannot penetrate plate armour, and will do less damage if they hit chain or leather armour. The best result is to hit unarmoured flesh. A single arrow to the head will kill a relaxed guard. Alert guards are assumed to be taking measures to minimize the damage from incoming arrows. <br />
<br />
If you are hit while trying to fire an arrow, your attack will be canceled.<br />
<br />
AI will switch to missile combat if they can see you but cannot reach you. If they don't have a missile weapon, they will become angry and start throwing things at you.<br />
<br />
AI archers will fire arrows at you. Some AI are better shots than others. When you get within melee range of an archer, they will pull out their melee weapon to fight with it instead.<br />
<br />
<br />
----<br />
<br />
= AI =<br />
<br />
== AI Senses ==<br />
<br />
AI can see you if your lightgem is not totally black. The longer you're in their field of vision and the closer you are, the more likely they are to notice you and come and investigate. <br />
<br />
Some AI have hoods, eyepatches, or other things that block their field of vision. These can be exploited by clever thieves. {{red| (1.01) }}<br />
<br />
AI can hear your footsteps, and noise that you make from banging into things or dropping objects. {{update|2.0|They can also hear the sound of falling bodies, so be careful where you knock out opponents.}}<br />
<br />
AI can also feel you if you bump into them, or vice versa.<br />
<br />
TDM AI are fairly intelligent about searching. They can identify good hiding spots and will check them out first.<br />
<br />
When AI become alert, their senses get slightly better. A shadow that is sufficient to hide you from a relaxed AI might not be enough for an AI that is alert and actively looking for trouble.<br />
<br />
AI do not forget about you after giving up the search. They remain in an alert state, with heightened senses and their weapons out.<br />
<br />
== AI Behaviour ==<br />
<br />
AI don't necessarily patrol the exact same route every time, or stand for the same amount of time at every spot they go to. Mappers can add as much randomness to the AI as they wish.<br />
<br />
AI need to see evidence in order to react to it. If a bloodstain or missing loot is in shadow, an AI won't notice it.<br />
<br />
AI can react to missing objects, but only if mappers set the objects as noteworthy.<br />
<br />
AI become suspicious if they find a weapon lying around. Finding blood or a body will cause them to go fully alert.<br />
<br />
AI can hear broadhead arrow impacts. If you shoot an arrow and it hits a wall nearby, the AI will notice. AI will also react to water arrows if you fire them too close (or if you hit an AI with one). {{update|1.07|AI will notice and be suspicious of arrows that are left sticking into things.}}<br />
<br />
<br />
AI do not yet notice moss arrow impacts, broken objects or moss patches. These things will likely cause minor alerts in the future.<br />
<br />
{{update|1.06| AI can notice and comment on lights that have been put out, and may relight ones that the mapper has set as important. AI will start to become suspicious of an intruder if this happens frequently.}}<br />
<br />
{{update|1.07| AI that see a rope from a rope arrow will walk over to investigate, and will treat it as evidence of an intruder.}}<br />
<br />
{{update|1.07| AI can notice important doors (set by mapper) that have been left open, and will start to become suspicious.}}<br />
<br />
{{red| AI will turn towards doors that they see opening, and may get suspicious if they don't see anyone responsible. (2.00) }} <br />
<br />
AI will look for 2s at a door opening in their FOV, unless they’re in combat mode.<br />
<br />
An AI will not look at an open door if they were the last one to handle it.<br />
<br />
===For an unsuspicious door:===<br />
<br />
The door starts to open, stims the AI, but the AI ignores it, because the door is < 20% open. One second later, when the next stim hits him, if the door is < 20% open, he'll continue to ignore it. Otherwise, he'll look at the door for 2 seconds. Non-suspicious doors can be cracked open indefinitely w/o nearby AI noticing.<br />
<br />
===For a suspicious door:===<br />
<br />
<br />
Allow player to crack open (< 20%) a suspicious door to peek out w/o grabbing the attention of a nearby AI. After 5s, the AI will notice the cracked open door.<br />
<br />
When the door is >20%, it stims the AI, and the AI immediately starts to look at it for 2 seconds. 1 to 1.5 seconds after the stim, while looking at the door, if no friendlies are apparent, the AI will bark and walk toward the door and begin his search.}}<br />
<br />
<br />
<br />
<br />
[[Category:Gameplay]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Thief%27s_Den&diff=5499Thief's Den2008-01-09T09:31:20Z<p>Sparhawk: /* FAQ */</p>
<hr />
<div>[[Image:Thiefsden.jpg|right]] Welcome to this short mission demo of [[The Dark Mod]]. Thief's Den is just a few rooms but it is a complete, fully playable mission, and includes a good selection of the main Dark Mod features. Keep in mind that The Dark Mod is still a work in progress and this is reflected in the demo. Voices are temporary placeholders, for example, and AI behaviour is not yet fully developed. You will certainly find bugs and glitches but we hope that doesn't spoil your enjoyment too much.<br />
<br />
Any flaws or failings in this demo do not necessarily indicate limitations in The Dark Mod's potential but just this particular demo--which was originally begun as a very rough accompaniment to a mission development tutorial. It was never intended for release as a playable mission but was modified into a workable game so everyone could see the current state of progress and have some fun.<br />
<br />
{{Important|headline=Important|text=Please take your time to read through this page while downloading the package. It will be saving you and us a lot of time.}}<br />
<br />
<br />
__TOC__<br />
== Download ==<br />
Choose a download mirror from below. The EXE file just contains a '''self-extracting 7-zip archive''', it's not a full-fledged installer.<br />
* '''7-zip''' (self-extracting EXE, about 210 MB)<br />
** FTP<br />
** Thirdfilms<br />
Note to Linux users: you should be able to extract the contents from the downloaded EXE after installing the package '''p7zip''' - so you don't need Wine to actually run the executable.<br />
<br />
== Installation ==<br />
You'll need the following to play the Thief's Den:<br />
* Windows or Linux<br />
* A working Doom 3 installation (patched to 1.3.1) - detailed instructions on how to setup Doom 3 for TDM on your end can be found in the [[Installation]] article.<br />
<br />
Now proceed with the following steps. This guide assumes that you have Doom 3 installed in C:\games\doom3.<br />
* Download the file and copy the self-extracting EXE into C:\games\doom3. <br />
* Run the thiefs_den.exe to let the extraction routine do its job.<br />
* The extractor will create a '''thiefs_den''' folder at this location: '''C:\games\Doom3\thiefs_den'''.<br />
* In the thiefs_den folder is a file called '''DevIL.dll'''. You MUST copy this into your WINDOWS\system32 folder.<br />
* Now you'll need to create a shortcut to that game:<br />
** Copy the existing Doom 3 shortcut on your desktop to a new one and rename it to "Thief's Den".<br />
** Right-click, open the properties of that shortcut and edit the command line: It should read <br />
C:\games\doom3\DOOM3.exe +set fs_game thiefs_den<br />
<br />
* It's now ready to run but first read the instructions...<br />
<br />
== Instructions ==<br />
<br />
There will be a detailed information file in the archive. Look in your '''C:\games\Doom3\thiefs_den''' folder for README1ST.TXT or similar or pdf file. Read through it before running the game.<br />
<br />
Then Run your "Thief's Den" desktop shortcut. Enjoy it.<br />
<br />
== Feedback ==<br />
Of course we're anxious to hear how you experienced our Thief's Den Pre-Beta Release. There is a public feedback & discussion thread open in our forums: [http://modetwo.net/darkmod/index.php?showtopic=7082 Pre-Beta Discussion]. Please drop by and let us know what you think.<br />
{{Important|headline=That being said,|text=don't rush into the forums and spend hours of writing up detailed bug lists of what's working and what you think needs fixing. It's very likely that we are already aware of these problems (yes, we're playing our game ourselves). We have our own, private bugtracker full of issues to be solved.}}<br />
<br />
Crashes and installation help requests are of course something different, feel free to contact us, but be sure to check the FAQ on this page first.<br />
<br />
== FAQ ==<br />
; Can I use the Demo version of Doom 3?<br />
: Almost certainly not.<br />
<br />
; How can I check whether my Doom 3 is correctly patched?<br />
: Open Doom 3 and hit Ctrl-Alt-~ (tilde) to open the console. You'll see the version printed in the lower left corner of the console. It should read '''1.3.1.1304'''. If your version is ending on 1302, you've got the wrong patch installed.<br />
<br />
; Where can I get the right patch?<br />
: We have the patch hosted on our FTP. Get over to the [[Installation]] page to find a link to it.<br />
<br />
; Whats that issue with the 1.3.1 patch?<br />
: When the 1.3.1 patch was released by Id, they released it a bit to early. Some downloadsites picked it up quite fast though and started to distribute it. The problem is, that Id replaced that patch with a different one, and, probably thinking that it hasn't spread yet, didn't bother to change the version number. However you can still find 1.3.1 patches which are the older version and will not work with the mod. That's why it is important to check the version number in the console to make sure that the right 1.3.1 patch is installed if the mod doesn't work. The link provided here on our own page points to the correct patch, so if you downloaded it from here you don't need to worry about it.<br />
<br />
; Does it run in Linux?<br />
: Yes, Linux is supported. You'll need to extract the contents from the EXE file above manually, though.<br />
<br />
; Does it run in MacOS?<br />
: No. Or at least not yet. The Doom 3 game itself is supporting MacOS, but The Dark Mod is not (mainly because we don't have anyone developing on Macs).<br />
<br />
== Known Bugs ==<br />
<br />
To be filled in before release.<br />
<br />
[[Category:Installation]]<br />
[[Category:Thief's Den]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=4157Doors2007-10-02T18:56:33Z<p>Sparhawk: /* Adding handles and other items to doors */</p>
<hr />
<div>ATTENTION! The configuration for door spawnargs are no longer valid and need some<br />
modifications, which will be updated shortly. The general setup, described here is<br />
ok, only the setup of the spawnargs has been changed. (sparhawk) <br />
<br />
<br />
''Written by Fidcal''<br />
<br />
==Introduction==<br />
<br />
This tutorial explains how to put doors into your Dark Mod map using Dark Radiant and adjust them and their properties.<br />
<br />
Quick way for the moderately knowledgeable to skip the detail and just get an ordinary unlocked door in your map as fast as possible you need only...<br />
<br />
* Create a model door<br />
* Change it from func_static to atdm:mover_door<br />
* Create a door handle (must be created ''after'' the door!)<br />
* Change it from func_static to atdm:mover_door_handle<br />
* Add the ''door_body'' property to the handle and give it the name of the door<br />
* To open clockwise change the ''rotate'' property from 0 90 0 to 0 -90 0.<br />
<br />
<br />
The rest of this tutorial assumes very little prior knowledge so is suitable for beginners even without Doom editing experience. You need to know:<br />
<br />
<br />
* 'entity inspector' is available from the view menu or shortcut key.<br />
* 'orthoview' means any of the xyz top, side, front, grid views<br />
* Up, down, left, and right in Dark Radiant's ''top'' orthoview are regarded here as the standard map directions of North, South, East, and West where useful for clarity.<br />
* Where the term ''brush'' is used with a door it mostly also applies to a door made up of a group of brushes and/or patches.<br />
* Where the term ''door'' is used it often will also apply to any object you wish to rotate when frobbed, for instance an openable window, box lid, or even more exotic objects that the imaginative mapper might conceive like a signal, engine part, toy, or whatever. So long as it needs to turn or slide just a fixed amount when frobbed then return when frobbed again then the following applies.<br />
<br />
<br />
<br />
&nbsp;<br />
==Door types==<br />
<br />
All tangible objects in Dark Mod are ''entities'' having either a pre-made model shape or else brush/patch(es). So there are two ways to create a door in Dark Radiant: as a model door or a textured brush door (or a hybrid of the two.)<br />
<br />
Models are ready made door objects but cannot within Dark Radiant (at the time of writing) be resized, rescaled, cropped or clipped whereas brushes are very flexible in that respect and can be worked into custom shapes for your map, including secret doors that blend into walls and other surfaces.<br />
<br />
Although many models are already assigned to entities in Dark Radiant's right click create entity list, all door models are (at the time of writing) in the create models list (under models/darkmod/architecture/doors) and are automatically assigned to static entities by default. So these are immediately useable as static doors or can be quickly made into functioning doors (see later) by re-parenting them to a functioning door entity.<br />
<br />
Remember also that door functions may be applied to objects other than doors for instance to openable windows, drawbridges, gates, in fact anything that needs a partial rotation or slide when frobbed then return when frobbed again such as a signal device.<br />
<br />
<br />
<br />
&nbsp;<br />
<br />
==Creating a Door==<br />
<br />
Put simply, to make a door you will be creating an 'entity with model' or 'entity with brush' or some variation thereof.<br />
<br />
===Creating a Model Door===<br />
<br />
There are two approaches to making a model door; the first is simpler for a working door; the second if you just want a static door. But both routes can produce a fully working door.<br />
<br />
First approach:<br />
<br />
* Create any temporary brush<br />
* Right click in orthoview and select Create Entity then atdm:mover_door.<br />
* Left lick the model name line in the entity inspector.<br />
* Below it on the Entity Inspector panel you should now see a button 'Choose Model'<br />
* Left click it, select a door model from the darkmod group.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* The temporary brush was deleted.<br />
* You now have a working door with default properties.<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Alternatively you can do it the other way round:<br />
<br />
* Right click in the orthoview, select Create Model then darkmod and select a door.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* Click OK and you have a static door.<br />
* If you want to make it work (openable, frobbable) then...<br />
* Select the entity inspector,<br />
* Select the top classname line so it highlights<br />
* Select the func_static line in the input box + check(tick) button ''below'' the properties window.<br />
* Edit func_static to atdm:mover_door<br />
* Click the check(tick) button<br />
* You now have a working door with default properties<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
===Creating a Textured Brush Door===<br />
<br />
The simplest brush door:<br />
<br />
* Tip : If unsure of size then you might insert a temporary human AI first to get a sense of height.<br />
* Drag out a new brush to the size required, eg, a seven foot high door is 84" x 1.1 = about 90 units in Dark Radiant.<br />
* Give it a door texture from the texture browser (or wall texture for a secret door)<br />
* Right click in orthoview and select Create Entity then atdm:mover_door<br />
* You now have a default door that rotates around its centre.<br />
* To move the rotation point to the door edge and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Multi-brush doors:<br />
<br />
More complex multi-brush doors can be created using the clipper tool, CSG, etc. (not covered in this tutorial) and then assign atdm:mover_door for that whole brush structure. Also you can collect various brushes positioned together in relation to one another as needed, select them all, then assign atdm:mover_door for the group. All the brushes will be children of the atdm:mover_door entity and will rotate and be frobbable, etc. as one unit, as one door. To add further brushes or even model shapes later see the section on ''Adding handles and other items to doors''<br />
<br />
<br />
<br />
&nbsp;<br />
==Customising and Adjusting Door Properties==<br />
<br />
Handles, lockplates, etc. can be added to doors and door properties can be adjusted for rotation, sliding, locking, and more.<br />
<br />
<br />
<br />
===Adding handles and other items to doors===<br />
<br />
You can add handles and other items to doors such that they move correctly with the door whether rotating, sliding, or both and even if the door is not vertical such as a skylight or trapdoor.<br />
<br />
To add a working model door handle (works with both a model door and a brush door):<br />
* Create a door and a handle (the order no longer matters).<br />
* Proceed as for ''Creating a Model Door'' above but instead of the entity ''atdm:mover_door'' use ''atdm:mover_door_handle'' and when you choose a model choose a door handle instead of a door.<br />
* Position it where you wish on your door.<br />
* Note down the generated name for the handle entity, or give a usefull name like MyHandle.<br />
* Select the door the handle should be attached to, add a new property ''door_handle'' and use the name of the handle as it's value.<br />
* Click the check(tick) button<br />
* You now have a working door handle with default properties<br />
<br />
<br />
To add a brush to a brush door:<br />
* Select the new brush ''and'' the brush door all together; ''the entity '''must''' be selected '''last'''.''<br />
* Use Menu > Edit > Reparent primitives. This ensures the parent entity adopts the new item(s).<br />
* If you have trouble selecting them in the orthoview because other brushes, etc. get selected then try in the camera view or as a last resort move them temporarily to an open area (but keep them in the same positions relative to each other.) Use Shift + Left Click on new item(s) then Shift + Left Click on main entity. Once they are all selected use the Menu > Edit > Parent. <br />
<br />
<br />
To add ''model'' static items: knockers, hinges, static handles to a Model Door:<br />
* Select item<br />
* Right click in orthoview and select Create Entity then ''entity func_static''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''bind'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''bind''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
<br />
<br />
<br />
To add ''brush'' static items: knockers, hinges, static handles to a Model Door:<br />
* This method is not ideal but it seems to work OK.<br />
* Select the brush.<br />
* Right click in orthoview and select Create Entity then ''atdm:mover_door_handle''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* This brush turns like a handle. To stop it...<br />
* Adding ''rotate 0 0 0'' or disabling the handle script won't help.<br />
* Add a real working handle (as in the section above ''To add a working model door handle...'' and it must be added LAST.)<br />
* If you don't want too see a real working handle added maybe try another tiny brush with the handle function and hide it inside the door?<br />
<br />
===Locking Doors, Keys and Lockpicks===<br />
<br />
To lock a door check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''locked'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unlocked (default)<br />
1 = locked<br />
<br />
If locked it will require an entity that is associated with it to be able to act as a key to unlock it.<br />
<br />
To make a door ''lockpickable'' check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''pickable'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unpickable<br />
1 = pickable (default)<br />
<br />
If pickable then the door can be opened with a lockpick.<br />
<br />
lock_pins property (WIP - UPDATE LATER) SEE ALSO SOUND SECTION FOR PINS.<br />
<br />
<br />
<br />
<br />
<br />
===Open, Partially Open, or Closed Door at Game Start===<br />
<br />
By default, doors are closed at game start. If you want a door to be already open or partially open then do the following.<br />
<br />
<br />
<br />
Already Open Rotating Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Make sure its ''open'' property is set to 1 as above.<br />
* Right click the entity inspector and select ''add property'' <br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* scroll down, select ''start_rotate'' then click OK.<br />
* This adds it to the property list.<br />
* Now select ''start_rotate'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the angle you want in the same form as described in the ''Rotate Direction and Open Angle'' section. So for example, to have a door that has a fully open default ''rotate'' value of 0 90 0 to start only half open you would give it a ''start_rotate'' value of 0 45 0. <br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
Already Open Sliding Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Right click the entity inspector and select ''add property'' <br />
* Make sure its ''open'' property is set to 1<br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder.<br />
* scroll down, select ''start_position'' then click OK. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* This adds it to the property list.<br />
* Now select ''start_position'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the position you want in the same form as described in the ''Sliding (Translation) Amount and Direction'' section. So for example, to have a door that has a fully open default ''translate'' value of 0 50 0 to start only half open you would give it a ''start_position'' value of 0 25 0.<br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Rotation Centre, Pivot, Hinge point===<br />
<br />
The centre of rotation of a door is at the origin point of its entity and the door rotates with reference to the orientation of that origin point, not the world map. See ''Rotate Direction...'' for more about that. This section only deals with the ''position'' of the rotation centre in the door.<br />
<br />
<br />
Model Door Centre of Rotation:<br><br />
The centre of rotation of a model door cannot be changed within Dark Radiant. Because a model door rotates around the centre 'spine' of its back edge this will cause clipping (penetration into solid) as in this example (where the door is set to open to 89 degrees for clarity):<BR>[[Image:modelClipping.jpg]]<BR> So care is needed with placement. You will not normally position a door right next to a wall as in the example but against a shallow frame so clipping will barely be noticeable but either way it can be fixed. You can correct it by adding a translation (see ''Sliding (Translation) Directions'') value of half the door width in the direction of the door handle. This will gently move the door out as it rotates to clear any solid on that side as in this diagram:<br><br />
[[Image:DoorClip.jpg]]<br><br />
Half a door width will typically be about 2. Any 'attachments' such as door handles will still synchronize with the door movement whether the door is rotating, sliding, or both.<br />
<br />
<br />
Brush Door Centre of Rotation:<br><br />
The centre of rotation of a brush door ''can'' be changed. The default origin point of a brush is at its centre. Therefore a default rotating brush door will rotate around its centre when you first create it. So, mappers will commonly need to move that rotation point to a corner or even to some other offset position for example, for an openable window using the door function.<br />
<br />
Put simply, to move the rotation point of a brush door you need to move the entity origin relative to the brush(es.)<br />
<br />
Moving the entity origin (centre of rotation) relative to a brush door:<br />
<br />
* Select the brush door<br />
* Select Vertices mode (Default shortcut key is V or button on top toolbar 'Select Vertices')<br />
* Drag the door's entity origin to the point where you want the door to rotate. This should be on the corner on the leading edge side (the side to where the door is opening.) to avoid clipping as in this diagram....<br />
[[Image:getCorner.jpg]]<br />
* You should now find that door rotates around that point.<br />
<br />
===Rotate Direction and Open Angle===<br />
<br />
By default, rotating doors open anti-clockwise (viewed from above) by 90 degrees from the start orientation. If you want to change this edit the ''rotate'' property in the entity inspector. Don't confuse this ''rotate'' property with the ''rotation'' property. In the entity inspector remember that to see the inherited rotate property you must check the box 'Show inherited properties'.<br />
<br />
The three values shown in the rotate property are degrees from the closed position around Y Z X ''entity origin axes'' (NOT absolute map axes) and so include any start ''rotation''. So the Z value is the axis vertical to the entity origin. If you tilt a model door over in Dark Radiant then its entity origin tilts too so the Z axis is tilted too (with respect to the world map vertical.) So with a normally opening model door if you lay it flat on its back it will open upwards and not rotate around on the floor. But a brush door must be treated differently...<br />
<br />
If you turn a brush door using the normal Dark Radiant rotate tool or the Transform Dialog (accessed via a shortcut key) then it only turns the brush ''relative'' to the entity. So, because the entity origin is by default aligned with the world map then ''in most cases'' you can regard a brush door as rotating with respect to the world map if you wish. But there will be a problem when you come to rotations that are not around the main Y Z X axes of the map, for instance a drawbridge that lowers down to the south east. You might think you can combine Y Z X values to get the result you want - and this can be done (for south east use 45 45 90) but it is a bit of a kludge and the drawbridge twists eccentrically as it lowers (though it arrives correctly!) So for such cases you need to turn the entity itself so its start position is facing south east. You can then just use 0 0 90 to lower the drawbridge perfectly because its Y axis is now pointing south east. To turn the entity you must type or paste the rotation values in directly because using the Dark Radiant rotation tool or Transform Dialog will only turn the brush not the entity. The values are rather lengthy (south east is 0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1) so probably the easiest way is to create a temporary model door, turn it how you want, then select its rotation property. If you now deselect and re-select your brush door then that property will still be in the entity inspector input box and you need only click the check(tick) box to add it to the brush door. NOTE: ''neither the entity nor the brush will show as turned in Dark Radiant.'' Only the rotation property in the entity inspector will indicate the orientation. Instead of a rotated ''construction'', regard it as a rotation ''instruction'' for when the map is compiled.<br />
<br />
These are the rotate property fields. Remember they are all with reference to the door's entity ''not'' the world map. Since there is no absolute frame of reference I indicate them here as if the entity is aligned with the world map axes...<br />
<br />
* Positive Y = Open clockwise (Dark Radiant grid front view, looking north)<br />
* Negative Y = Open anti-clockwise (Dark Radiant grid front view, looking north)<br />
<br />
* Positive Z = Open anti-clockwise (Dark Radiant grid top view, looking down)<br />
* Negative Z = Open clockwise (Dark Radiant grid top view, looking down)<br />
<br />
* Positive X = Open anti-clockwise (Dark Radiant grid side view, looking west)<br />
* Negative X = Open clockwise (Dark Radiant grid side view, looking west)<br />
<br />
The values are in the range -179 to +180. Positive values give an anti-clockwise opening rotation (looking down from above) and negative values give a clockwise opening rotation. The value 180 is unique in that it continues in an anti-clockwise rotation when closing rather than returning clockwise so might be used if you can think of some object that might need such a motion when frobbed!<br />
<br />
Edit the rotate value by selecting it and using the input box at the bottom and clicking the check(tick) button. That will change the angle the door will open to. Note that the line with the original default of 0 90 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Examples:<br />
* 0 90 0 = Opens anti-clockwise round the entity's 'vertical' to 90 degrees - typical default vertical door.<br />
* 0 0 90 = Lowers a drawbridge from the entity 'vertical' to horizontal.<br />
* 0 0 -45 = Opens clockwise by 45 degrees viewed from the east side. This might suit a skylight in a sloping roof.<br />
<br />
Combinations can be used and also combined with slide motions (see '''Sliding (Translation) Directions''') to produce exotic and useful motions. A door opening against an upward-sloping floor can thus have a ''lifting hinge'' and raise up slightly to clear the floor; a door can rotate towards you and slide back to one side very effectively.<br />
<br />
<br />
<br />
<br />
<br />
===Sliding (Translation) Amount and Direction===<br />
<br />
By default a Dark Mod door will rotate open. For most sliding doors you want to stop them rotating as well as make them slide. You cannot delete (remove) the ''rotate'' property - you have to set the ''rotate'' property to 0 0 0 to stop a door rotating (see ''Rotate Direction and Open Angle''.)<br />
<br />
Now edit the ''translate'' property value by selecting it (remember to have inherited properties box checked) and using the input box at the bottom and clicking the check(tick) button. That will change the distance the door will slide to. Note that the line with the original default of 0 0 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Typically (but not always) you will want your sliding door to slide the width of the door. The three values in the translate property by default are 0 0 0 and are X Y Z ''absolute map'' values (irrespective of door orientation) where...<br />
<br />
<br />
* Positive X = Slide East (Right side of Dark Radiant grid in top view)<br />
* Negative X = Slide West (Left side of Dark Radiant grid in top view)<br />
* Positive Y = Slide North (top of Dark Radiant grid in top view)<br />
* Negative Y = Slide South (bottom of Dark Radiant grid in top view)<br />
* Positive Z = Slide Up (Top of Dark Radiant grid in side views)<br />
* Negative Z = Slide Down (Bottom of Dark Radiant grid in side views)<br />
<br />
So for a 50 unit wide door you want to slide fully to the east you would use 50 0 0 for the translate property values. A 100 unit portcullis sliding vertically up would need 0 0 100 to be fully raised.<br />
<br />
<br />
<br />
===Sounds and Sound Propagation through Doors and Doorways===<br />
<br />
Sound propagation relies on visportals. For details study [[Sound Propagation: Part 1]] and [[Sound Propagation: Part 2]] as well as [[Visportals]] This tutorial will just cover the relevant sound and sound propagation ''properties'' of doors. If you set the ''show inherited properties'' box in the entity inspector you can see them as described here.<br />
<br />
The sound of doors opening and closing is set in the snd_open and snd_close properties. You can silence them by setting the following properties as shown:<br />
<br />
''snd_open null''<br><br />
''snd_close null''<br />
<br />
Don't just use a dash - as it seems to cause a sound of its own.<br />
<br />
''snd_locked''<br><br />
The sound played when a player tries to open a locked door.<br />
<br />
''snd_unlock string''<br><br />
The sound played when a player unlocks a door.<br />
<br />
''loss_open''<br><br />
Drop in sound volume in dB when going through an open door. (default 1dB)<br />
<br />
''loss_closed''<br><br />
Drop in sound volume in dB when going through a closed door. (default 15dB) You would want to set this very high to block all sound with a thick door but very low for a barred gate for example.<br />
<br />
''loss_double_open''<br><br />
Drop in sound volume in dB when going through double doors when only one is open. (default 1dB)<br />
<br />
There are also various sound properties for lockpicking:<br><br />
''snd_lockpick_pin_1 through 14'' and ''snd_lockpick_pin_success''<br />
<br />
<br />
<br />
<br />
===Speed of Door Opening and Closing===<br />
<br />
Rotating Door Speed:<br><br />
At the time of writing, the time a rotating door takes to open or close is set in the ''move_time'' property whatever its maximum open angle. So with rotation set at say 150 degrees the door just opens faster than at say 80 degrees. This is likely to be changed to a constant angular velocity so check to see if there a new property added if the following no longer works. The problem is that if an interruptable (see Extra Notes) door is frobbed while in motion it stops; another frob will reverse the motion - so even if the door is only open a crack it will still take the full time to close and vice versa.<br />
<br />
To change the time a rotating door takes to open or close, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''move_time''<br />
* Edit the second line of the input box ''below'' the properties window to the time you want.<br />
* The time is in seconds and decimal fractions can be used.<br />
* The default is 1 second and if set to this then the door opens and closes in one second whatever the maximum open angle, great or small.<br />
<br />
<br />
Sliding Door Speed:<br><br />
The speed of a sliding door is set in the ''translate_speed'' property. To add this, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''translate_speed''<br />
* Edit the second line of the input box ''below'' the properties window to the speed you want.<br />
* The speed is in Dark Radiant grid units per second.<br />
* The default is 0 and if set to this then the door slides open in one second whatever the distance, great or small.<br />
* CAUTION: If you later change the door back to a rotating door then delete the ''translate_speed'' property or ensure it is set to 0 as (at the time of writing but this will be fixed) a bug makes rotating doors open and close instantly. (Note: you can still mix sliding with rotating but check - this bug might only be if ''translate'' is set to 0 0 0)<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Visportals and Doors===<br />
<br />
A visportal face surrounded by solid at its edges and in contact with a door is closed when the door is closed and enabled when the door is open. In most cases you will place a visportal in contact with a working door unless you can see through the door (such as a true glass door or barred gate.) For full details see [[Visportals]]<br />
<br />
<br />
<br />
<br />
&nbsp;<br />
==Extra Notes==<br />
The property ''interruptable'' determines whether a door can be stopped by frobbing while it is opening or closing. So by frobbing then frobbing again, the player can open a door to any position, eg, slightly ajar to peek through.<br />
<br />
The property "editor_var master_open" is for if you have associated doors for opening then one should serve as master. Presumably for such as double doors opening and closing together. At the time of writing I have not found any further information on this and might not yet be implemented.<br />
<br />
The property "editor_var master_lock" is like "associate_master_open'' above but for locks.<br />
<br />
''func_darkmod_door'' is no longer used (just in case you come across it in the Dark Mod forums or wiki.) The Doom func_door is still available but for Dark Mod, atdm:mover_door is the entity to use.<br />
<br />
<br />
[[Category:Tutorial]]<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=User:Sparhawk&diff=3695User:Sparhawk2007-09-07T11:20:36Z<p>Sparhawk: New page: Project lead and lead coder for The Dark Mod.</p>
<hr />
<div>Project lead and lead coder for The Dark Mod.</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=3680Doors2007-09-06T08:05:44Z<p>Sparhawk: </p>
<hr />
<div> ATTENTION! The configuration for door spawnargs are no longer valid and need some<br />
modifications, which will be updated shortly. The general setup, described here is<br />
ok, only the setup of the spawnargs has been changed. (sparhawk) <br />
<br />
<br />
''Written by Fidcal''<br />
<br />
==Introduction==<br />
<br />
This tutorial explains how to put doors into your Dark Mod map using Dark Radiant and adjust them and their properties.<br />
<br />
Quick way for the moderately knowledgeable to skip the detail and just get an ordinary unlocked door in your map as fast as possible you need only...<br />
<br />
* Create a model door<br />
* Change it from func_static to atdm:mover_door<br />
* Create a door handle (must be created ''after'' the door!)<br />
* Change it from func_static to atdm:mover_door_handle<br />
* Add the ''door_body'' property to the handle and give it the name of the door<br />
* To open clockwise change the ''rotate'' property from 0 90 0 to 0 -90 0.<br />
<br />
<br />
The rest of this tutorial assumes very little prior knowledge so is suitable for beginners even without Doom editing experience. You need to know:<br />
<br />
<br />
* 'entity inspector' is available from the view menu or shortcut key.<br />
* 'orthoview' means any of the xyz top, side, front, grid views<br />
* Up, down, left, and right in Dark Radiant's ''top'' orthoview are regarded here as the standard map directions of North, South, East, and West where useful for clarity.<br />
* Where the term ''brush'' is used with a door it mostly also applies to a door made up of a group of brushes and/or patches.<br />
* Where the term ''door'' is used it often will also apply to any object you wish to rotate when frobbed, for instance an openable window, box lid, or even more exotic objects that the imaginative mapper might conceive like a signal, engine part, toy, or whatever. So long as it needs to turn or slide just a fixed amount when frobbed then return when frobbed again then the following applies.<br />
<br />
<br />
<br />
&nbsp;<br />
==Door types==<br />
<br />
All tangible objects in Dark Mod are ''entities'' having either a pre-made model shape or else brush/patch(es). So there are two ways to create a door in Dark Radiant: as a model door or a textured brush door (or a hybrid of the two.)<br />
<br />
Models are ready made door objects but cannot within Dark Radiant (at the time of writing) be resized, rescaled, cropped or clipped whereas brushes are very flexible in that respect and can be worked into custom shapes for your map, including secret doors that blend into walls and other surfaces.<br />
<br />
Although many models are already assigned to entities in Dark Radiant's right click create entity list, all door models are (at the time of writing) in the create models list (under models/darkmod/architecture/doors) and are automatically assigned to static entities by default. So these are immediately useable as static doors or can be quickly made into functioning doors (see later) by re-parenting them to a functioning door entity.<br />
<br />
Remember also that door functions may be applied to objects other than doors for instance to openable windows, drawbridges, gates, in fact anything that needs a partial rotation or slide when frobbed then return when frobbed again such as a signal device.<br />
<br />
<br />
<br />
&nbsp;<br />
<br />
==Creating a Door==<br />
<br />
Put simply, to make a door you will be creating an 'entity with model' or 'entity with brush' or some variation thereof.<br />
<br />
===Creating a Model Door===<br />
<br />
There are two approaches to making a model door; the first is simpler for a working door; the second if you just want a static door. But both routes can produce a fully working door.<br />
<br />
First approach:<br />
<br />
* Create any temporary brush<br />
* Right click in orthoview and select Create Entity then atdm:mover_door.<br />
* Left lick the model name line in the entity inspector.<br />
* Below it on the Entity Inspector panel you should now see a button 'Choose Model'<br />
* Left click it, select a door model from the darkmod group.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* The temporary brush was deleted.<br />
* You now have a working door with default properties.<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Alternatively you can do it the other way round:<br />
<br />
* Right click in the orthoview, select Create Model then darkmod and select a door.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* Click OK and you have a static door.<br />
* If you want to make it work (openable, frobbable) then...<br />
* Select the entity inspector,<br />
* Select the top classname line so it highlights<br />
* Select the func_static line in the input box + check(tick) button ''below'' the properties window.<br />
* Edit func_static to atdm:mover_door<br />
* Click the check(tick) button<br />
* You now have a working door with default properties<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
===Creating a Textured Brush Door===<br />
<br />
The simplest brush door:<br />
<br />
* Tip : If unsure of size then you might insert a temporary human AI first to get a sense of height.<br />
* Drag out a new brush to the size required, eg, a seven foot high door is 84" x 1.1 = about 90 units in Dark Radiant.<br />
* Give it a door texture from the texture browser (or wall texture for a secret door)<br />
* Right click in orthoview and select Create Entity then atdm:mover_door<br />
* You now have a default door that rotates around its centre.<br />
* To move the rotation point to the door edge and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Multi-brush doors:<br />
<br />
More complex multi-brush doors can be created using the clipper tool, CSG, etc. (not covered in this tutorial) and then assign atdm:mover_door for that whole brush structure. Also you can collect various brushes positioned together in relation to one another as needed, select them all, then assign atdm:mover_door for the group. All the brushes will be children of the atdm:mover_door entity and will rotate and be frobbable, etc. as one unit, as one door. To add further brushes or even model shapes later see the section on ''Adding handles and other items to doors''<br />
<br />
<br />
<br />
&nbsp;<br />
==Customising and Adjusting Door Properties==<br />
<br />
Handles, lockplates, etc. can be added to doors and door properties can be adjusted for rotation, sliding, locking, and more.<br />
<br />
<br />
<br />
===Adding handles and other items to doors===<br />
<br />
You can add handles and other items to doors such that they move correctly with the door whether rotating, sliding, or both and even if the door is not vertical such as a skylight or trapdoor.<br />
<br />
To add a working model door handle (works with both a model door and a brush door):<br />
* Create a door and a handle (the order no longer matters).<br />
* Proceed as for ''Creating a Model Door'' above but instead of the entity ''atdm:mover_door'' use ''atdm:mover_door_handle'' and when you choose a model choose a door handle instead of a door.<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the handle. To do this...<br />
* Select the door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the handle<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* You now have a working door handle with default properties<br />
<br />
<br />
To add a brush to a brush door:<br />
* Select the new brush ''and'' the brush door all together; ''the entity '''must''' be selected '''last'''.''<br />
* Use Menu > Edit > Reparent primitives. This ensures the parent entity adopts the new item(s).<br />
* If you have trouble selecting them in the orthoview because other brushes, etc. get selected then try in the camera view or as a last resort move them temporarily to an open area (but keep them in the same positions relative to each other.) Use Shift + Left Click on new item(s) then Shift + Left Click on main entity. Once they are all selected use the Menu > Edit > Parent. <br />
<br />
<br />
To add ''model'' static items: knockers, hinges, static handles to a Model Door:<br />
* Select item<br />
* Right click in orthoview and select Create Entity then ''entity func_static''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''bind'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''bind''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
<br />
<br />
<br />
To add ''brush'' static items: knockers, hinges, static handles to a Model Door:<br />
* This method is not ideal but it seems to work OK.<br />
* Select the brush.<br />
* Right click in orthoview and select Create Entity then ''atdm:mover_door_handle''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* This brush turns like a handle. To stop it...<br />
* Adding ''rotate 0 0 0'' or disabling the handle script won't help.<br />
* Add a real working handle (as in the section above ''To add a working model door handle...'' and it must be added LAST.)<br />
* If you don't want too see a real working handle added maybe try another tiny brush with the handle function and hide it inside the door?<br />
<br />
===Locking Doors, Keys and Lockpicks===<br />
<br />
To lock a door check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''locked'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unlocked (default)<br />
1 = locked<br />
<br />
If locked it will require an entity that is associated with it to be able to act as a key to unlock it.<br />
<br />
To make a door ''lockpickable'' check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''pickable'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unpickable<br />
1 = pickable (default)<br />
<br />
If pickable then the door can be opened with a lockpick.<br />
<br />
lock_pins property (WIP - UPDATE LATER) SEE ALSO SOUND SECTION FOR PINS.<br />
<br />
<br />
<br />
<br />
<br />
===Open, Partially Open, or Closed Door at Game Start===<br />
<br />
By default, doors are closed at game start. If you want a door to be already open or partially open then do the following.<br />
<br />
<br />
<br />
Already Open Rotating Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Make sure its ''open'' property is set to 1 as above.<br />
* Right click the entity inspector and select ''add property'' <br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* scroll down, select ''start_rotate'' then click OK.<br />
* This adds it to the property list.<br />
* Now select ''start_rotate'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the angle you want in the same form as described in the ''Rotate Direction and Open Angle'' section. So for example, to have a door that has a fully open default ''rotate'' value of 0 90 0 to start only half open you would give it a ''start_rotate'' value of 0 45 0. <br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
Already Open Sliding Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Right click the entity inspector and select ''add property'' <br />
* Make sure its ''open'' property is set to 1<br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder.<br />
* scroll down, select ''start_position'' then click OK. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* This adds it to the property list.<br />
* Now select ''start_position'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the position you want in the same form as described in the ''Sliding (Translation) Amount and Direction'' section. So for example, to have a door that has a fully open default ''translate'' value of 0 50 0 to start only half open you would give it a ''start_position'' value of 0 25 0.<br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Rotation Centre, Pivot, Hinge point===<br />
<br />
The centre of rotation of a door is at the origin point of its entity and the door rotates with reference to the orientation of that origin point, not the world map. See ''Rotate Direction...'' for more about that. This section only deals with the ''position'' of the rotation centre in the door.<br />
<br />
<br />
Model Door Centre of Rotation:<br><br />
The centre of rotation of a model door cannot be changed within Dark Radiant. Because a model door rotates around the centre 'spine' of its back edge this will cause clipping (penetration into solid) as in this example (where the door is set to open to 89 degrees for clarity):<BR>[[Image:modelClipping.jpg]]<BR> So care is needed with placement. You will not normally position a door right next to a wall as in the example but against a shallow frame so clipping will barely be noticeable but either way it can be fixed. You can correct it by adding a translation (see ''Sliding (Translation) Directions'') value of half the door width in the direction of the door handle. This will gently move the door out as it rotates to clear any solid on that side as in this diagram:<br><br />
[[Image:DoorClip.jpg]]<br><br />
Half a door width will typically be about 2. Any 'attachments' such as door handles will still synchronize with the door movement whether the door is rotating, sliding, or both.<br />
<br />
<br />
Brush Door Centre of Rotation:<br><br />
The centre of rotation of a brush door ''can'' be changed. The default origin point of a brush is at its centre. Therefore a default rotating brush door will rotate around its centre when you first create it. So, mappers will commonly need to move that rotation point to a corner or even to some other offset position for example, for an openable window using the door function.<br />
<br />
Put simply, to move the rotation point of a brush door you need to move the entity origin relative to the brush(es.)<br />
<br />
Moving the entity origin (centre of rotation) relative to a brush door:<br />
<br />
* Select the brush door<br />
* Select Vertices mode (Default shortcut key is V or button on top toolbar 'Select Vertices')<br />
* Drag the door's entity origin to the point where you want the door to rotate. This should be on the corner on the leading edge side (the side to where the door is opening.) to avoid clipping as in this diagram....<br />
[[Image:getCorner.jpg]]<br />
* You should now find that door rotates around that point.<br />
<br />
===Rotate Direction and Open Angle===<br />
<br />
By default, rotating doors open anti-clockwise (viewed from above) by 90 degrees from the start orientation. If you want to change this edit the ''rotate'' property in the entity inspector. Don't confuse this ''rotate'' property with the ''rotation'' property. In the entity inspector remember that to see the inherited rotate property you must check the box 'Show inherited properties'.<br />
<br />
The three values shown in the rotate property are degrees from the closed position around Y Z X ''entity origin axes'' (NOT absolute map axes) and so include any start ''rotation''. So the Z value is the axis vertical to the entity origin. If you tilt a model door over in Dark Radiant then its entity origin tilts too so the Z axis is tilted too (with respect to the world map vertical.) So with a normally opening model door if you lay it flat on its back it will open upwards and not rotate around on the floor. But a brush door must be treated differently...<br />
<br />
If you turn a brush door using the normal Dark Radiant rotate tool or the Transform Dialog (accessed via a shortcut key) then it only turns the brush ''relative'' to the entity. So, because the entity origin is by default aligned with the world map then ''in most cases'' you can regard a brush door as rotating with respect to the world map if you wish. But there will be a problem when you come to rotations that are not around the main Y Z X axes of the map, for instance a drawbridge that lowers down to the south east. You might think you can combine Y Z X values to get the result you want - and this can be done (for south east use 45 45 90) but it is a bit of a kludge and the drawbridge twists eccentrically as it lowers (though it arrives correctly!) So for such cases you need to turn the entity itself so its start position is facing south east. You can then just use 0 0 90 to lower the drawbridge perfectly because its Y axis is now pointing south east. To turn the entity you must type or paste the rotation values in directly because using the Dark Radiant rotation tool or Transform Dialog will only turn the brush not the entity. The values are rather lengthy (south east is 0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1) so probably the easiest way is to create a temporary model door, turn it how you want, then select its rotation property. If you now deselect and re-select your brush door then that property will still be in the entity inspector input box and you need only click the check(tick) box to add it to the brush door. NOTE: ''neither the entity nor the brush will show as turned in Dark Radiant.'' Only the rotation property in the entity inspector will indicate the orientation. Instead of a rotated ''construction'', regard it as a rotation ''instruction'' for when the map is compiled.<br />
<br />
These are the rotate property fields. Remember they are all with reference to the door's entity ''not'' the world map. Since there is no absolute frame of reference I indicate them here as if the entity is aligned with the world map axes...<br />
<br />
* Positive Y = Open clockwise (Dark Radiant grid front view, looking north)<br />
* Negative Y = Open anti-clockwise (Dark Radiant grid front view, looking north)<br />
<br />
* Positive Z = Open anti-clockwise (Dark Radiant grid top view, looking down)<br />
* Negative Z = Open clockwise (Dark Radiant grid top view, looking down)<br />
<br />
* Positive X = Open anti-clockwise (Dark Radiant grid side view, looking west)<br />
* Negative X = Open clockwise (Dark Radiant grid side view, looking west)<br />
<br />
The values are in the range -179 to +180. Positive values give an anti-clockwise opening rotation (looking down from above) and negative values give a clockwise opening rotation. The value 180 is unique in that it continues in an anti-clockwise rotation when closing rather than returning clockwise so might be used if you can think of some object that might need such a motion when frobbed!<br />
<br />
Edit the rotate value by selecting it and using the input box at the bottom and clicking the check(tick) button. That will change the angle the door will open to. Note that the line with the original default of 0 90 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Examples:<br />
* 0 90 0 = Opens anti-clockwise round the entity's 'vertical' to 90 degrees - typical default vertical door.<br />
* 0 0 90 = Lowers a drawbridge from the entity 'vertical' to horizontal.<br />
* 0 0 -45 = Opens clockwise by 45 degrees viewed from the east side. This might suit a skylight in a sloping roof.<br />
<br />
Combinations can be used and also combined with slide motions (see '''Sliding (Translation) Directions''') to produce exotic and useful motions. A door opening against an upward-sloping floor can thus have a ''lifting hinge'' and raise up slightly to clear the floor; a door can rotate towards you and slide back to one side very effectively.<br />
<br />
<br />
<br />
<br />
<br />
===Sliding (Translation) Amount and Direction===<br />
<br />
By default a Dark Mod door will rotate open. For most sliding doors you want to stop them rotating as well as make them slide. You cannot delete (remove) the ''rotate'' property - you have to set the ''rotate'' property to 0 0 0 to stop a door rotating (see ''Rotate Direction and Open Angle''.)<br />
<br />
Now edit the ''translate'' property value by selecting it (remember to have inherited properties box checked) and using the input box at the bottom and clicking the check(tick) button. That will change the distance the door will slide to. Note that the line with the original default of 0 0 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Typically (but not always) you will want your sliding door to slide the width of the door. The three values in the translate property by default are 0 0 0 and are X Y Z ''absolute map'' values (irrespective of door orientation) where...<br />
<br />
<br />
* Positive X = Slide East (Right side of Dark Radiant grid in top view)<br />
* Negative X = Slide West (Left side of Dark Radiant grid in top view)<br />
* Positive Y = Slide North (top of Dark Radiant grid in top view)<br />
* Negative Y = Slide South (bottom of Dark Radiant grid in top view)<br />
* Positive Z = Slide Up (Top of Dark Radiant grid in side views)<br />
* Negative Z = Slide Down (Bottom of Dark Radiant grid in side views)<br />
<br />
So for a 50 unit wide door you want to slide fully to the east you would use 50 0 0 for the translate property values. A 100 unit portcullis sliding vertically up would need 0 0 100 to be fully raised.<br />
<br />
<br />
<br />
===Sounds and Sound Propagation through Doors and Doorways===<br />
<br />
Sound propagation relies on visportals. For details study [[Sound Propagation: Part 1]] and [[Sound Propagation: Part 2]] as well as [[Visportals]] This tutorial will just cover the relevant sound and sound propagation ''properties'' of doors. If you set the ''show inherited properties'' box in the entity inspector you can see them as described here.<br />
<br />
The sound of doors opening and closing is set in the snd_open and snd_close properties. You can silence them by setting the following properties as shown:<br />
<br />
''snd_open null''<br><br />
''snd_close null''<br />
<br />
Don't just use a dash - as it seems to cause a sound of its own.<br />
<br />
''snd_locked''<br><br />
The sound played when a player tries to open a locked door.<br />
<br />
''snd_unlock string''<br><br />
The sound played when a player unlocks a door.<br />
<br />
''loss_open''<br><br />
Drop in sound volume in dB when going through an open door. (default 1dB)<br />
<br />
''loss_closed''<br><br />
Drop in sound volume in dB when going through a closed door. (default 15dB) You would want to set this very high to block all sound with a thick door but very low for a barred gate for example.<br />
<br />
''loss_double_open''<br><br />
Drop in sound volume in dB when going through double doors when only one is open. (default 1dB)<br />
<br />
There are also various sound properties for lockpicking:<br><br />
''snd_lockpick_pin_1 through 14'' and ''snd_lockpick_pin_success''<br />
<br />
<br />
<br />
<br />
===Speed of Door Opening and Closing===<br />
<br />
Rotating Door Speed:<br><br />
At the time of writing, the time a rotating door takes to open or close is set in the ''move_time'' property whatever its maximum open angle. So with rotation set at say 150 degrees the door just opens faster than at say 80 degrees. This is likely to be changed to a constant angular velocity so check to see if there a new property added if the following no longer works. The problem is that if an interruptable (see Extra Notes) door is frobbed while in motion it stops; another frob will reverse the motion - so even if the door is only open a crack it will still take the full time to close and vice versa.<br />
<br />
To change the time a rotating door takes to open or close, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''move_time''<br />
* Edit the second line of the input box ''below'' the properties window to the time you want.<br />
* The time is in seconds and decimal fractions can be used.<br />
* The default is 1 second and if set to this then the door opens and closes in one second whatever the maximum open angle, great or small.<br />
<br />
<br />
Sliding Door Speed:<br><br />
The speed of a sliding door is set in the ''translate_speed'' property. To add this, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''translate_speed''<br />
* Edit the second line of the input box ''below'' the properties window to the speed you want.<br />
* The speed is in Dark Radiant grid units per second.<br />
* The default is 0 and if set to this then the door slides open in one second whatever the distance, great or small.<br />
* CAUTION: If you later change the door back to a rotating door then delete the ''translate_speed'' property or ensure it is set to 0 as (at the time of writing but this will be fixed) a bug makes rotating doors open and close instantly. (Note: you can still mix sliding with rotating but check - this bug might only be if ''translate'' is set to 0 0 0)<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Visportals and Doors===<br />
<br />
A visportal face surrounded by solid at its edges and in contact with a door is closed when the door is closed and enabled when the door is open. In most cases you will place a visportal in contact with a working door unless you can see through the door (such as a true glass door or barred gate.) For full details see [[Visportals]]<br />
<br />
<br />
<br />
<br />
&nbsp;<br />
==Extra Notes==<br />
The property ''interruptable'' determines whether a door can be stopped by frobbing while it is opening or closing.<br />
<br />
The property "editor_var master_open" is for if you have associated doors for opening then one should serve as master. Presumably for such as double doors opening and closing together. At the time of writing I have not found any further information on this and might not yet be implemented.<br />
<br />
The property "editor_var master_lock" is like "associate_master_open'' above but for locks.<br />
<br />
''func_darkmod_door'' is no longer used (just in case you come across it in the Dark Mod forums or wiki.) The Doom func_door is still available but for Dark Mod, atdm:mover_door is the entity to use.<br />
<br />
<br />
[[Category:Tutorial]]<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=3679Doors2007-09-06T08:04:26Z<p>Sparhawk: /* Creating a Model Door */</p>
<hr />
<div>''Written by Fidcal''<br />
<br />
==Introduction==<br />
<br />
This tutorial explains how to put doors into your Dark Mod map using Dark Radiant and adjust them and their properties.<br />
<br />
Quick way for the moderately knowledgeable to skip the detail and just get an ordinary unlocked door in your map as fast as possible you need only...<br />
<br />
* Create a model door<br />
* Change it from func_static to atdm:mover_door<br />
* Create a door handle (must be created ''after'' the door!)<br />
* Change it from func_static to atdm:mover_door_handle<br />
* Add the ''door_body'' property to the handle and give it the name of the door<br />
* To open clockwise change the ''rotate'' property from 0 90 0 to 0 -90 0.<br />
<br />
<br />
The rest of this tutorial assumes very little prior knowledge so is suitable for beginners even without Doom editing experience. You need to know:<br />
<br />
<br />
* 'entity inspector' is available from the view menu or shortcut key.<br />
* 'orthoview' means any of the xyz top, side, front, grid views<br />
* Up, down, left, and right in Dark Radiant's ''top'' orthoview are regarded here as the standard map directions of North, South, East, and West where useful for clarity.<br />
* Where the term ''brush'' is used with a door it mostly also applies to a door made up of a group of brushes and/or patches.<br />
* Where the term ''door'' is used it often will also apply to any object you wish to rotate when frobbed, for instance an openable window, box lid, or even more exotic objects that the imaginative mapper might conceive like a signal, engine part, toy, or whatever. So long as it needs to turn or slide just a fixed amount when frobbed then return when frobbed again then the following applies.<br />
<br />
<br />
<br />
&nbsp;<br />
==Door types==<br />
<br />
All tangible objects in Dark Mod are ''entities'' having either a pre-made model shape or else brush/patch(es). So there are two ways to create a door in Dark Radiant: as a model door or a textured brush door (or a hybrid of the two.)<br />
<br />
Models are ready made door objects but cannot within Dark Radiant (at the time of writing) be resized, rescaled, cropped or clipped whereas brushes are very flexible in that respect and can be worked into custom shapes for your map, including secret doors that blend into walls and other surfaces.<br />
<br />
Although many models are already assigned to entities in Dark Radiant's right click create entity list, all door models are (at the time of writing) in the create models list (under models/darkmod/architecture/doors) and are automatically assigned to static entities by default. So these are immediately useable as static doors or can be quickly made into functioning doors (see later) by re-parenting them to a functioning door entity.<br />
<br />
Remember also that door functions may be applied to objects other than doors for instance to openable windows, drawbridges, gates, in fact anything that needs a partial rotation or slide when frobbed then return when frobbed again such as a signal device.<br />
<br />
<br />
<br />
&nbsp;<br />
<br />
==Creating a Door==<br />
<br />
Put simply, to make a door you will be creating an 'entity with model' or 'entity with brush' or some variation thereof.<br />
<br />
===Creating a Model Door===<br />
<br />
There are two approaches to making a model door; the first is simpler for a working door; the second if you just want a static door. But both routes can produce a fully working door.<br />
<br />
First approach:<br />
<br />
* Create any temporary brush<br />
* Right click in orthoview and select Create Entity then atdm:mover_door.<br />
* Left lick the model name line in the entity inspector.<br />
* Below it on the Entity Inspector panel you should now see a button 'Choose Model'<br />
* Left click it, select a door model from the darkmod group.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* The temporary brush was deleted.<br />
* You now have a working door with default properties.<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Alternatively you can do it the other way round:<br />
<br />
* Right click in the orthoview, select Create Model then darkmod and select a door.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* Click OK and you have a static door.<br />
* If you want to make it work (openable, frobbable) then...<br />
* Select the entity inspector,<br />
* Select the top classname line so it highlights<br />
* Select the func_static line in the input box + check(tick) button ''below'' the properties window.<br />
* Edit func_static to atdm:mover_door<br />
* Click the check(tick) button<br />
* You now have a working door with default properties<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
===Creating a Textured Brush Door===<br />
<br />
The simplest brush door:<br />
<br />
* Tip : If unsure of size then you might insert a temporary human AI first to get a sense of height.<br />
* Drag out a new brush to the size required, eg, a seven foot high door is 84" x 1.1 = about 90 units in Dark Radiant.<br />
* Give it a door texture from the texture browser (or wall texture for a secret door)<br />
* Right click in orthoview and select Create Entity then atdm:mover_door<br />
* You now have a default door that rotates around its centre.<br />
* To move the rotation point to the door edge and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Multi-brush doors:<br />
<br />
More complex multi-brush doors can be created using the clipper tool, CSG, etc. (not covered in this tutorial) and then assign atdm:mover_door for that whole brush structure. Also you can collect various brushes positioned together in relation to one another as needed, select them all, then assign atdm:mover_door for the group. All the brushes will be children of the atdm:mover_door entity and will rotate and be frobbable, etc. as one unit, as one door. To add further brushes or even model shapes later see the section on ''Adding handles and other items to doors''<br />
<br />
<br />
<br />
&nbsp;<br />
==Customising and Adjusting Door Properties==<br />
<br />
Handles, lockplates, etc. can be added to doors and door properties can be adjusted for rotation, sliding, locking, and more.<br />
<br />
<br />
<br />
===Adding handles and other items to doors===<br />
<br />
You can add handles and other items to doors such that they move correctly with the door whether rotating, sliding, or both and even if the door is not vertical such as a skylight or trapdoor.<br />
<br />
To add a working model door handle (works with both a model door and a brush door):<br />
* Create a door and a handle (the order no longer matters).<br />
* Proceed as for ''Creating a Model Door'' above but instead of the entity ''atdm:mover_door'' use ''atdm:mover_door_handle'' and when you choose a model choose a door handle instead of a door.<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the handle. To do this...<br />
* Select the door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the handle<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* You now have a working door handle with default properties<br />
<br />
<br />
To add a brush to a brush door:<br />
* Select the new brush ''and'' the brush door all together; ''the entity '''must''' be selected '''last'''.''<br />
* Use Menu > Edit > Reparent primitives. This ensures the parent entity adopts the new item(s).<br />
* If you have trouble selecting them in the orthoview because other brushes, etc. get selected then try in the camera view or as a last resort move them temporarily to an open area (but keep them in the same positions relative to each other.) Use Shift + Left Click on new item(s) then Shift + Left Click on main entity. Once they are all selected use the Menu > Edit > Parent. <br />
<br />
<br />
To add ''model'' static items: knockers, hinges, static handles to a Model Door:<br />
* Select item<br />
* Right click in orthoview and select Create Entity then ''entity func_static''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''bind'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''bind''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
<br />
<br />
<br />
To add ''brush'' static items: knockers, hinges, static handles to a Model Door:<br />
* This method is not ideal but it seems to work OK.<br />
* Select the brush.<br />
* Right click in orthoview and select Create Entity then ''atdm:mover_door_handle''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* This brush turns like a handle. To stop it...<br />
* Adding ''rotate 0 0 0'' or disabling the handle script won't help.<br />
* Add a real working handle (as in the section above ''To add a working model door handle...'' and it must be added LAST.)<br />
* If you don't want too see a real working handle added maybe try another tiny brush with the handle function and hide it inside the door?<br />
<br />
===Locking Doors, Keys and Lockpicks===<br />
<br />
To lock a door check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''locked'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unlocked (default)<br />
1 = locked<br />
<br />
If locked it will require an entity that is associated with it to be able to act as a key to unlock it.<br />
<br />
To make a door ''lockpickable'' check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''pickable'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unpickable<br />
1 = pickable (default)<br />
<br />
If pickable then the door can be opened with a lockpick.<br />
<br />
lock_pins property (WIP - UPDATE LATER) SEE ALSO SOUND SECTION FOR PINS.<br />
<br />
<br />
<br />
<br />
<br />
===Open, Partially Open, or Closed Door at Game Start===<br />
<br />
By default, doors are closed at game start. If you want a door to be already open or partially open then do the following.<br />
<br />
<br />
<br />
Already Open Rotating Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Make sure its ''open'' property is set to 1 as above.<br />
* Right click the entity inspector and select ''add property'' <br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* scroll down, select ''start_rotate'' then click OK.<br />
* This adds it to the property list.<br />
* Now select ''start_rotate'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the angle you want in the same form as described in the ''Rotate Direction and Open Angle'' section. So for example, to have a door that has a fully open default ''rotate'' value of 0 90 0 to start only half open you would give it a ''start_rotate'' value of 0 45 0. <br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
Already Open Sliding Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Right click the entity inspector and select ''add property'' <br />
* Make sure its ''open'' property is set to 1<br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder.<br />
* scroll down, select ''start_position'' then click OK. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* This adds it to the property list.<br />
* Now select ''start_position'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the position you want in the same form as described in the ''Sliding (Translation) Amount and Direction'' section. So for example, to have a door that has a fully open default ''translate'' value of 0 50 0 to start only half open you would give it a ''start_position'' value of 0 25 0.<br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Rotation Centre, Pivot, Hinge point===<br />
<br />
The centre of rotation of a door is at the origin point of its entity and the door rotates with reference to the orientation of that origin point, not the world map. See ''Rotate Direction...'' for more about that. This section only deals with the ''position'' of the rotation centre in the door.<br />
<br />
<br />
Model Door Centre of Rotation:<br><br />
The centre of rotation of a model door cannot be changed within Dark Radiant. Because a model door rotates around the centre 'spine' of its back edge this will cause clipping (penetration into solid) as in this example (where the door is set to open to 89 degrees for clarity):<BR>[[Image:modelClipping.jpg]]<BR> So care is needed with placement. You will not normally position a door right next to a wall as in the example but against a shallow frame so clipping will barely be noticeable but either way it can be fixed. You can correct it by adding a translation (see ''Sliding (Translation) Directions'') value of half the door width in the direction of the door handle. This will gently move the door out as it rotates to clear any solid on that side as in this diagram:<br><br />
[[Image:DoorClip.jpg]]<br><br />
Half a door width will typically be about 2. Any 'attachments' such as door handles will still synchronize with the door movement whether the door is rotating, sliding, or both.<br />
<br />
<br />
Brush Door Centre of Rotation:<br><br />
The centre of rotation of a brush door ''can'' be changed. The default origin point of a brush is at its centre. Therefore a default rotating brush door will rotate around its centre when you first create it. So, mappers will commonly need to move that rotation point to a corner or even to some other offset position for example, for an openable window using the door function.<br />
<br />
Put simply, to move the rotation point of a brush door you need to move the entity origin relative to the brush(es.)<br />
<br />
Moving the entity origin (centre of rotation) relative to a brush door:<br />
<br />
* Select the brush door<br />
* Select Vertices mode (Default shortcut key is V or button on top toolbar 'Select Vertices')<br />
* Drag the door's entity origin to the point where you want the door to rotate. This should be on the corner on the leading edge side (the side to where the door is opening.) to avoid clipping as in this diagram....<br />
[[Image:getCorner.jpg]]<br />
* You should now find that door rotates around that point.<br />
<br />
===Rotate Direction and Open Angle===<br />
<br />
By default, rotating doors open anti-clockwise (viewed from above) by 90 degrees from the start orientation. If you want to change this edit the ''rotate'' property in the entity inspector. Don't confuse this ''rotate'' property with the ''rotation'' property. In the entity inspector remember that to see the inherited rotate property you must check the box 'Show inherited properties'.<br />
<br />
The three values shown in the rotate property are degrees from the closed position around Y Z X ''entity origin axes'' (NOT absolute map axes) and so include any start ''rotation''. So the Z value is the axis vertical to the entity origin. If you tilt a model door over in Dark Radiant then its entity origin tilts too so the Z axis is tilted too (with respect to the world map vertical.) So with a normally opening model door if you lay it flat on its back it will open upwards and not rotate around on the floor. But a brush door must be treated differently...<br />
<br />
If you turn a brush door using the normal Dark Radiant rotate tool or the Transform Dialog (accessed via a shortcut key) then it only turns the brush ''relative'' to the entity. So, because the entity origin is by default aligned with the world map then ''in most cases'' you can regard a brush door as rotating with respect to the world map if you wish. But there will be a problem when you come to rotations that are not around the main Y Z X axes of the map, for instance a drawbridge that lowers down to the south east. You might think you can combine Y Z X values to get the result you want - and this can be done (for south east use 45 45 90) but it is a bit of a kludge and the drawbridge twists eccentrically as it lowers (though it arrives correctly!) So for such cases you need to turn the entity itself so its start position is facing south east. You can then just use 0 0 90 to lower the drawbridge perfectly because its Y axis is now pointing south east. To turn the entity you must type or paste the rotation values in directly because using the Dark Radiant rotation tool or Transform Dialog will only turn the brush not the entity. The values are rather lengthy (south east is 0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1) so probably the easiest way is to create a temporary model door, turn it how you want, then select its rotation property. If you now deselect and re-select your brush door then that property will still be in the entity inspector input box and you need only click the check(tick) box to add it to the brush door. NOTE: ''neither the entity nor the brush will show as turned in Dark Radiant.'' Only the rotation property in the entity inspector will indicate the orientation. Instead of a rotated ''construction'', regard it as a rotation ''instruction'' for when the map is compiled.<br />
<br />
These are the rotate property fields. Remember they are all with reference to the door's entity ''not'' the world map. Since there is no absolute frame of reference I indicate them here as if the entity is aligned with the world map axes...<br />
<br />
* Positive Y = Open clockwise (Dark Radiant grid front view, looking north)<br />
* Negative Y = Open anti-clockwise (Dark Radiant grid front view, looking north)<br />
<br />
* Positive Z = Open anti-clockwise (Dark Radiant grid top view, looking down)<br />
* Negative Z = Open clockwise (Dark Radiant grid top view, looking down)<br />
<br />
* Positive X = Open anti-clockwise (Dark Radiant grid side view, looking west)<br />
* Negative X = Open clockwise (Dark Radiant grid side view, looking west)<br />
<br />
The values are in the range -179 to +180. Positive values give an anti-clockwise opening rotation (looking down from above) and negative values give a clockwise opening rotation. The value 180 is unique in that it continues in an anti-clockwise rotation when closing rather than returning clockwise so might be used if you can think of some object that might need such a motion when frobbed!<br />
<br />
Edit the rotate value by selecting it and using the input box at the bottom and clicking the check(tick) button. That will change the angle the door will open to. Note that the line with the original default of 0 90 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Examples:<br />
* 0 90 0 = Opens anti-clockwise round the entity's 'vertical' to 90 degrees - typical default vertical door.<br />
* 0 0 90 = Lowers a drawbridge from the entity 'vertical' to horizontal.<br />
* 0 0 -45 = Opens clockwise by 45 degrees viewed from the east side. This might suit a skylight in a sloping roof.<br />
<br />
Combinations can be used and also combined with slide motions (see '''Sliding (Translation) Directions''') to produce exotic and useful motions. A door opening against an upward-sloping floor can thus have a ''lifting hinge'' and raise up slightly to clear the floor; a door can rotate towards you and slide back to one side very effectively.<br />
<br />
<br />
<br />
<br />
<br />
===Sliding (Translation) Amount and Direction===<br />
<br />
By default a Dark Mod door will rotate open. For most sliding doors you want to stop them rotating as well as make them slide. You cannot delete (remove) the ''rotate'' property - you have to set the ''rotate'' property to 0 0 0 to stop a door rotating (see ''Rotate Direction and Open Angle''.)<br />
<br />
Now edit the ''translate'' property value by selecting it (remember to have inherited properties box checked) and using the input box at the bottom and clicking the check(tick) button. That will change the distance the door will slide to. Note that the line with the original default of 0 0 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Typically (but not always) you will want your sliding door to slide the width of the door. The three values in the translate property by default are 0 0 0 and are X Y Z ''absolute map'' values (irrespective of door orientation) where...<br />
<br />
<br />
* Positive X = Slide East (Right side of Dark Radiant grid in top view)<br />
* Negative X = Slide West (Left side of Dark Radiant grid in top view)<br />
* Positive Y = Slide North (top of Dark Radiant grid in top view)<br />
* Negative Y = Slide South (bottom of Dark Radiant grid in top view)<br />
* Positive Z = Slide Up (Top of Dark Radiant grid in side views)<br />
* Negative Z = Slide Down (Bottom of Dark Radiant grid in side views)<br />
<br />
So for a 50 unit wide door you want to slide fully to the east you would use 50 0 0 for the translate property values. A 100 unit portcullis sliding vertically up would need 0 0 100 to be fully raised.<br />
<br />
<br />
<br />
===Sounds and Sound Propagation through Doors and Doorways===<br />
<br />
Sound propagation relies on visportals. For details study [[Sound Propagation: Part 1]] and [[Sound Propagation: Part 2]] as well as [[Visportals]] This tutorial will just cover the relevant sound and sound propagation ''properties'' of doors. If you set the ''show inherited properties'' box in the entity inspector you can see them as described here.<br />
<br />
The sound of doors opening and closing is set in the snd_open and snd_close properties. You can silence them by setting the following properties as shown:<br />
<br />
''snd_open null''<br><br />
''snd_close null''<br />
<br />
Don't just use a dash - as it seems to cause a sound of its own.<br />
<br />
''snd_locked''<br><br />
The sound played when a player tries to open a locked door.<br />
<br />
''snd_unlock string''<br><br />
The sound played when a player unlocks a door.<br />
<br />
''loss_open''<br><br />
Drop in sound volume in dB when going through an open door. (default 1dB)<br />
<br />
''loss_closed''<br><br />
Drop in sound volume in dB when going through a closed door. (default 15dB) You would want to set this very high to block all sound with a thick door but very low for a barred gate for example.<br />
<br />
''loss_double_open''<br><br />
Drop in sound volume in dB when going through double doors when only one is open. (default 1dB)<br />
<br />
There are also various sound properties for lockpicking:<br><br />
''snd_lockpick_pin_1 through 14'' and ''snd_lockpick_pin_success''<br />
<br />
<br />
<br />
<br />
===Speed of Door Opening and Closing===<br />
<br />
Rotating Door Speed:<br><br />
At the time of writing, the time a rotating door takes to open or close is set in the ''move_time'' property whatever its maximum open angle. So with rotation set at say 150 degrees the door just opens faster than at say 80 degrees. This is likely to be changed to a constant angular velocity so check to see if there a new property added if the following no longer works. The problem is that if an interruptable (see Extra Notes) door is frobbed while in motion it stops; another frob will reverse the motion - so even if the door is only open a crack it will still take the full time to close and vice versa.<br />
<br />
To change the time a rotating door takes to open or close, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''move_time''<br />
* Edit the second line of the input box ''below'' the properties window to the time you want.<br />
* The time is in seconds and decimal fractions can be used.<br />
* The default is 1 second and if set to this then the door opens and closes in one second whatever the maximum open angle, great or small.<br />
<br />
<br />
Sliding Door Speed:<br><br />
The speed of a sliding door is set in the ''translate_speed'' property. To add this, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''translate_speed''<br />
* Edit the second line of the input box ''below'' the properties window to the speed you want.<br />
* The speed is in Dark Radiant grid units per second.<br />
* The default is 0 and if set to this then the door slides open in one second whatever the distance, great or small.<br />
* CAUTION: If you later change the door back to a rotating door then delete the ''translate_speed'' property or ensure it is set to 0 as (at the time of writing but this will be fixed) a bug makes rotating doors open and close instantly. (Note: you can still mix sliding with rotating but check - this bug might only be if ''translate'' is set to 0 0 0)<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Visportals and Doors===<br />
<br />
A visportal face surrounded by solid at its edges and in contact with a door is closed when the door is closed and enabled when the door is open. In most cases you will place a visportal in contact with a working door unless you can see through the door (such as a true glass door or barred gate.) For full details see [[Visportals]]<br />
<br />
<br />
<br />
<br />
&nbsp;<br />
==Extra Notes==<br />
The property ''interruptable'' determines whether a door can be stopped by frobbing while it is opening or closing.<br />
<br />
The property "editor_var master_open" is for if you have associated doors for opening then one should serve as master. Presumably for such as double doors opening and closing together. At the time of writing I have not found any further information on this and might not yet be implemented.<br />
<br />
The property "editor_var master_lock" is like "associate_master_open'' above but for locks.<br />
<br />
''func_darkmod_door'' is no longer used (just in case you come across it in the Dark Mod forums or wiki.) The Doom func_door is still available but for Dark Mod, atdm:mover_door is the entity to use.<br />
<br />
<br />
[[Category:Tutorial]]<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=3678Doors2007-09-06T08:04:08Z<p>Sparhawk: /* Creating a Model Door */</p>
<hr />
<div>''Written by Fidcal''<br />
<br />
==Introduction==<br />
<br />
This tutorial explains how to put doors into your Dark Mod map using Dark Radiant and adjust them and their properties.<br />
<br />
Quick way for the moderately knowledgeable to skip the detail and just get an ordinary unlocked door in your map as fast as possible you need only...<br />
<br />
* Create a model door<br />
* Change it from func_static to atdm:mover_door<br />
* Create a door handle (must be created ''after'' the door!)<br />
* Change it from func_static to atdm:mover_door_handle<br />
* Add the ''door_body'' property to the handle and give it the name of the door<br />
* To open clockwise change the ''rotate'' property from 0 90 0 to 0 -90 0.<br />
<br />
<br />
The rest of this tutorial assumes very little prior knowledge so is suitable for beginners even without Doom editing experience. You need to know:<br />
<br />
<br />
* 'entity inspector' is available from the view menu or shortcut key.<br />
* 'orthoview' means any of the xyz top, side, front, grid views<br />
* Up, down, left, and right in Dark Radiant's ''top'' orthoview are regarded here as the standard map directions of North, South, East, and West where useful for clarity.<br />
* Where the term ''brush'' is used with a door it mostly also applies to a door made up of a group of brushes and/or patches.<br />
* Where the term ''door'' is used it often will also apply to any object you wish to rotate when frobbed, for instance an openable window, box lid, or even more exotic objects that the imaginative mapper might conceive like a signal, engine part, toy, or whatever. So long as it needs to turn or slide just a fixed amount when frobbed then return when frobbed again then the following applies.<br />
<br />
<br />
<br />
&nbsp;<br />
==Door types==<br />
<br />
All tangible objects in Dark Mod are ''entities'' having either a pre-made model shape or else brush/patch(es). So there are two ways to create a door in Dark Radiant: as a model door or a textured brush door (or a hybrid of the two.)<br />
<br />
Models are ready made door objects but cannot within Dark Radiant (at the time of writing) be resized, rescaled, cropped or clipped whereas brushes are very flexible in that respect and can be worked into custom shapes for your map, including secret doors that blend into walls and other surfaces.<br />
<br />
Although many models are already assigned to entities in Dark Radiant's right click create entity list, all door models are (at the time of writing) in the create models list (under models/darkmod/architecture/doors) and are automatically assigned to static entities by default. So these are immediately useable as static doors or can be quickly made into functioning doors (see later) by re-parenting them to a functioning door entity.<br />
<br />
Remember also that door functions may be applied to objects other than doors for instance to openable windows, drawbridges, gates, in fact anything that needs a partial rotation or slide when frobbed then return when frobbed again such as a signal device.<br />
<br />
<br />
<br />
&nbsp;<br />
<br />
==Creating a Door==<br />
<br />
Put simply, to make a door you will be creating an 'entity with model' or 'entity with brush' or some variation thereof.<br />
<br />
===Creating a Model Door===<br />
<br />
ATTENTION! These steps are no lopnger valid and need some modifications, which will be updated shortly. (sparhawk)<br />
<br />
There are two approaches to making a model door; the first is simpler for a working door; the second if you just want a static door. But both routes can produce a fully working door.<br />
<br />
First approach:<br />
<br />
* Create any temporary brush<br />
* Right click in orthoview and select Create Entity then atdm:mover_door.<br />
* Left lick the model name line in the entity inspector.<br />
* Below it on the Entity Inspector panel you should now see a button 'Choose Model'<br />
* Left click it, select a door model from the darkmod group.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* The temporary brush was deleted.<br />
* You now have a working door with default properties.<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Alternatively you can do it the other way round:<br />
<br />
* Right click in the orthoview, select Create Model then darkmod and select a door.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* Click OK and you have a static door.<br />
* If you want to make it work (openable, frobbable) then...<br />
* Select the entity inspector,<br />
* Select the top classname line so it highlights<br />
* Select the func_static line in the input box + check(tick) button ''below'' the properties window.<br />
* Edit func_static to atdm:mover_door<br />
* Click the check(tick) button<br />
* You now have a working door with default properties<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
===Creating a Textured Brush Door===<br />
<br />
The simplest brush door:<br />
<br />
* Tip : If unsure of size then you might insert a temporary human AI first to get a sense of height.<br />
* Drag out a new brush to the size required, eg, a seven foot high door is 84" x 1.1 = about 90 units in Dark Radiant.<br />
* Give it a door texture from the texture browser (or wall texture for a secret door)<br />
* Right click in orthoview and select Create Entity then atdm:mover_door<br />
* You now have a default door that rotates around its centre.<br />
* To move the rotation point to the door edge and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Multi-brush doors:<br />
<br />
More complex multi-brush doors can be created using the clipper tool, CSG, etc. (not covered in this tutorial) and then assign atdm:mover_door for that whole brush structure. Also you can collect various brushes positioned together in relation to one another as needed, select them all, then assign atdm:mover_door for the group. All the brushes will be children of the atdm:mover_door entity and will rotate and be frobbable, etc. as one unit, as one door. To add further brushes or even model shapes later see the section on ''Adding handles and other items to doors''<br />
<br />
<br />
<br />
&nbsp;<br />
==Customising and Adjusting Door Properties==<br />
<br />
Handles, lockplates, etc. can be added to doors and door properties can be adjusted for rotation, sliding, locking, and more.<br />
<br />
<br />
<br />
===Adding handles and other items to doors===<br />
<br />
You can add handles and other items to doors such that they move correctly with the door whether rotating, sliding, or both and even if the door is not vertical such as a skylight or trapdoor.<br />
<br />
To add a working model door handle (works with both a model door and a brush door):<br />
* Create a door and a handle (the order no longer matters).<br />
* Proceed as for ''Creating a Model Door'' above but instead of the entity ''atdm:mover_door'' use ''atdm:mover_door_handle'' and when you choose a model choose a door handle instead of a door.<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the handle. To do this...<br />
* Select the door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the handle<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* You now have a working door handle with default properties<br />
<br />
<br />
To add a brush to a brush door:<br />
* Select the new brush ''and'' the brush door all together; ''the entity '''must''' be selected '''last'''.''<br />
* Use Menu > Edit > Reparent primitives. This ensures the parent entity adopts the new item(s).<br />
* If you have trouble selecting them in the orthoview because other brushes, etc. get selected then try in the camera view or as a last resort move them temporarily to an open area (but keep them in the same positions relative to each other.) Use Shift + Left Click on new item(s) then Shift + Left Click on main entity. Once they are all selected use the Menu > Edit > Parent. <br />
<br />
<br />
To add ''model'' static items: knockers, hinges, static handles to a Model Door:<br />
* Select item<br />
* Right click in orthoview and select Create Entity then ''entity func_static''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''bind'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''bind''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
<br />
<br />
<br />
To add ''brush'' static items: knockers, hinges, static handles to a Model Door:<br />
* This method is not ideal but it seems to work OK.<br />
* Select the brush.<br />
* Right click in orthoview and select Create Entity then ''atdm:mover_door_handle''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* This brush turns like a handle. To stop it...<br />
* Adding ''rotate 0 0 0'' or disabling the handle script won't help.<br />
* Add a real working handle (as in the section above ''To add a working model door handle...'' and it must be added LAST.)<br />
* If you don't want too see a real working handle added maybe try another tiny brush with the handle function and hide it inside the door?<br />
<br />
===Locking Doors, Keys and Lockpicks===<br />
<br />
To lock a door check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''locked'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unlocked (default)<br />
1 = locked<br />
<br />
If locked it will require an entity that is associated with it to be able to act as a key to unlock it.<br />
<br />
To make a door ''lockpickable'' check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''pickable'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unpickable<br />
1 = pickable (default)<br />
<br />
If pickable then the door can be opened with a lockpick.<br />
<br />
lock_pins property (WIP - UPDATE LATER) SEE ALSO SOUND SECTION FOR PINS.<br />
<br />
<br />
<br />
<br />
<br />
===Open, Partially Open, or Closed Door at Game Start===<br />
<br />
By default, doors are closed at game start. If you want a door to be already open or partially open then do the following.<br />
<br />
<br />
<br />
Already Open Rotating Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Make sure its ''open'' property is set to 1 as above.<br />
* Right click the entity inspector and select ''add property'' <br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* scroll down, select ''start_rotate'' then click OK.<br />
* This adds it to the property list.<br />
* Now select ''start_rotate'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the angle you want in the same form as described in the ''Rotate Direction and Open Angle'' section. So for example, to have a door that has a fully open default ''rotate'' value of 0 90 0 to start only half open you would give it a ''start_rotate'' value of 0 45 0. <br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
Already Open Sliding Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Right click the entity inspector and select ''add property'' <br />
* Make sure its ''open'' property is set to 1<br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder.<br />
* scroll down, select ''start_position'' then click OK. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* This adds it to the property list.<br />
* Now select ''start_position'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the position you want in the same form as described in the ''Sliding (Translation) Amount and Direction'' section. So for example, to have a door that has a fully open default ''translate'' value of 0 50 0 to start only half open you would give it a ''start_position'' value of 0 25 0.<br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Rotation Centre, Pivot, Hinge point===<br />
<br />
The centre of rotation of a door is at the origin point of its entity and the door rotates with reference to the orientation of that origin point, not the world map. See ''Rotate Direction...'' for more about that. This section only deals with the ''position'' of the rotation centre in the door.<br />
<br />
<br />
Model Door Centre of Rotation:<br><br />
The centre of rotation of a model door cannot be changed within Dark Radiant. Because a model door rotates around the centre 'spine' of its back edge this will cause clipping (penetration into solid) as in this example (where the door is set to open to 89 degrees for clarity):<BR>[[Image:modelClipping.jpg]]<BR> So care is needed with placement. You will not normally position a door right next to a wall as in the example but against a shallow frame so clipping will barely be noticeable but either way it can be fixed. You can correct it by adding a translation (see ''Sliding (Translation) Directions'') value of half the door width in the direction of the door handle. This will gently move the door out as it rotates to clear any solid on that side as in this diagram:<br><br />
[[Image:DoorClip.jpg]]<br><br />
Half a door width will typically be about 2. Any 'attachments' such as door handles will still synchronize with the door movement whether the door is rotating, sliding, or both.<br />
<br />
<br />
Brush Door Centre of Rotation:<br><br />
The centre of rotation of a brush door ''can'' be changed. The default origin point of a brush is at its centre. Therefore a default rotating brush door will rotate around its centre when you first create it. So, mappers will commonly need to move that rotation point to a corner or even to some other offset position for example, for an openable window using the door function.<br />
<br />
Put simply, to move the rotation point of a brush door you need to move the entity origin relative to the brush(es.)<br />
<br />
Moving the entity origin (centre of rotation) relative to a brush door:<br />
<br />
* Select the brush door<br />
* Select Vertices mode (Default shortcut key is V or button on top toolbar 'Select Vertices')<br />
* Drag the door's entity origin to the point where you want the door to rotate. This should be on the corner on the leading edge side (the side to where the door is opening.) to avoid clipping as in this diagram....<br />
[[Image:getCorner.jpg]]<br />
* You should now find that door rotates around that point.<br />
<br />
===Rotate Direction and Open Angle===<br />
<br />
By default, rotating doors open anti-clockwise (viewed from above) by 90 degrees from the start orientation. If you want to change this edit the ''rotate'' property in the entity inspector. Don't confuse this ''rotate'' property with the ''rotation'' property. In the entity inspector remember that to see the inherited rotate property you must check the box 'Show inherited properties'.<br />
<br />
The three values shown in the rotate property are degrees from the closed position around Y Z X ''entity origin axes'' (NOT absolute map axes) and so include any start ''rotation''. So the Z value is the axis vertical to the entity origin. If you tilt a model door over in Dark Radiant then its entity origin tilts too so the Z axis is tilted too (with respect to the world map vertical.) So with a normally opening model door if you lay it flat on its back it will open upwards and not rotate around on the floor. But a brush door must be treated differently...<br />
<br />
If you turn a brush door using the normal Dark Radiant rotate tool or the Transform Dialog (accessed via a shortcut key) then it only turns the brush ''relative'' to the entity. So, because the entity origin is by default aligned with the world map then ''in most cases'' you can regard a brush door as rotating with respect to the world map if you wish. But there will be a problem when you come to rotations that are not around the main Y Z X axes of the map, for instance a drawbridge that lowers down to the south east. You might think you can combine Y Z X values to get the result you want - and this can be done (for south east use 45 45 90) but it is a bit of a kludge and the drawbridge twists eccentrically as it lowers (though it arrives correctly!) So for such cases you need to turn the entity itself so its start position is facing south east. You can then just use 0 0 90 to lower the drawbridge perfectly because its Y axis is now pointing south east. To turn the entity you must type or paste the rotation values in directly because using the Dark Radiant rotation tool or Transform Dialog will only turn the brush not the entity. The values are rather lengthy (south east is 0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1) so probably the easiest way is to create a temporary model door, turn it how you want, then select its rotation property. If you now deselect and re-select your brush door then that property will still be in the entity inspector input box and you need only click the check(tick) box to add it to the brush door. NOTE: ''neither the entity nor the brush will show as turned in Dark Radiant.'' Only the rotation property in the entity inspector will indicate the orientation. Instead of a rotated ''construction'', regard it as a rotation ''instruction'' for when the map is compiled.<br />
<br />
These are the rotate property fields. Remember they are all with reference to the door's entity ''not'' the world map. Since there is no absolute frame of reference I indicate them here as if the entity is aligned with the world map axes...<br />
<br />
* Positive Y = Open clockwise (Dark Radiant grid front view, looking north)<br />
* Negative Y = Open anti-clockwise (Dark Radiant grid front view, looking north)<br />
<br />
* Positive Z = Open anti-clockwise (Dark Radiant grid top view, looking down)<br />
* Negative Z = Open clockwise (Dark Radiant grid top view, looking down)<br />
<br />
* Positive X = Open anti-clockwise (Dark Radiant grid side view, looking west)<br />
* Negative X = Open clockwise (Dark Radiant grid side view, looking west)<br />
<br />
The values are in the range -179 to +180. Positive values give an anti-clockwise opening rotation (looking down from above) and negative values give a clockwise opening rotation. The value 180 is unique in that it continues in an anti-clockwise rotation when closing rather than returning clockwise so might be used if you can think of some object that might need such a motion when frobbed!<br />
<br />
Edit the rotate value by selecting it and using the input box at the bottom and clicking the check(tick) button. That will change the angle the door will open to. Note that the line with the original default of 0 90 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Examples:<br />
* 0 90 0 = Opens anti-clockwise round the entity's 'vertical' to 90 degrees - typical default vertical door.<br />
* 0 0 90 = Lowers a drawbridge from the entity 'vertical' to horizontal.<br />
* 0 0 -45 = Opens clockwise by 45 degrees viewed from the east side. This might suit a skylight in a sloping roof.<br />
<br />
Combinations can be used and also combined with slide motions (see '''Sliding (Translation) Directions''') to produce exotic and useful motions. A door opening against an upward-sloping floor can thus have a ''lifting hinge'' and raise up slightly to clear the floor; a door can rotate towards you and slide back to one side very effectively.<br />
<br />
<br />
<br />
<br />
<br />
===Sliding (Translation) Amount and Direction===<br />
<br />
By default a Dark Mod door will rotate open. For most sliding doors you want to stop them rotating as well as make them slide. You cannot delete (remove) the ''rotate'' property - you have to set the ''rotate'' property to 0 0 0 to stop a door rotating (see ''Rotate Direction and Open Angle''.)<br />
<br />
Now edit the ''translate'' property value by selecting it (remember to have inherited properties box checked) and using the input box at the bottom and clicking the check(tick) button. That will change the distance the door will slide to. Note that the line with the original default of 0 0 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Typically (but not always) you will want your sliding door to slide the width of the door. The three values in the translate property by default are 0 0 0 and are X Y Z ''absolute map'' values (irrespective of door orientation) where...<br />
<br />
<br />
* Positive X = Slide East (Right side of Dark Radiant grid in top view)<br />
* Negative X = Slide West (Left side of Dark Radiant grid in top view)<br />
* Positive Y = Slide North (top of Dark Radiant grid in top view)<br />
* Negative Y = Slide South (bottom of Dark Radiant grid in top view)<br />
* Positive Z = Slide Up (Top of Dark Radiant grid in side views)<br />
* Negative Z = Slide Down (Bottom of Dark Radiant grid in side views)<br />
<br />
So for a 50 unit wide door you want to slide fully to the east you would use 50 0 0 for the translate property values. A 100 unit portcullis sliding vertically up would need 0 0 100 to be fully raised.<br />
<br />
<br />
<br />
===Sounds and Sound Propagation through Doors and Doorways===<br />
<br />
Sound propagation relies on visportals. For details study [[Sound Propagation: Part 1]] and [[Sound Propagation: Part 2]] as well as [[Visportals]] This tutorial will just cover the relevant sound and sound propagation ''properties'' of doors. If you set the ''show inherited properties'' box in the entity inspector you can see them as described here.<br />
<br />
The sound of doors opening and closing is set in the snd_open and snd_close properties. You can silence them by setting the following properties as shown:<br />
<br />
''snd_open null''<br><br />
''snd_close null''<br />
<br />
Don't just use a dash - as it seems to cause a sound of its own.<br />
<br />
''snd_locked''<br><br />
The sound played when a player tries to open a locked door.<br />
<br />
''snd_unlock string''<br><br />
The sound played when a player unlocks a door.<br />
<br />
''loss_open''<br><br />
Drop in sound volume in dB when going through an open door. (default 1dB)<br />
<br />
''loss_closed''<br><br />
Drop in sound volume in dB when going through a closed door. (default 15dB) You would want to set this very high to block all sound with a thick door but very low for a barred gate for example.<br />
<br />
''loss_double_open''<br><br />
Drop in sound volume in dB when going through double doors when only one is open. (default 1dB)<br />
<br />
There are also various sound properties for lockpicking:<br><br />
''snd_lockpick_pin_1 through 14'' and ''snd_lockpick_pin_success''<br />
<br />
<br />
<br />
<br />
===Speed of Door Opening and Closing===<br />
<br />
Rotating Door Speed:<br><br />
At the time of writing, the time a rotating door takes to open or close is set in the ''move_time'' property whatever its maximum open angle. So with rotation set at say 150 degrees the door just opens faster than at say 80 degrees. This is likely to be changed to a constant angular velocity so check to see if there a new property added if the following no longer works. The problem is that if an interruptable (see Extra Notes) door is frobbed while in motion it stops; another frob will reverse the motion - so even if the door is only open a crack it will still take the full time to close and vice versa.<br />
<br />
To change the time a rotating door takes to open or close, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''move_time''<br />
* Edit the second line of the input box ''below'' the properties window to the time you want.<br />
* The time is in seconds and decimal fractions can be used.<br />
* The default is 1 second and if set to this then the door opens and closes in one second whatever the maximum open angle, great or small.<br />
<br />
<br />
Sliding Door Speed:<br><br />
The speed of a sliding door is set in the ''translate_speed'' property. To add this, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''translate_speed''<br />
* Edit the second line of the input box ''below'' the properties window to the speed you want.<br />
* The speed is in Dark Radiant grid units per second.<br />
* The default is 0 and if set to this then the door slides open in one second whatever the distance, great or small.<br />
* CAUTION: If you later change the door back to a rotating door then delete the ''translate_speed'' property or ensure it is set to 0 as (at the time of writing but this will be fixed) a bug makes rotating doors open and close instantly. (Note: you can still mix sliding with rotating but check - this bug might only be if ''translate'' is set to 0 0 0)<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Visportals and Doors===<br />
<br />
A visportal face surrounded by solid at its edges and in contact with a door is closed when the door is closed and enabled when the door is open. In most cases you will place a visportal in contact with a working door unless you can see through the door (such as a true glass door or barred gate.) For full details see [[Visportals]]<br />
<br />
<br />
<br />
<br />
&nbsp;<br />
==Extra Notes==<br />
The property ''interruptable'' determines whether a door can be stopped by frobbing while it is opening or closing.<br />
<br />
The property "editor_var master_open" is for if you have associated doors for opening then one should serve as master. Presumably for such as double doors opening and closing together. At the time of writing I have not found any further information on this and might not yet be implemented.<br />
<br />
The property "editor_var master_lock" is like "associate_master_open'' above but for locks.<br />
<br />
''func_darkmod_door'' is no longer used (just in case you come across it in the Dark Mod forums or wiki.) The Doom func_door is still available but for Dark Mod, atdm:mover_door is the entity to use.<br />
<br />
<br />
[[Category:Tutorial]]<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2697Doors2007-05-29T18:49:44Z<p>Sparhawk: /* Adding handles and other items to doors */</p>
<hr />
<div>''Written by Fidcal''<br />
<br />
==Introduction==<br />
<br />
This tutorial explains how to put doors into your Dark Mod map using Dark Radiant and adjust them and their properties.<br />
<br />
Quick way for the moderately knowledgeable to skip the detail and just get an ordinary unlocked door in your map as fast as possible you need only...<br />
<br />
* Create a model door<br />
* Change it from func_static to atdm:mover_door<br />
* Create a door handle (must be created ''after'' the door!)<br />
* Change it from func_static to atdm:mover_door_handle<br />
* Add the ''door_body'' property to the handle and give it the name of the door<br />
* To open clockwise change the ''rotate'' property from 0 90 0 to 0 -90 0.<br />
<br />
<br />
The rest of this tutorial assumes very little prior knowledge so is suitable for beginners even without Doom editing experience. You need to know:<br />
<br />
<br />
* 'entity inspector' is available from the view menu or shortcut key.<br />
* 'orthoview' means any of the xyz top, side, front, grid views<br />
* Up, down, left, and right in Dark Radiant's ''top'' orthoview are regarded here as the standard map directions of North, South, East, and West where useful for clarity.<br />
* Where the term ''brush'' is used with a door it mostly also applies to a door made up of a group of brushes and/or patches.<br />
* Where the term ''door'' is used it often will also apply to any object you wish to rotate when frobbed, for instance an openable window, box lid, or even more exotic objects that the imaginative mapper might conceive like a signal, engine part, toy, or whatever. So long as it needs to turn or slide just a fixed amount when frobbed then return when frobbed again then the following applies.<br />
<br />
<br />
<br />
&nbsp;<br />
==Door types==<br />
<br />
All tangible objects in Dark Mod are ''entities'' having either a pre-made model shape or else brush/patch(es). So there are two ways to create a door in Dark Radiant: as a model door or a textured brush door (or a hybrid of the two.)<br />
<br />
Models are ready made door objects but cannot within Dark Radiant (at the time of writing) be resized, rescaled, or retextured, cropped or clipped whereas brushes are very flexible in that respect and can be worked into custom shapes for your map, including secret doors that blend into walls and other surfaces.<br />
<br />
Although many models are already assigned to entities in Dark Radiant's right click create entity list, all door models are (at the time of writing) in the create models list and are automatically assigned to static entities by default. So these are immediately useable as static doors or can be quickly made into functioning doors (see later) by re-parenting them to a functioning door entity.<br />
<br />
Remember also that door functions may be applied to objects other than doors for instance to openable windows, drawbridges, gates, in fact anything that needs a partial rotation or slide when frobbed then return when frobbed again such as a signal device.<br />
<br />
<br />
<br />
&nbsp;<br />
==Creating a Door==<br />
<br />
Put simply, to make a door you will be creating an 'entity with model' or 'entity with brush' or some variation thereof.<br />
<br />
===Creating a Model Door===<br />
<br />
There are two approaches to making a model door; the first is simpler for a working door; the second if you just want a static door. But both routes can produce a fully working door.<br />
<br />
First approach:<br />
<br />
* Create any temporary brush<br />
* Right click in orthoview and select Create Entity then atdm:mover_door.<br />
* Left lick the model name line in the entity inspector.<br />
* Below it on the Entity Inspector panel you should now see a button 'Choose Model'<br />
* Left click it, select a door model from the darkmod group.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* The temporary brush was deleted.<br />
* You now have a working door with default properties.<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Alternatively you can do it the other way round:<br />
<br />
* Right click in the orthoview, select Create Model then darkmod and select a door.<br />
* Note that you can left drag the image in the Choose Model dialog to rotate it around.<br />
* Click OK and you have a static door.<br />
* If you want to make it work (openable, frobbable) then...<br />
* Select the entity inspector,<br />
* Select the top classname line so it highlights<br />
* Select the func_static line in the input box + check(tick) button ''below'' the properties window.<br />
* Edit func_static to atdm:mover_door<br />
* Click the check(tick) button<br />
* You now have a working door with default properties<br />
* To add a handle and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
<br />
===Creating a Textured Brush Door===<br />
<br />
The simplest brush door:<br />
<br />
* Tip : If unsure of size then you might insert a temporary human AI first to get a sense of height.<br />
* Drag out a new brush to the size required, eg, a seven foot high door is 84" x 1.1 = about 90 units in Dark Radiant.<br />
* Give it a door texture from the texture browser (or wall texture for a secret door)<br />
* Right click in orthoview and select Create Entity then atdm:mover_door<br />
* You now have a default door that rotates around its centre.<br />
* To move the rotation point to the door edge and other adjustments, see ''Customising and Adjusting Door Properties'' later if needed.<br />
<br />
<br />
Multi-brush doors:<br />
<br />
More complex multi-brush doors can be created using the clipper tool, CSG, etc. (not covered in this tutorial) and then assign atdm:mover_door for that whole brush structure. Also you can collect various brushes positioned together in relation to one another as needed, select them all, then assign atdm:mover_door for the group. All the brushes will be children of the atdm:mover_door entity and will rotate and be frobbable, etc. as one unit, as one door. To add further brushes or even model shapes later see the section on ''Adding handles and other items to doors''<br />
<br />
<br />
<br />
&nbsp;<br />
==Customising and Adjusting Door Properties==<br />
<br />
Handles, lockplates, etc. can be added to doors and door properties can be adjusted for rotation, sliding, locking, and more.<br />
<br />
<br />
<br />
===Adding handles and other items to doors===<br />
<br />
You can add handles and other items to doors such that they move correctly with the door whether rotating, sliding, or both and even if the door is not vertical such as a skylight or trapdoor.<br />
<br />
To add a working model door handle (works with both a model door and a brush door):<br />
* Create a door and a handle (the order no longer matters).<br />
* Proceed as for ''Creating a Model Door'' above but instead of the entity ''atdm:mover_door'' use ''atdm:mover_door_handle'' and when you choose a model choose a door handle instead of a door.<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the handle. To do this...<br />
* Select the door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the handle<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* You now have a working door handle with default properties<br />
<br />
<br />
To add a brush to a brush door:<br />
* Select the new brush ''and'' the brush door all together; ''the entity '''must''' be selected '''last'''.''<br />
* Use Menu > Edit > Parent. This ensures the parent entity adopts the new item(s).<br />
* If you have trouble selecting them in the orthoview because other brushes, etc. get selected then try in the camera view or as a last resort move them temporarily to an open area (but keep them in the same positions relative to each other.) Use Shift + Left Click on new item(s) then Shift + Left Click on main entity. Once they are all selected use the Menu > Edit > Parent. <br />
<br />
<br />
To add ''model'' static items: knockers, hinges, static handles to a Model Door:<br />
* Select item<br />
* Right click in orthoview and select Create Entity then ''entity func_static''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''bind'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''bind''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
<br />
<br />
<br />
To add ''brush'' static items: knockers, hinges, static handles to a Model Door:<br />
* This method is not ideal but it seems to work OK.<br />
* Select the brush.<br />
* Right click in orthoview and select Create Entity then ''atdm:mover_door_handle''<br />
* Position it where you wish on your door.<br />
* To synchronize this with your particular door you need to add the property ''door_body'' and the individual door name to the brush entity. To do this...<br />
* Select the model door.<br />
* In the entity inspector, select the ''name'' line<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Highlight the name and copy it to the Windows clipboard (Menu > Edit or Ctrl + C)<br />
* Deselect the door with Esc<br />
* Select the brush entity<br />
* Select the top line in the input box ''below'' the properties window.<br />
* Edit it to read ''door_body''.<br />
* Select the bottom line in the input box ''below'' the properties window.<br />
* Paste in the door name (Menu > Edit or Ctrl + V)<br />
* Click the check(tick) button<br />
* This brush turns like a handle. To stop it...<br />
* Adding ''rotate 0 0 0'' or disabling the handle script won't help.<br />
* Add a real working handle (as in the section above ''To add a working model door handle...'' and it must be added LAST.)<br />
* If you don't want too see a real working handle added maybe try another tiny brush with the handle function and hide it inside the door?<br />
<br />
===Locking Doors, Keys and Lockpicks===<br />
<br />
To lock a door check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''locked'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unlocked (default)<br />
1 = locked<br />
<br />
If locked it will require an entity that is associated with it to be able to act as a key to unlock it.<br />
<br />
To make a door ''lockpickable'' check the ''show inherited properties'' in the entity inspector for a ''atdm:mover_door'' entity and you should see the ''pickable'' property. Select it and in the input box below the properties you can change its value:<br />
<br />
0 = unpickable<br />
1 = pickable (default)<br />
<br />
If pickable then the door can be opened with a lockpick.<br />
<br />
lock_pins property (WIP - UPDATE LATER) SEE ALSO SOUND SECTION FOR PINS.<br />
<br />
<br />
<br />
<br />
<br />
===Open, Partially Open, or Closed Door at Game Start===<br />
<br />
By default, doors are closed at game start. If you want a door to be already open or partially open then do the following.<br />
<br />
<br />
<br />
Already Open Rotating Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Make sure its ''open'' property is set to 1 as above.<br />
* Right click the entity inspector and select ''add property'' <br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* scroll down, select ''start_rotate'' then click OK.<br />
* This adds it to the property list.<br />
* Now select ''start_rotate'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the angle you want in the same form as described in the ''Rotate Direction and Open Angle'' section. So for example, to have a door that has a fully open default ''rotate'' value of 0 90 0 to start only half open you would give it a ''start_rotate'' value of 0 45 0. <br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
Already Open Sliding Door:<br />
* Select the door.<br />
* Select the entity inspector<br />
* Check ''show inherited properties''<br />
* Select the ''open'' property<br />
* Edit the value to 1 in the input box below and click the check button<br />
* The door will now be fully open at game start.<br />
<br />
* If you want it only partly open:<br />
* Right click the entity inspector and select ''add property'' <br />
* Make sure its ''open'' property is set to 1<br />
* Click the + sign on the left of the top line where atdm:mover_door is listed to open the folder.<br />
* scroll down, select ''start_position'' then click OK. (if atdm:mover_door is not listed then the entity was likely changed from eg, func_static. If so, save the map and reload to update the add property list)<br />
* This adds it to the property list.<br />
* Now select ''start_position'' in the property list.<br />
* Edit the bottom line of the input box ''below'' the properties window to the position you want in the same form as described in the ''Sliding (Translation) Amount and Direction'' section. So for example, to have a door that has a fully open default ''translate'' value of 0 50 0 to start only half open you would give it a ''start_position'' value of 0 25 0.<br />
* In a similar way add the property ''first_frob_open".<br />
* Set it to 1 and a partly open door should then open fully on the first frob.<br />
* Set it to 0 and a partly open door should close on the first frob.<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Rotation Centre, Pivot, Hinge point===<br />
<br />
The centre of rotation of a door is at the origin point of its entity and the door rotates with reference to the orientation of that origin point, not the world map. See ''Rotate Direction...'' for more about that. This section only deals with the ''position'' of the rotation centre in the door.<br />
<br />
<br />
Model Door Centre of Rotation:<br><br />
The centre of rotation of a model door cannot be changed within Dark Radiant. Because a model door rotates around the centre 'spine' of its back edge this will cause clipping (penetration into solid) as in this example (where the door is set to open to 89 degrees for clarity):<BR>[[Image:modelClipping.jpg]]<BR> So care is needed with placement. You will not normally position a door right next to a wall as in the example but against a shallow frame so clipping will barely be noticeable but either way it can fixed. You can correct it by adding a translation (see ''Sliding (Translation) Directions'') value of half the door width in the direction of the door handle. This will gently move the door out as it rotates to clear any solid on that side as in this diagram:<br><br />
[[Image:DoorClip.jpg]]<br><br />
Half a door width will typically be about 2. Any 'attachments' such as door handles will still synchronize with the door movement whether the door is rotating, sliding, or both.<br />
<br />
<br />
Brush Door Centre of Rotation:<br><br />
The centre of rotation of a brush door ''can'' be changed. The default origin point of a brush is at its centre. Therefore a default rotating brush door will rotate around its centre when you first create it. So, mappers will commonly need to move that rotation point to a corner or even to some other offset position for example, for an openable window using the door function.<br />
<br />
Put simply, to move the rotation point of a brush door you need to move the entity origin relative to the brush(es) or vice versa.<br />
<br />
Moving the entity origin (centre of rotation) relative to a brush door:<br />
<br />
* Tip: easy way to get the coordinates of the point where you want to move the centre of rotation:<br />
* Deselect door.<br />
* Select an orthoview through the rotation axis, eg, top view if normal door rotating around a vertical axis.<br />
* Drag out a small temporary brush roughly at the point you want the rotation.<br />
* Zoom in if necessary and reduce the size of the temporary brush very small say, to 2 x 2 grid units.<br />
* Drag it so its centre is at the point where you want the door to rotate. This should be on the corner on the leading edge side (the side to where the door is opening.) to avoid clipping as in this diagram....<br />
[[Image:getCorner.jpg]]<br />
* Right click orthoview and select ''convert to func_static'' to give it an entity origin<br />
* In the entity inspector click the origin line<br />
* Select the input box + check(tick) button ''below'' the properties window.<br />
* Drag the mouse over the origin coordinates to highlight.<br />
* Copy the coordinates to the Windows clipboard (edit menu or Ctrl + C)<br />
* Click orthoview and hit backspace to delete the temporary brush.<br />
* Select the door.<br />
* In the entity inspector click the origin line<br />
* Select the input box + check(tick) button ''below'' the properties window.<br />
* Copy the coordinates back from the Windows clipboard (edit menu or Ctrl + V)<br />
* Click on the check(tick) button to confirm and apply the new coordinates.<br />
* In the orthoview you should see the origin icon move to the new position.<br />
* You should now find that door rotates around that point.<br />
<br />
<br />
<br />
<br />
<br />
===Rotate Direction and Open Angle===<br />
<br />
By default, rotating doors open anti-clockwise (viewed from above) by 90 degrees from the start orientation. If you want to change this edit the ''rotate'' property in the entity inspector. Don't confuse this ''rotate'' property with the ''rotation'' property. In the entity inspector remember that to see the inherited rotate property you must check the box 'Show inherited properties'.<br />
<br />
The three values shown in the rotate property are degrees from the closed position around Y Z X ''entity origin axes'' (NOT absolute map axes) and so include any start ''rotation''. So the Z value is the axis vertical to the entity origin. If you tilt a model door over in Dark Radiant then its entity origin tilts too so the Z axis is tilted too (with respect to the world map vertical.) So with a normally opening model door if you lay it flat on its back it will open upwards and not rotate around on the floor. But a brush door must be treated differently...<br />
<br />
If you turn a brush door using the normal Dark Radiant rotate tool or the Transform Dialog (accessed via a shortcut key) then it only turns the brush ''relative'' to the entity. So, because the entity origin is by default aligned with the world map then ''in most cases'' you can regard a brush door as rotating with respect to the world map if you wish. But there will be a problem when you come to rotations that are not around the main Y Z X axes of the map, for instance a drawbridge that lowers down to the south east. You might think you can combine Y Z X values to get the result you want - and this can be done (for south east use 45 45 90) but it is a bit of a kludge and the drawbridge twists eccentrically as it lowers (though it arrives correctly!) So for such cases you need to turn the entity itself so its start position is facing south east. You can then just use 0 0 90 to lower the drawbridge perfectly because its Y axis is now pointing south east. To turn the entity you must type or paste the rotation values in directly because using the Dark Radiant rotation tool or Transform Dialog will only turn the brush not the entity. The values are rather lengthy (south east is 0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1) so probably the easiest way is to create a temporary model door, turn it how you want, then select its rotation property. If you now deselect and re-select your brush door then that property will still be in the entity inspector input box and you need only click the check(tick) box to add it to the brush door. NOTE: ''neither the entity nor the brush will show as turned in Dark Radiant.'' Only the rotation property in the entity inspector will indicate the orientation. Instead of a rotated ''construction'', regard it as a rotation ''instruction'' for when the map is compiled.<br />
<br />
These are the rotate property fields. Remember they are all with reference to the door's entity ''not'' the world map. Since there is no absolute frame of reference I indicate them here as if the entity is aligned with the world map axes...<br />
<br />
* Positive Y = Open clockwise (Dark Radiant grid front view, looking north)<br />
* Negative Y = Open anti-clockwise (Dark Radiant grid front view, looking north)<br />
<br />
* Positive Z = Open anti-clockwise (Dark Radiant grid top view, looking down)<br />
* Negative Z = Open clockwise (Dark Radiant grid top view, looking down)<br />
<br />
* Positive X = Open anti-clockwise (Dark Radiant grid side view, looking west)<br />
* Negative X = Open clockwise (Dark Radiant grid side view, looking west)<br />
<br />
The values are in the range -179 to +180. Positive values give an anti-clockwise opening rotation (looking down from above) and negative values give a clockwise opening rotation. The value 180 is unique in that it continues in an anti-clockwise rotation when closing rather than returning clockwise so might be used if you can think of some object that might need such a motion when frobbed!<br />
<br />
Edit the rotate value by selecting it and using the input box at the bottom and clicking the check(tick) button. That will change the angle the door will open to. Note that the line with the original default of 0 90 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Examples:<br />
* 0 90 0 = Opens anti-clockwise round the entity's 'vertical' to 90 degrees - typical default vertical door.<br />
* 0 0 90 = Lowers a drawbridge from the entity 'vertical' to horizontal.<br />
* 0 0 -45 = Opens clockwise by 45 degrees viewed from the east side. This might suit a skylight in a sloping roof.<br />
<br />
Combinations can be used and also combined with slide motions (see '''Sliding (Translation) Directions''') to produce exotic and useful motions. A door opening against an upward-sloping floor can thus have a ''lifting hinge'' and raise up slightly to clear the floor; a door can rotate towards you and slide back to one side very effectively.<br />
<br />
<br />
<br />
<br />
<br />
===Sliding (Translation) Amount and Direction===<br />
<br />
By default a Dark Mod door will rotate open. For most sliding doors you want to stop them rotating as well as make them slide. You cannot delete (remove) the ''rotate'' property - you have to set the ''rotate'' property to 0 0 0 to stop a door rotating (see ''Rotate Direction and Open Angle''.)<br />
<br />
Now edit the ''translate'' property value by selecting it (remember to have inherited properties box checked) and using the input box at the bottom and clicking the check(tick) button. That will change the distance the door will slide to. Note that the line with the original default of 0 0 0 will still be there but your new entry will be added on a separate line and that is the one that will work in the game. CAUTION: when adjusting later make sure you have your new line selected and not the original! If you do it will appear to change but your first setting will remain unaltered.<br />
<br />
Typically (but not always) you will want your sliding door to slide the width of the door. The three values in the translate property by default are 0 0 0 and are X Y Z ''absolute map'' values (irrespective of door orientation) where...<br />
<br />
<br />
* Positive X = Slide East (Right side of Dark Radiant grid in top view)<br />
* Negative X = Slide West (Left side of Dark Radiant grid in top view)<br />
* Positive Y = Slide North (top of Dark Radiant grid in top view)<br />
* Negative Y = Slide South (bottom of Dark Radiant grid in top view)<br />
* Positive Z = Slide Up (Top of Dark Radiant grid in side views)<br />
* Negative Z = Slide Down (Bottom of Dark Radiant grid in side views)<br />
<br />
So for a 50 unit wide door you want to slide fully to the east you would use 50 0 0 for the translate property values. A 100 unit portcullis sliding vertically up would need 0 0 100 to be fully raised.<br />
<br />
<br />
<br />
===Sounds and Sound Propagation through Doors and Doorways===<br />
<br />
Sound propagation relies on visportals. For details study [[Sound Propagation: Part 1]] and [[Sound Propagation: Part 2]] as well as [[Visportals]] This tutorial will just cover the relevant sound and sound propagation ''properties'' of doors. If you set the ''show inherited properties'' box in the entity inspector you can see them as described here.<br />
<br />
The sound of doors opening and closing is set in the snd_open and snd_close properties. You can silence them by setting the following properties as shown:<br />
<br />
''snd_open null''<br><br />
''snd_close null''<br />
<br />
Don't just use a dash - as it seems to cause a sound of its own.<br />
<br />
''snd_locked''<br><br />
The sound played when a player tries to open a locked door.<br />
<br />
''snd_unlock string''<br><br />
The sound played when a player unlocks a door.<br />
<br />
''loss_open''<br><br />
Drop in sound volume in dB when going through an open door. (default 1dB)<br />
<br />
''loss_closed''<br><br />
Drop in sound volume in dB when going through a closed door. (default 15dB) You would want to set this very high to block all sound with a thick door but very low for a barred gate for example.<br />
<br />
''loss_double_open''<br><br />
Drop in sound volume in dB when going through double doors when only one is open. (default 1dB)<br />
<br />
There are also various sound properties for lockpicking:<br><br />
''snd_lockpick_pin_1 through 14'' and ''snd_lockpick_pin_success''<br />
<br />
<br />
<br />
<br />
===Speed of Door Opening and Closing===<br />
<br />
Rotating Door Speed:<br><br />
At the time of writing, the time a rotating door takes to open or close is set in the ''move_time'' property whatever its maximum open angle. So with rotation set at say 150 degrees the door just opens faster than at say 80 degrees. This is likely to be changed to a constant angular velocity so check to see if there a new property added if the following no longer works. The problem is that if an interruptable (see Extra Notes) door is frobbed while in motion it stops; another frob will reverse the motion - so even if the door is only open a crack it will still take the full time to close and vice versa.<br />
<br />
To change the time a rotating door takes to open or close, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''move_time''<br />
* Edit the second line of the input box ''below'' the properties window to the time you want.<br />
* The time is in seconds and decimal fractions can be used.<br />
* The default is 1 second and if set to this then the door opens and closes in one second whatever the maximum open angle, great or small.<br />
<br />
<br />
Sliding Door Speed:<br><br />
The speed of a sliding door is set in the ''translate_speed'' property. To add this, make sure the door is selected then...<br />
<br />
* Right click the entity inspector and check ''show inherited properties''<br />
* Scroll down, select ''translate_speed''<br />
* Edit the second line of the input box ''below'' the properties window to the speed you want.<br />
* The speed is in Dark Radiant grid units per second.<br />
* The default is 0 and if set to this then the door slides open in one second whatever the distance, great or small.<br />
* CAUTION: If you later change the door back to a rotating door then delete the ''translate_speed'' property or ensure it is set to 0 as (at the time of writing but this will be fixed) a bug makes rotating doors open and close instantly. (Note: you can still mix sliding with rotating but check - this bug might only be if ''translate'' is set to 0 0 0)<br />
<br />
<br />
<br />
<br />
<br />
<br />
===Visportals and Doors===<br />
<br />
A visportal face surrounded by solid at its edges and in contact with a door is closed when the door is closed and enabled when the door is open. In most cases you will place a visportal in contact with a working door unless you can see through the door (such as a true glass door or barred gate.) For full details see [[Visportals]]<br />
<br />
<br />
<br />
<br />
&nbsp;<br />
==Extra Notes==<br />
The property ''interruptable'' determines whether a door can be stopped by frobbing while it is opening or closing.<br />
<br />
The property "editor_var master_open" is for if you have associated doors for opening then one should serve as master. Presumably for such as double doors opening and closing together. At the time of writing I have not found any further information on this and might not yet be implemented.<br />
<br />
The property "editor_var master_lock" is like "associate_master_open'' above but for locks.<br />
<br />
''func_darkmod_door'' is no longer used (just in case you come across it in the Dark Mod forums or wiki.) The Doom func_door is still available but for Dark Mod, atdm:mover_door is the entity to use.<br />
<br />
<br />
[[Category:Tutorial]]<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2291Inventory2007-02-21T13:59:37Z<p>Sparhawk: </p>
<hr />
<div>This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an error message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
* '''Cursor''' An inventory can have multiple cursors. This means that you can create objects which make use of a given inventory, by acquiring a cursor for it. This way, you can implement different HUDs or GUIs which can show different parts of the inventory in different places even though all the items are in one single inventory. For any given object you can not rely to be in a particular inventory, even though you might have a cursor pointing to it. That's because it might be that some other object may have already removed that object, or added another one. Thus, you should always get the pointer to a given item, when you access it, and don't store it's position somewhere external.<br />
<br />
== Spawnargs ==<br />
<br />
;'''inv_category''' | string<br />
:Specifies the category that the object should be filed under. This allows for player convenience and also is needed for stackable items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_name''' | string<br />
:Specifies the name the object should display when it is activated in the inventory. Keep in mind that the display name and the category together are used to determine, if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you create to "Health Potion" items, but with different categories, they are treated as different items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_icon''' | D3 path to icon<br />
:Points to an icon that is to be displayed when the object is selected in the inventory. This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
;'''inv_stackable''' | [0/1]<br />
:Determines wether an item is an individual or can be a stack of similar objects. An example would be the various potions. The player can pick up more than one health potion, but in the inventory he will only get one item with a counter. Keep in mind though, that a stack of gold coins is not per se stackable, because usually it will be only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
;'''inv_item_id''' | string<br />
:This key can be set by the mapper to an arbitrary value. This is needed if the mapper wants to implement custom behaviour and he uniquily need to identfy an item or a group of items. Normally the mapper could also use the inv_name for this key, but this doesn't allow the additional flexibillity. For example a mapper can create a fake health potion which shows up in the inventory just like a regular one, with the same name but a different map model. So if the player picks this bottle up, because he doesn't look carefull and thinks he got a health potion, he might have aquired a real one, while this one actually may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This will of course only work with additional scripting, because the mapper must know what to do with it. In this case the mapper might set a flag on the callback, and the next time the player uses a health potion, the action is triggered.<br />
<br />
;'''inv_count''' | <N><br />
:Determines the number of items this represents. This is only needed for items where stackable is 1, otherwise it is set to 0. Als the option for stackable must always precede the count, otherwise the count is set to 0.<br />
<br />
;'''inv_droppable''' | [0/1]<br />
:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items, since they will have no representation after they were put into the inventory.<br />
<br />
;'''inv_delete''' | [0/1]<br />
:Determines if an anonymous object can be deleted, after it was put into the inventory. This is advisable, because the entity will stay in memory and a mapper could still access it via scripting. If the mapper decides that an item will no longer be accessed after it has been acquired, this key should be set to 1. This can affect loading time of saved games, as entities, that are no longer needed, don't need to be saved and restored. <br />
:If the mapper also creates entities on the fly, with the help of scripts, it might better to set this flag on appropriate objects to free up the limited number of entities a map can hold. The usuals candidates for this flag are all the regular loot items, because they wont be used anymore after they have been found (lik coins, purses, etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since droppabale items must be turned into entities again to be placed in the map.<br />
<br />
;'''inv_loot_type''' | [ 0 | 1 | 2 | 3 ]<br />
:* 0 = No lootitem (default)<br />
:* 1 = Jewelry/Gems<br />
:* 2 = Gold<br />
:* 3 = Goods<br />
:This has to be set in order to define what kind of item it is and if it is a loot item, which category of loot it should account for.<br />
<br />
;'''inv_loot_value''' | <N><br />
:Determines the amount of loot this item accounts for. This value is ignore if it is set on an item, which is of loot_type = 0.<br />
<br />
;'''inv_map_start''' | [0|1]<br />
:Determines wether this object should be assigned to an inventory at map start.<br />
<br />
;'''inv_target''' | <entityname><br />
:If the item should be assigned to an entity at map start, this should get the name of the entity who shold recive it. To give an item to the player, you would use "player1" as the name, because this is the name that the player entity gets by default. If inv_map_start is not set or set to 0, then this key doesn't need to be set and is ignored. Since the name can be arbitrary, this means of course, that you can also give it to an AI, which the player later on meets. This should not be confused with loot, that is to be attached to an AI though. If you attach a purse or a key to an AI, which the player can frob later on, then it doesn't need to get this set, because such things will not be stored in the inventory. You could assign such things to an chest though, to give the objects to the player when he opens it. This is not directly support though, because it is assumed that chests will be filled with real objects, like TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
;'''inv_hud''' | <hudfilename><br />
: If this key is set it should point to a GUI file, which defines the hud for this particular item. As an example, you can look at the loot.hud, which implements a custom hud that does not use the normal display for items. The mapper is responsible to maintain the state for such an item on his own. In order to do this, there is an initialization message sent to the specified script and other messages as well like selecting or deselecting an item.In order to make this work, the mapper must write a script and assign this script to the key "scriptobject" on the entity. This will automatically launch that script when the entity is spawned,. If the messagefunctions are not implemented the item will show up as an empty slot on the inventory. A detailed description how to operate a custom hud will be described in the scripting section on this article.<br />
<br />
;'''inv_hud_layer''' | int | layernumber<br />
: If a custom hud is used for an item by setting the key "inv_hud", this key can be set to specify a layernumber that the hud should be displayed with. Normally this value can be set to 0 or left blank when using the default screen for the player, but for huds on other objects in the map, this might be needed.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
== CVARs ==<br />
<br />
The following cvars can be used to modify the behaviour of some inventory properties. Some of them are probably only of interest to modders, while others are also of interest to<br />
players and might be added to a customization menu.<br />
<br />
;'''tdm_inv_hud_file''' | string | default "guis/inv.gui"<br />
:Specifies the gui file that should be used for the inventory. this can be changed for mods, that wish to implement a different GUI, or provide alternative skins for the player.<br />
<br />
;'''tdm_inv_loot_hud''' | string | default "guis/loot.gui"<br />
:Specifies the gui file that should be used for the loot slot in the inventory. Since custom huds are now supported for different items, this cvar is no longer needed and might be removed later.<br />
<br />
;'''tdm_inv_loot_group''' | string | default "Loot"<br />
:Specifies the default category name for teh loot objects. This is probably not used and changing it has no effect.<br />
<br />
;'''tdm_inv_group_mode''' | int | default "0"<br />
:This defines how the grouping should work. The following options are available:<br />
:* 0 = ungrouped inventory (T1/T2 style)<br />
:* 1 = grouped inventory<br />
:''''ungrouped'''' means that you can cycle through the inventory one after the other. This does not affect the NextCategory/PrevCategory keys and you can still use them. <br />
:''''grouped'''' means that you just cycle through one group at a time, and you have to use the NextCategory/PrevCategory keys to switch to a different category. Cyclying through the inventory will always stay in the selected group.<br />
<br />
;'''tdm_inv_visibility''' | int | default "1"<br />
:Specifies the visibility for the inventory. The following options are available<br />
:* 0 = never visible<br />
:* 1 = always visible<br />
:* 2 = temporary (not yet implemented.)<br />
:Option two will fade out the inventory after some specified time.<br />
<br />
;'''tdm_inv_opacity''' | float [0..1] | default "1"<br />
:Specifies the alphachannel for the inventory. It determines if and how much you can look through the inventory text and icons.<br />
<br />
;'''tdm_inv_fade_in''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it becomes visible. 0 means that it will be immediatly visible when activated.<br />
<br />
;'''tdm_inv_fade_out''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it bcomes invisible. 0 means that it will be immediatly invisible when deactivated.<br />
<br />
;'''tdm_inv_loot_sound''' | string | default "sound/sfx/world/frob_loot.ogg"<br />
:Specifies the default path to the soundfile that is played when loot is aquired. Note that this can be overriden on a per item level, and wont have an effect for such items.<br />
<br />
== Scriptsupport ==<br />
<br />
To be written...<br />
<br />
<br />
== Custom HUDs ==<br />
<br />
To be written...<br />
<br />
== Updates needed ==<br />
<br />
Scriptsupport and custom HUDs need to be written.<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]<br />
[[Category:Update]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Main_Page&diff=2286Main Page2007-02-21T13:55:51Z<p>Sparhawk: </p>
<hr />
<div><p style="margin:2em 0 0 0; text-align:center; font-size:200%;">Welcome to the Dark Wiki</p><br />
<p style="margin:0 0 3em 0; text-align:center; font-size:94%">A wiki documenting the Dark Mod for Doom 3</p><br />
<br />
<table align="center" width="90%" cellspacing="10"><tr><br />
<td style="width:50%; vertical-align:top; padding:2em; border:1px solid #e1e1e1; background-color:#f9f9f9"><br />
<br />
<p style="font-size:130%">'''New to the site?'''</p><br />
<br />
This wiki is focused on documenting the various aspects involved with developing, and mapping for, [[The Dark Mod]]. Please visit the about page or talk to some of our editors in #darkmod on irc.starchat.net if you want to learn more about this project.<br />
<br />
<p style="font-size:130%">'''Want to help?'''</p><br />
<br />
As the modwiki is a community project, feel free to register and join us on this great endeavour! Please check out the style guide first and follow these guidelines. Visit open tasks to find out which pages need help. You can also visit the sandbox to experiment with the wiki markup language.<br />
<br />
<p style="font-size:130%">'''Need Help with Wiki Articles?'''</p><br />
If you need help creating, editing or formatting wiki articles, take a look at our '''[[Basic Wiki Tutorial]]'''.<br />
<br />
<p style="font-size:130%">'''High quality links:'''</p><br />
<br />
Other interesting Dark Mod related links:<br />
<br />
; [http://www.thedarkmod.com www.thedarkmod.com] : The project website<br />
; [http://www.modetwo.net/darkmod www.modetwo.net/darkmod] : The project forum<br />
<br />
[[TheDarkWiki:Policy|The Dark Wiki Editing Policy]]<br />
<br />
</td><td style="vertical-align:top; padding:2em; border:1px solid #e1e1e1; background-color:#f9f9f9"><br />
<br />
<p style="font-size:130%">'''Editing Categories:'''</p><br />
<br />
; [[Installation]] : Information how to get The Dark Mod running<br />
; [[Bindings and User Settings]] : Key binding and interface documentation.<br />
; [[Universe]] : Information about The Dark Mod universe and setting<br />
; [[:Category:Tutorial|Tutorials]] : Complete tutorials about setting up certain characteristics<br />
; [[:Category:Editing|Editing]] : Information about level design and the tools<br />
; [[Textures]] : Explanation of material shaders and image files<br />
; [[Modeling]] : Modeling and file format information<br />
; [[Animation]] : General tips, and software tutorials<br />
; [[Sound]] : Soundeffects, ambients and how to get them ingame<br />
; [[Coding]] : Source code modification, level and GUI scripting<br />
; [[Release]] : How to pack a mission, and get it tested and released!<br />
; [[Developer Info]] : Internal informations for developers of the core team<br />
; [[:Category:Update|Articles that need to be fixed]] : Links to pages which have wrong or missing information or otherwise require attention.<br />
<br />
</td></tr></table><br />
<p style="margin:2em 0 2em 0; text-align:center; font-size:94%">(Create a new page by making a link to it, then click it. Or you can just go to www.thirdfilms.com/darkwiki/yourpagename)</p></div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=How_to_make_a_prefab_skybox&diff=2277How to make a prefab skybox2007-02-20T11:43:08Z<p>Sparhawk: </p>
<hr />
<div>http://www.thirdfilms.com/darkwiki/index.php?title=Skybox</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Skybox_Basic_Details&diff=2276Skybox Basic Details2007-02-20T11:42:04Z<p>Sparhawk: </p>
<hr />
<div>=How to make a prefab skybox=<br />
<br />
The easiest way to use a skybox in The Dark Mod is to use the prefab ones which come in the resources.<br />
<br />
The first thing to do is create a textured box around your level. This can be caulk or texture, the important thing is that it has a texture so that the level is sealed. <br />
<br />
The most simple thing to do is to make a box around the level and use the hollow tool.<br />
<br />
http://img226.imageshack.us/img226/4963/84078566bs0.jpg<br />
<br />
http://img59.imageshack.us/img59/6734/74703655hm7.jpg<br />
<br />
Texture the inside facing sides with the textures/textures/smf/portal_sky texture, ensuring you only texture the inside facing sides, selecting them with control shift click.<br />
<br />
http://img120.imageshack.us/img120/3702/77003234sb4.jpg<br />
<br />
http://img59.imageshack.us/img59/2491/35449053rg0.jpg<br />
<br />
Go to the edit menu, then “Load prefab” and navigate to the “prefabs” folder in “darkmod” folder and select “tdm_sky_starry1.pfb”.<br />
<br />
http://img71.imageshack.us/img71/869/48886392io8.jpg<br />
<br />
http://img59.imageshack.us/img59/8646/71894725lp0.jpg<br />
<br />
http://img226.imageshack.us/img226/41/12625019uj3.jpg<br />
<br />
Place this outside the main hollow box of your level. It is caulked on the outside and sealed so it will not leak.<br />
<br />
http://img71.imageshack.us/img71/9610/98009669xk2.jpg<br />
<br />
Finished. When you load your level you will have an attractive night sky with clouds moon and stars.<br />
<br />
http://img71.imageshack.us/img71/841/69658107tm5.jpg<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=How_to_make_a_prefab_skybox&diff=2275How to make a prefab skybox2007-02-20T11:41:29Z<p>Sparhawk: </p>
<hr />
<div>=How to make a prefab skybox=<br />
<br />
The easiest way to use a skybox in The Dark Mod is to use the prefab ones which come in the resources.<br />
<br />
The first thing to do is create a textured box around your level. This can be caulk or texture, the important thing is that it has a texture so that the level is sealed. <br />
<br />
The most simple thing to do is to make a box around the level and use the hollow tool.<br />
<br />
http://img226.imageshack.us/img226/4963/84078566bs0.jpg<br />
<br />
http://img59.imageshack.us/img59/6734/74703655hm7.jpg<br />
<br />
Texture the inside facing sides with the textures/textures/smf/portal_sky texture, ensuring you only texture the inside facing sides, selecting them with control shift click.<br />
<br />
http://img120.imageshack.us/img120/3702/77003234sb4.jpg<br />
<br />
http://img59.imageshack.us/img59/2491/35449053rg0.jpg<br />
<br />
Go to the edit menu, then “Load prefab” and navigate to the “prefabs” folder in “darkmod” folder and select “tdm_sky_starry1.pfb”.<br />
<br />
http://img71.imageshack.us/img71/869/48886392io8.jpg<br />
<br />
http://img59.imageshack.us/img59/8646/71894725lp0.jpg<br />
<br />
http://img226.imageshack.us/img226/41/12625019uj3.jpg<br />
<br />
Place this outside the main hollow box of your level. It is caulked on the outside and sealed so it will not leak.<br />
<br />
http://img71.imageshack.us/img71/9610/98009669xk2.jpg<br />
<br />
Finished. When you load your level you will have an attractive night sky with clouds moon and stars.<br />
<br />
http://img71.imageshack.us/img71/841/69658107tm5.jpg<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2270Inventory2007-02-19T17:11:49Z<p>Sparhawk: /* Definitions */</p>
<hr />
<div>This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an error message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
* '''Cursor''' An inventory can have multiple cursors. This means that you can create objects which make use of a given inventory, by acquiring a cursor for it. This way, you can implement different HUDs or GUIs which can show different parts of the inventory in different places even though all the items are in one single inventory. For any given object you can not rely to be in a particular inventory, even though you might have a cursor pointing to it. That's because it might be that some other object may have already removed that object, or added another one. Thus, you should always get the pointer to a given item, when you access it, and don't store it's position somewhere external.<br />
<br />
== Spawnargs ==<br />
<br />
;'''inv_category''' | string<br />
:Specifies the category that the object should be filed under. This allows for player convenience and also is needed for stackable items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_name''' | string<br />
:Specifies the name the object should display when it is activated in the inventory. Keep in mind that the display name and the category together are used to determine, if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you create to "Health Potion" items, but with different categories, they are treated as different items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_icon''' | D3 path to icon<br />
:Points to an icon that is to be displayed when the object is selected in the inventory. This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
;'''inv_stackable''' | [0/1]<br />
:Determines wether an item is an individual or can be a stack of similar objects. An example would be the various potions. The player can pick up more than one health potion, but in the inventory he will only get one item with a counter. Keep in mind though, that a stack of gold coins is not per se stackable, because usually it will be only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
;'''inv_item_id''' | string<br />
:This key can be set by the mapper to an arbitrary value. This is needed if the mapper wants to implement custom behaviour and he uniquily need to identfy an item or a group of items. Normally the mapper could also use the inv_name for this key, but this doesn't allow the additional flexibillity. For example a mapper can create a fake health potion which shows up in the inventory just like a regular one, with the same name but a different map model. So if the player picks this bottle up, because he doesn't look carefull and thinks he got a health potion, he might have aquired a real one, while this one actually may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This will of course only work with additional scripting, because the mapper must know what to do with it. In this case the mapper might set a flag on the callback, and the next time the player uses a health potion, the action is triggered.<br />
<br />
;'''inv_count''' | <N><br />
:Determines the number of items this represents. This is only needed for items where stackable is 1, otherwise it is set to 0. Als the option for stackable must always precede the count, otherwise the count is set to 0.<br />
<br />
;'''inv_droppable''' | [0/1]<br />
:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items, since they will have no representation after they were put into the inventory.<br />
<br />
;'''inv_delete''' | [0/1]<br />
:Determines if an anonymous object can be deleted, after it was put into the inventory. This is advisable, because the entity will stay in memory and a mapper could still access it via scripting. If the mapper decides that an item will no longer be accessed after it has been acquired, this key should be set to 1. This can affect loading time of saved games, as entities, that are no longer needed, don't need to be saved and restored. <br />
:If the mapper also creates entities on the fly, with the help of scripts, it might better to set this flag on appropriate objects to free up the limited number of entities a map can hold. The usuals candidates for this flag are all the regular loot items, because they wont be used anymore after they have been found (lik coins, purses, etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since droppabale items must be turned into entities again to be placed in the map.<br />
<br />
;'''inv_loot_type''' | [ 0 | 1 | 2 | 3 ]<br />
:* 0 = No lootitem (default)<br />
:* 1 = Jewelry/Gems<br />
:* 2 = Gold<br />
:* 3 = Goods<br />
:This has to be set in order to define what kind of item it is and if it is a loot item, which category of loot it should account for.<br />
<br />
;'''inv_loot_value''' | <N><br />
:Determines the amount of loot this item accounts for. This value is ignore if it is set on an item, which is of loot_type = 0.<br />
<br />
;'''inv_map_start''' | [0|1]<br />
:Determines wether this object should be assigned to an inventory at map start.<br />
<br />
;'''inv_target''' | <entityname><br />
:If the item should be assigned to an entity at map start, this should get the name of the entity who shold recive it. To give an item to the player, you would use "player1" as the name, because this is the name that the player entity gets by default. If inv_map_start is not set or set to 0, then this key doesn't need to be set and is ignored. Since the name can be arbitrary, this means of course, that you can also give it to an AI, which the player later on meets. This should not be confused with loot, that is to be attached to an AI though. If you attach a purse or a key to an AI, which the player can frob later on, then it doesn't need to get this set, because such things will not be stored in the inventory. You could assign such things to an chest though, to give the objects to the player when he opens it. This is not directly support though, because it is assumed that chests will be filled with real objects, like TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
;'''inv_hud''' | <hudfilename><br />
: If this key is set it should point to a GUI file, which defines the hud for this particular item. As an example, you can look at the loot.hud, which implements a custom hud that does not use the normal display for items. The mapper is responsible to maintain the state for such an item on his own. In order to do this, there is an initialization message sent to the specified script and other messages as well like selecting or deselecting an item.In order to make this work, the mapper must write a script and assign this script to the key "scriptobject" on the entity. This will automatically launch that script when the entity is spawned,. If the messagefunctions are not implemented the item will show up as an empty slot on the inventory. A detailed description how to operate a custom hud will be described in the scripting section on this article.<br />
<br />
;'''inv_hud_layer''' | int | layernumber<br />
: If a custom hud is used for an item by setting the key "inv_hud", this key can be set to specify a layernumber that the hud should be displayed with. Normally this value can be set to 0 or left blank when using the default screen for the player, but for huds on other objects in the map, this might be needed.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
== CVARs ==<br />
<br />
The following cvars can be used to modify the behaviour of some inventory properties. Some of them are probably only of interest to modders, while others are also of interest to<br />
players and might be added to a customization menu.<br />
<br />
;'''tdm_inv_hud_file''' | string | default "guis/inv.gui"<br />
:Specifies the gui file that should be used for the inventory. this can be changed for mods, that wish to implement a different GUI, or provide alternative skins for the player.<br />
<br />
;'''tdm_inv_loot_hud''' | string | default "guis/loot.gui"<br />
:Specifies the gui file that should be used for the loot slot in the inventory. Since custom huds are now supported for different items, this cvar is no longer needed and might be removed later.<br />
<br />
;'''tdm_inv_loot_group''' | string | default "Loot"<br />
:Specifies the default category name for teh loot objects. This is probably not used and changing it has no effect.<br />
<br />
;'''tdm_inv_group_mode''' | int | default "0"<br />
:This defines how the grouping should work. The following options are available:<br />
:* 0 = ungrouped inventory (T1/T2 style)<br />
:* 1 = grouped inventory<br />
:''''ungrouped'''' means that you can cycle through the inventory one after the other. This does not affect the NextCategory/PrevCategory keys and you can still use them. <br />
:''''grouped'''' means that you just cycle through one group at a time, and you have to use the NextCategory/PrevCategory keys to switch to a different category. Cyclying through the inventory will always stay in the selected group.<br />
<br />
;'''tdm_inv_visibility''' | int | default "1"<br />
:Specifies the visibility for the inventory. The following options are available<br />
:* 0 = never visible<br />
:* 1 = always visible<br />
:* 2 = temporary (not yet implemented.)<br />
:Option two will fade out the inventory after some specified time.<br />
<br />
;'''tdm_inv_opacity''' | float [0..1] | default "1"<br />
:Specifies the alphachannel for the inventory. It determines if and how much you can look through the inventory text and icons.<br />
<br />
;'''tdm_inv_fade_in''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it becomes visible. 0 means that it will be immediatly visible when activated.<br />
<br />
;'''tdm_inv_fade_out''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it bcomes invisible. 0 means that it will be immediatly invisible when deactivated.<br />
<br />
;'''tdm_inv_loot_sound''' | string | default "sound/sfx/world/frob_loot.ogg"<br />
:Specifies the default path to the soundfile that is played when loot is aquired. Note that this can be overriden on a per item level, and wont have an effect for such items.<br />
<br />
== Scriptsupport ==<br />
<br />
To be written...<br />
<br />
<br />
== Custom HUDs ==<br />
<br />
To be written...<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2269Inventory2007-02-19T17:10:18Z<p>Sparhawk: /* Definitions */</p>
<hr />
<div>This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an error message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
* '''Cursor''' An inventory can have multiple cursors. This means that you can create objects which make use of a given inventory, by acquiring a cursor for it. This way, you can implement different HUDs or GUIs which can show different parts of the inventory in different places even though all the items are in one single inventory.<br />
<br />
== Spawnargs ==<br />
<br />
;'''inv_category''' | string<br />
:Specifies the category that the object should be filed under. This allows for player convenience and also is needed for stackable items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_name''' | string<br />
:Specifies the name the object should display when it is activated in the inventory. Keep in mind that the display name and the category together are used to determine, if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you create to "Health Potion" items, but with different categories, they are treated as different items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_icon''' | D3 path to icon<br />
:Points to an icon that is to be displayed when the object is selected in the inventory. This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
;'''inv_stackable''' | [0/1]<br />
:Determines wether an item is an individual or can be a stack of similar objects. An example would be the various potions. The player can pick up more than one health potion, but in the inventory he will only get one item with a counter. Keep in mind though, that a stack of gold coins is not per se stackable, because usually it will be only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
;'''inv_item_id''' | string<br />
:This key can be set by the mapper to an arbitrary value. This is needed if the mapper wants to implement custom behaviour and he uniquily need to identfy an item or a group of items. Normally the mapper could also use the inv_name for this key, but this doesn't allow the additional flexibillity. For example a mapper can create a fake health potion which shows up in the inventory just like a regular one, with the same name but a different map model. So if the player picks this bottle up, because he doesn't look carefull and thinks he got a health potion, he might have aquired a real one, while this one actually may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This will of course only work with additional scripting, because the mapper must know what to do with it. In this case the mapper might set a flag on the callback, and the next time the player uses a health potion, the action is triggered.<br />
<br />
;'''inv_count''' | <N><br />
:Determines the number of items this represents. This is only needed for items where stackable is 1, otherwise it is set to 0. Als the option for stackable must always precede the count, otherwise the count is set to 0.<br />
<br />
;'''inv_droppable''' | [0/1]<br />
:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items, since they will have no representation after they were put into the inventory.<br />
<br />
;'''inv_delete''' | [0/1]<br />
:Determines if an anonymous object can be deleted, after it was put into the inventory. This is advisable, because the entity will stay in memory and a mapper could still access it via scripting. If the mapper decides that an item will no longer be accessed after it has been acquired, this key should be set to 1. This can affect loading time of saved games, as entities, that are no longer needed, don't need to be saved and restored. <br />
:If the mapper also creates entities on the fly, with the help of scripts, it might better to set this flag on appropriate objects to free up the limited number of entities a map can hold. The usuals candidates for this flag are all the regular loot items, because they wont be used anymore after they have been found (lik coins, purses, etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since droppabale items must be turned into entities again to be placed in the map.<br />
<br />
;'''inv_loot_type''' | [ 0 | 1 | 2 | 3 ]<br />
:* 0 = No lootitem (default)<br />
:* 1 = Jewelry/Gems<br />
:* 2 = Gold<br />
:* 3 = Goods<br />
:This has to be set in order to define what kind of item it is and if it is a loot item, which category of loot it should account for.<br />
<br />
;'''inv_loot_value''' | <N><br />
:Determines the amount of loot this item accounts for. This value is ignore if it is set on an item, which is of loot_type = 0.<br />
<br />
;'''inv_map_start''' | [0|1]<br />
:Determines wether this object should be assigned to an inventory at map start.<br />
<br />
;'''inv_target''' | <entityname><br />
:If the item should be assigned to an entity at map start, this should get the name of the entity who shold recive it. To give an item to the player, you would use "player1" as the name, because this is the name that the player entity gets by default. If inv_map_start is not set or set to 0, then this key doesn't need to be set and is ignored. Since the name can be arbitrary, this means of course, that you can also give it to an AI, which the player later on meets. This should not be confused with loot, that is to be attached to an AI though. If you attach a purse or a key to an AI, which the player can frob later on, then it doesn't need to get this set, because such things will not be stored in the inventory. You could assign such things to an chest though, to give the objects to the player when he opens it. This is not directly support though, because it is assumed that chests will be filled with real objects, like TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
;'''inv_hud''' | <hudfilename><br />
: If this key is set it should point to a GUI file, which defines the hud for this particular item. As an example, you can look at the loot.hud, which implements a custom hud that does not use the normal display for items. The mapper is responsible to maintain the state for such an item on his own. In order to do this, there is an initialization message sent to the specified script and other messages as well like selecting or deselecting an item.In order to make this work, the mapper must write a script and assign this script to the key "scriptobject" on the entity. This will automatically launch that script when the entity is spawned,. If the messagefunctions are not implemented the item will show up as an empty slot on the inventory. A detailed description how to operate a custom hud will be described in the scripting section on this article.<br />
<br />
;'''inv_hud_layer''' | int | layernumber<br />
: If a custom hud is used for an item by setting the key "inv_hud", this key can be set to specify a layernumber that the hud should be displayed with. Normally this value can be set to 0 or left blank when using the default screen for the player, but for huds on other objects in the map, this might be needed.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
== CVARs ==<br />
<br />
The following cvars can be used to modify the behaviour of some inventory properties. Some of them are probably only of interest to modders, while others are also of interest to<br />
players and might be added to a customization menu.<br />
<br />
;'''tdm_inv_hud_file''' | string | default "guis/inv.gui"<br />
:Specifies the gui file that should be used for the inventory. this can be changed for mods, that wish to implement a different GUI, or provide alternative skins for the player.<br />
<br />
;'''tdm_inv_loot_hud''' | string | default "guis/loot.gui"<br />
:Specifies the gui file that should be used for the loot slot in the inventory. Since custom huds are now supported for different items, this cvar is no longer needed and might be removed later.<br />
<br />
;'''tdm_inv_loot_group''' | string | default "Loot"<br />
:Specifies the default category name for teh loot objects. This is probably not used and changing it has no effect.<br />
<br />
;'''tdm_inv_group_mode''' | int | default "0"<br />
:This defines how the grouping should work. The following options are available:<br />
:* 0 = ungrouped inventory (T1/T2 style)<br />
:* 1 = grouped inventory<br />
:''''ungrouped'''' means that you can cycle through the inventory one after the other. This does not affect the NextCategory/PrevCategory keys and you can still use them. <br />
:''''grouped'''' means that you just cycle through one group at a time, and you have to use the NextCategory/PrevCategory keys to switch to a different category. Cyclying through the inventory will always stay in the selected group.<br />
<br />
;'''tdm_inv_visibility''' | int | default "1"<br />
:Specifies the visibility for the inventory. The following options are available<br />
:* 0 = never visible<br />
:* 1 = always visible<br />
:* 2 = temporary (not yet implemented.)<br />
:Option two will fade out the inventory after some specified time.<br />
<br />
;'''tdm_inv_opacity''' | float [0..1] | default "1"<br />
:Specifies the alphachannel for the inventory. It determines if and how much you can look through the inventory text and icons.<br />
<br />
;'''tdm_inv_fade_in''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it becomes visible. 0 means that it will be immediatly visible when activated.<br />
<br />
;'''tdm_inv_fade_out''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it bcomes invisible. 0 means that it will be immediatly invisible when deactivated.<br />
<br />
;'''tdm_inv_loot_sound''' | string | default "sound/sfx/world/frob_loot.ogg"<br />
:Specifies the default path to the soundfile that is played when loot is aquired. Note that this can be overriden on a per item level, and wont have an effect for such items.<br />
<br />
== Scriptsupport ==<br />
<br />
To be written...<br />
<br />
<br />
== Custom HUDs ==<br />
<br />
To be written...<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2268Inventory2007-02-19T17:09:59Z<p>Sparhawk: /* Definitions */</p>
<hr />
<div>This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an error message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
* '''Cursor''' An inventory can have multiple cursors. This means that you can create objects which make use of a given inventory, but acquiring a cursor for it. This way, you can implement different HUDs or GUIs which can show different parts of the inventory in different places even though all the items are in one single inventory.<br />
<br />
== Spawnargs ==<br />
<br />
;'''inv_category''' | string<br />
:Specifies the category that the object should be filed under. This allows for player convenience and also is needed for stackable items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_name''' | string<br />
:Specifies the name the object should display when it is activated in the inventory. Keep in mind that the display name and the category together are used to determine, if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you create to "Health Potion" items, but with different categories, they are treated as different items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_icon''' | D3 path to icon<br />
:Points to an icon that is to be displayed when the object is selected in the inventory. This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
;'''inv_stackable''' | [0/1]<br />
:Determines wether an item is an individual or can be a stack of similar objects. An example would be the various potions. The player can pick up more than one health potion, but in the inventory he will only get one item with a counter. Keep in mind though, that a stack of gold coins is not per se stackable, because usually it will be only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
;'''inv_item_id''' | string<br />
:This key can be set by the mapper to an arbitrary value. This is needed if the mapper wants to implement custom behaviour and he uniquily need to identfy an item or a group of items. Normally the mapper could also use the inv_name for this key, but this doesn't allow the additional flexibillity. For example a mapper can create a fake health potion which shows up in the inventory just like a regular one, with the same name but a different map model. So if the player picks this bottle up, because he doesn't look carefull and thinks he got a health potion, he might have aquired a real one, while this one actually may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This will of course only work with additional scripting, because the mapper must know what to do with it. In this case the mapper might set a flag on the callback, and the next time the player uses a health potion, the action is triggered.<br />
<br />
;'''inv_count''' | <N><br />
:Determines the number of items this represents. This is only needed for items where stackable is 1, otherwise it is set to 0. Als the option for stackable must always precede the count, otherwise the count is set to 0.<br />
<br />
;'''inv_droppable''' | [0/1]<br />
:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items, since they will have no representation after they were put into the inventory.<br />
<br />
;'''inv_delete''' | [0/1]<br />
:Determines if an anonymous object can be deleted, after it was put into the inventory. This is advisable, because the entity will stay in memory and a mapper could still access it via scripting. If the mapper decides that an item will no longer be accessed after it has been acquired, this key should be set to 1. This can affect loading time of saved games, as entities, that are no longer needed, don't need to be saved and restored. <br />
:If the mapper also creates entities on the fly, with the help of scripts, it might better to set this flag on appropriate objects to free up the limited number of entities a map can hold. The usuals candidates for this flag are all the regular loot items, because they wont be used anymore after they have been found (lik coins, purses, etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since droppabale items must be turned into entities again to be placed in the map.<br />
<br />
;'''inv_loot_type''' | [ 0 | 1 | 2 | 3 ]<br />
:* 0 = No lootitem (default)<br />
:* 1 = Jewelry/Gems<br />
:* 2 = Gold<br />
:* 3 = Goods<br />
:This has to be set in order to define what kind of item it is and if it is a loot item, which category of loot it should account for.<br />
<br />
;'''inv_loot_value''' | <N><br />
:Determines the amount of loot this item accounts for. This value is ignore if it is set on an item, which is of loot_type = 0.<br />
<br />
;'''inv_map_start''' | [0|1]<br />
:Determines wether this object should be assigned to an inventory at map start.<br />
<br />
;'''inv_target''' | <entityname><br />
:If the item should be assigned to an entity at map start, this should get the name of the entity who shold recive it. To give an item to the player, you would use "player1" as the name, because this is the name that the player entity gets by default. If inv_map_start is not set or set to 0, then this key doesn't need to be set and is ignored. Since the name can be arbitrary, this means of course, that you can also give it to an AI, which the player later on meets. This should not be confused with loot, that is to be attached to an AI though. If you attach a purse or a key to an AI, which the player can frob later on, then it doesn't need to get this set, because such things will not be stored in the inventory. You could assign such things to an chest though, to give the objects to the player when he opens it. This is not directly support though, because it is assumed that chests will be filled with real objects, like TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
;'''inv_hud''' | <hudfilename><br />
: If this key is set it should point to a GUI file, which defines the hud for this particular item. As an example, you can look at the loot.hud, which implements a custom hud that does not use the normal display for items. The mapper is responsible to maintain the state for such an item on his own. In order to do this, there is an initialization message sent to the specified script and other messages as well like selecting or deselecting an item.In order to make this work, the mapper must write a script and assign this script to the key "scriptobject" on the entity. This will automatically launch that script when the entity is spawned,. If the messagefunctions are not implemented the item will show up as an empty slot on the inventory. A detailed description how to operate a custom hud will be described in the scripting section on this article.<br />
<br />
;'''inv_hud_layer''' | int | layernumber<br />
: If a custom hud is used for an item by setting the key "inv_hud", this key can be set to specify a layernumber that the hud should be displayed with. Normally this value can be set to 0 or left blank when using the default screen for the player, but for huds on other objects in the map, this might be needed.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
== CVARs ==<br />
<br />
The following cvars can be used to modify the behaviour of some inventory properties. Some of them are probably only of interest to modders, while others are also of interest to<br />
players and might be added to a customization menu.<br />
<br />
;'''tdm_inv_hud_file''' | string | default "guis/inv.gui"<br />
:Specifies the gui file that should be used for the inventory. this can be changed for mods, that wish to implement a different GUI, or provide alternative skins for the player.<br />
<br />
;'''tdm_inv_loot_hud''' | string | default "guis/loot.gui"<br />
:Specifies the gui file that should be used for the loot slot in the inventory. Since custom huds are now supported for different items, this cvar is no longer needed and might be removed later.<br />
<br />
;'''tdm_inv_loot_group''' | string | default "Loot"<br />
:Specifies the default category name for teh loot objects. This is probably not used and changing it has no effect.<br />
<br />
;'''tdm_inv_group_mode''' | int | default "0"<br />
:This defines how the grouping should work. The following options are available:<br />
:* 0 = ungrouped inventory (T1/T2 style)<br />
:* 1 = grouped inventory<br />
:''''ungrouped'''' means that you can cycle through the inventory one after the other. This does not affect the NextCategory/PrevCategory keys and you can still use them. <br />
:''''grouped'''' means that you just cycle through one group at a time, and you have to use the NextCategory/PrevCategory keys to switch to a different category. Cyclying through the inventory will always stay in the selected group.<br />
<br />
;'''tdm_inv_visibility''' | int | default "1"<br />
:Specifies the visibility for the inventory. The following options are available<br />
:* 0 = never visible<br />
:* 1 = always visible<br />
:* 2 = temporary (not yet implemented.)<br />
:Option two will fade out the inventory after some specified time.<br />
<br />
;'''tdm_inv_opacity''' | float [0..1] | default "1"<br />
:Specifies the alphachannel for the inventory. It determines if and how much you can look through the inventory text and icons.<br />
<br />
;'''tdm_inv_fade_in''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it becomes visible. 0 means that it will be immediatly visible when activated.<br />
<br />
;'''tdm_inv_fade_out''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it bcomes invisible. 0 means that it will be immediatly invisible when deactivated.<br />
<br />
;'''tdm_inv_loot_sound''' | string | default "sound/sfx/world/frob_loot.ogg"<br />
:Specifies the default path to the soundfile that is played when loot is aquired. Note that this can be overriden on a per item level, and wont have an effect for such items.<br />
<br />
== Scriptsupport ==<br />
<br />
To be written...<br />
<br />
<br />
== Custom HUDs ==<br />
<br />
To be written...<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2267Inventory2007-02-19T17:09:46Z<p>Sparhawk: /* Definitions */</p>
<hr />
<div>This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an error message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
* '''cursor''' An inventory can have multiple cursors. This means that you can create objects which make use of a given inventory, but acquiring a cursor for it. This way, you can implement different HUDs or GUIs which can show different parts of the inventory in different places even though all the items are in one single inventory.<br />
<br />
== Spawnargs ==<br />
<br />
;'''inv_category''' | string<br />
:Specifies the category that the object should be filed under. This allows for player convenience and also is needed for stackable items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_name''' | string<br />
:Specifies the name the object should display when it is activated in the inventory. Keep in mind that the display name and the category together are used to determine, if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you create to "Health Potion" items, but with different categories, they are treated as different items.<br />
:example: "inv_name" "Health Potion"<br />
<br />
;'''inv_icon''' | D3 path to icon<br />
:Points to an icon that is to be displayed when the object is selected in the inventory. This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
;'''inv_stackable''' | [0/1]<br />
:Determines wether an item is an individual or can be a stack of similar objects. An example would be the various potions. The player can pick up more than one health potion, but in the inventory he will only get one item with a counter. Keep in mind though, that a stack of gold coins is not per se stackable, because usually it will be only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
;'''inv_item_id''' | string<br />
:This key can be set by the mapper to an arbitrary value. This is needed if the mapper wants to implement custom behaviour and he uniquily need to identfy an item or a group of items. Normally the mapper could also use the inv_name for this key, but this doesn't allow the additional flexibillity. For example a mapper can create a fake health potion which shows up in the inventory just like a regular one, with the same name but a different map model. So if the player picks this bottle up, because he doesn't look carefull and thinks he got a health potion, he might have aquired a real one, while this one actually may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This will of course only work with additional scripting, because the mapper must know what to do with it. In this case the mapper might set a flag on the callback, and the next time the player uses a health potion, the action is triggered.<br />
<br />
;'''inv_count''' | <N><br />
:Determines the number of items this represents. This is only needed for items where stackable is 1, otherwise it is set to 0. Als the option for stackable must always precede the count, otherwise the count is set to 0.<br />
<br />
;'''inv_droppable''' | [0/1]<br />
:If set to 1 the item can be dropped into the map by the player. This will not work for anonymous items, since they will have no representation after they were put into the inventory.<br />
<br />
;'''inv_delete''' | [0/1]<br />
:Determines if an anonymous object can be deleted, after it was put into the inventory. This is advisable, because the entity will stay in memory and a mapper could still access it via scripting. If the mapper decides that an item will no longer be accessed after it has been acquired, this key should be set to 1. This can affect loading time of saved games, as entities, that are no longer needed, don't need to be saved and restored. <br />
:If the mapper also creates entities on the fly, with the help of scripts, it might better to set this flag on appropriate objects to free up the limited number of entities a map can hold. The usuals candidates for this flag are all the regular loot items, because they wont be used anymore after they have been found (lik coins, purses, etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since droppabale items must be turned into entities again to be placed in the map.<br />
<br />
;'''inv_loot_type''' | [ 0 | 1 | 2 | 3 ]<br />
:* 0 = No lootitem (default)<br />
:* 1 = Jewelry/Gems<br />
:* 2 = Gold<br />
:* 3 = Goods<br />
:This has to be set in order to define what kind of item it is and if it is a loot item, which category of loot it should account for.<br />
<br />
;'''inv_loot_value''' | <N><br />
:Determines the amount of loot this item accounts for. This value is ignore if it is set on an item, which is of loot_type = 0.<br />
<br />
;'''inv_map_start''' | [0|1]<br />
:Determines wether this object should be assigned to an inventory at map start.<br />
<br />
;'''inv_target''' | <entityname><br />
:If the item should be assigned to an entity at map start, this should get the name of the entity who shold recive it. To give an item to the player, you would use "player1" as the name, because this is the name that the player entity gets by default. If inv_map_start is not set or set to 0, then this key doesn't need to be set and is ignored. Since the name can be arbitrary, this means of course, that you can also give it to an AI, which the player later on meets. This should not be confused with loot, that is to be attached to an AI though. If you attach a purse or a key to an AI, which the player can frob later on, then it doesn't need to get this set, because such things will not be stored in the inventory. You could assign such things to an chest though, to give the objects to the player when he opens it. This is not directly support though, because it is assumed that chests will be filled with real objects, like TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
;'''inv_hud''' | <hudfilename><br />
: If this key is set it should point to a GUI file, which defines the hud for this particular item. As an example, you can look at the loot.hud, which implements a custom hud that does not use the normal display for items. The mapper is responsible to maintain the state for such an item on his own. In order to do this, there is an initialization message sent to the specified script and other messages as well like selecting or deselecting an item.In order to make this work, the mapper must write a script and assign this script to the key "scriptobject" on the entity. This will automatically launch that script when the entity is spawned,. If the messagefunctions are not implemented the item will show up as an empty slot on the inventory. A detailed description how to operate a custom hud will be described in the scripting section on this article.<br />
<br />
;'''inv_hud_layer''' | int | layernumber<br />
: If a custom hud is used for an item by setting the key "inv_hud", this key can be set to specify a layernumber that the hud should be displayed with. Normally this value can be set to 0 or left blank when using the default screen for the player, but for huds on other objects in the map, this might be needed.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
== CVARs ==<br />
<br />
The following cvars can be used to modify the behaviour of some inventory properties. Some of them are probably only of interest to modders, while others are also of interest to<br />
players and might be added to a customization menu.<br />
<br />
;'''tdm_inv_hud_file''' | string | default "guis/inv.gui"<br />
:Specifies the gui file that should be used for the inventory. this can be changed for mods, that wish to implement a different GUI, or provide alternative skins for the player.<br />
<br />
;'''tdm_inv_loot_hud''' | string | default "guis/loot.gui"<br />
:Specifies the gui file that should be used for the loot slot in the inventory. Since custom huds are now supported for different items, this cvar is no longer needed and might be removed later.<br />
<br />
;'''tdm_inv_loot_group''' | string | default "Loot"<br />
:Specifies the default category name for teh loot objects. This is probably not used and changing it has no effect.<br />
<br />
;'''tdm_inv_group_mode''' | int | default "0"<br />
:This defines how the grouping should work. The following options are available:<br />
:* 0 = ungrouped inventory (T1/T2 style)<br />
:* 1 = grouped inventory<br />
:''''ungrouped'''' means that you can cycle through the inventory one after the other. This does not affect the NextCategory/PrevCategory keys and you can still use them. <br />
:''''grouped'''' means that you just cycle through one group at a time, and you have to use the NextCategory/PrevCategory keys to switch to a different category. Cyclying through the inventory will always stay in the selected group.<br />
<br />
;'''tdm_inv_visibility''' | int | default "1"<br />
:Specifies the visibility for the inventory. The following options are available<br />
:* 0 = never visible<br />
:* 1 = always visible<br />
:* 2 = temporary (not yet implemented.)<br />
:Option two will fade out the inventory after some specified time.<br />
<br />
;'''tdm_inv_opacity''' | float [0..1] | default "1"<br />
:Specifies the alphachannel for the inventory. It determines if and how much you can look through the inventory text and icons.<br />
<br />
;'''tdm_inv_fade_in''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it becomes visible. 0 means that it will be immediatly visible when activated.<br />
<br />
;'''tdm_inv_fade_out''' | int | default "0"<br />
:Specifies how long it should take for the inventory until it bcomes invisible. 0 means that it will be immediatly invisible when deactivated.<br />
<br />
;'''tdm_inv_loot_sound''' | string | default "sound/sfx/world/frob_loot.ogg"<br />
:Specifies the default path to the soundfile that is played when loot is aquired. Note that this can be overriden on a per item level, and wont have an effect for such items.<br />
<br />
== Scriptsupport ==<br />
<br />
To be written...<br />
<br />
<br />
== Custom HUDs ==<br />
<br />
To be written...<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2266Doors2007-02-19T16:14:32Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
; '''spawnclass''' CFrobDoor<br />
:This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
; '''open''' [1|0]<br />
:Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
; '''locked''' [1|0]<br />
:Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
; '''pickable''' [1|0]<br />
:Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
; '''rotate''' idAngle [0 90 0]<br />
:Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''<br />
:Default [0 90 0]'''<br />
<br />
; '''translate''' idVec3 [0 0 0]<br />
:Defines the translation value that is to be used whenever a door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
; '''snd_open''' string/shader<br />
:Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_close''' string/shader<br />
:Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_locked''' string<br />
:Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
; '''snd_unlock''' string<br />
:Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"<br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2265Doors2007-02-19T16:13:53Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
; '''spawnclass''' CFrobDoor<br />
:This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
; '''open''' [1|0]<br />
:Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
; '''locked''' [1|0]<br />
:Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
; '''pickable''' [1|0]<br />
:Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
; '''rotate''' idAngle [0 90 0]<br />
:Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''<br />
:Default [0 90 0]'''<br />
<br />
; '''translate''' idVec3 [0 0 0]<br />
:Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
; '''snd_open''' string/shader<br />
:Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_close''' string/shader<br />
:Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_locked''' string<br />
:Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
; '''snd_unlock''' string<br />
:Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"<br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2264Doors2007-02-19T16:12:42Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
; '''spawnclass''' CFrobDoor<br />
:This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
; '''open''' [1|0]<br />
:Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
; '''locked''' [1|0]<br />
:Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
; '''pickable''' [1|0]<br />
:Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
; '''rotate: idAngle [0 90 0]'''<br />
:Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''(Default: 0 90 0)'''<br />
<br />
; '''translate: idVec3 [0 0 0]'''<br />
:Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
; '''snd_open: string/shader'''<br />
:Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_close: string/shader'''<br />
:Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_locked: string'''<br />
:Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
; '''snd_unlock: string'''<br />
:Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"<br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2263Doors2007-02-19T16:11:49Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
; '''spawnclass: CFrobDoor'''<br />
:This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
; '''open: [1|0]'''<br />
:Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
; '''locked: [1|0]'''<br />
:Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
; '''pickable: [1|0]'''<br />
:Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
; '''rotate: idAngle [0 90 0]'''<br />
:Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''(Default: 0 90 0)'''<br />
<br />
; '''translate: idVec3 [0 0 0]'''<br />
:Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
; '''snd_open: string/shader'''<br />
:Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_close: string/shader'''<br />
:Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
; '''snd_locked: string'''<br />
:Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
; '''snd_unlock: string'''<br />
:Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"<br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2262Doors2007-02-19T16:09:27Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
* '''spawnclass: CFrobDoor''' This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
* '''open: [1|0]''' Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
* '''locked: [1|0]''' Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
* '''pickable: [1|0]''' Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
* '''rotate: idAngle [0 90 0]''' Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''(Default: 0 90 0)'''<br />
<br />
* '''translate: idVec3 [0 0 0]''' Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
* '''snd_open: string/shader''' Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_close: string/shader''' Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_locked: string''' Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
* '''snd_unlock: string''' Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"<br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2261Doors2007-02-19T16:08:24Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
* '''spawnclass: CFrobDoor''' This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
* '''open: [1|0]''' Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
* '''locked: [1|0]''' Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
* '''pickable: [1|0]''' Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
* '''rotate: idAngle [0 90 0]''' Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''(Default: 0 90 0)'''<br />
<br />
* '''translate: idVec3 [0 0 0]''' [This feature is currently not implemented] Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
* '''snd_open: string/shader''' Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_close: string/shader''' Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_locked: string''' Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
* '''snd_unlock: string''' Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"<br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2260Doors2007-02-19T16:08:09Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
* '''spawnclass: CFrobDoor''' This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
* '''open: [1|0]''' Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
* '''locked: [1|0]''' Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
* '''pickable: [1|0]''' Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
* '''rotate: idAngle [0 90 0]''' Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''(Default: 0 90 0)'''<br />
<br />
* '''translate: idVec3 [0 0 0]''' [This feature is currently not implemented] Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
* '''snd_open: string/shader''' Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_close: string/shader''' Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_locked: string''' Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
* '''snd_unlock: string''' Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg"</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Func_darkmod_door&diff=2259Func darkmod door2007-02-19T16:06:19Z<p>Sparhawk: Func darkmod door moved to Doors</p>
<hr />
<div>#redirect [[Doors]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Doors&diff=2258Doors2007-02-19T16:06:19Z<p>Sparhawk: Func darkmod door moved to Doors</p>
<hr />
<div>{{Original_Reference|sparhawk & Ishtvan|1722}}<br />
<br />
This a short description of the keys/values of '''func_darkmod_door''':<br />
<br />
* '''spawnclass: CFrobDoor''' This is the class that is to be used for the normal doors and directly refers to the C++ class that encapsulates the code for this entity.<br />
<br />
* '''open: [1|0]''' Defines wether the door is in state open or closed. this has nothing to do with the visual representation of the door. If the door is placed in such a way that it looks open, but is defined as closed here the player might get confused in certain situations. '''(Default: 0 = closed)'''<br />
<br />
* '''locked: [1|0]''' Defines wether the door is currently locked. If this is the case it will require an entity that is associated with it to be able to unlock it. '''(Default: 0 = locked)'''<br />
<br />
* '''pickable: [1|0]''' Defines wether this door can be lockpicked. If set to 1 the lockpicks can be used on it, otherwise the door can only be unlocked with the appropriate key. '''(Default: 1)'''<br />
<br />
* '''rotate: idAngle [0 90 0]''' Defines the angle the door should rotate when it is opened. On subsequent uses the door will rotate back and forth. '''(Default: 0 90 0)'''<br />
<br />
* '''translate: idVec3 [0 0 0]''' [This feature is currently not implemented] Defines the translation value that is to be used whenevera door is opened. This can be used for sliding doors. '''(Default: 0 0 0)'''<br />
<br />
* '''snd_open: string/shader''' Defines the sound that is to be played whenever the door is opened. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_close: string/shader''' Same as above. Default: sound/misc/creakydooropen.ogg<br />
<br />
* '''snd_locked: string''' Defines the sound that is to be played whenever a door is locked and the player tries to open the door. Default: sound/misc/doorlocked_t2.ogg<br />
<br />
* '''snd_unlock: string''' Defines the sound that is to be played whenever the door is successfully unlocked. Default: sound/misc/unlocked_t2.ogg" <br />
<br />
[[Category:Editing]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2244Inventory2007-02-12T20:57:26Z<p>Sparhawk: /* Spawnargs */</p>
<hr />
<div>= Overview =<br />
This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an errr message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
== Spawnargs ==<br />
<br />
inv_category : string<br />
Specifies the cagtegory that the object should be filed under. This <br />
allows for player convenience and also is needed for stackable items.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_name : string<br />
Specifies the name the object should display when it is activated in the inventory.<br />
Keep in mind that the display name and the category together are used to determine,<br />
if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you<br />
create to "Health Potion" items, but with different categories, they are treated as <br />
different items.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_icon : D3 path to icon<br />
Points to an icon that is to be displayed when the object is selected in the inventory.<br />
This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
inv_stackable : [0/1]<br />
Determines wether an item is an individual or can be a stack of similar objects. An<br />
Example would be the various potions. The player can pick up more than one health <br />
potion, but in the inventory he will only get one item with a counter. Keep in mind<br />
though, that a stack of gold coins is not per se stackable, because usually it will be<br />
only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it<br />
is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
inv_item_id : string<br />
This key can be set by the mapper to an arbitrary value. This is needed if the mapper<br />
wants to implement custom behaviour and he uniquily need to identfy an item or a group<br />
of items. Normally the mapper could also use the inv_name for this key, but this doesn't <br />
allow the additional flexibillity. For example a mapper can create a fake health potion<br />
which shows up in the inventory just like a regular one, with the same name but a differten<br />
map model. So if the player picks this bottle up, because he doesn't look carefull and<br />
thinks he got a health potion, he might have aquired a real one, while this one actually<br />
may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This<br />
will of course only work with additional scripting, because the mapper must know what to<br />
do with it. In this case the mapper might set a flag on the callback, and the next time the <br />
player uses a health potion, the action is triggered.<br />
<br />
inv_count : <N><br />
Determines the number of items this represents. This is only needed for items where<br />
stackable is 1, otherwise it is set to 0. Als the option for stackable must always <br />
precede the count, otherwise the count is set to 0.<br />
<br />
inv_droppable : [0/1]<br />
If set to 1 the item can be dropped into the map by the player. This will not<br />
work for anonymous items, since they will have no representation after they<br />
were put into the inventory.<br />
<br />
inv_delete : [0/1]<br />
Determines if an anonymous object can be deleted, after it was put into the inventory.<br />
This is advisable, because the entity will stay in memory and a mapper could still<br />
access it via scripting. If the mapper decides that an item will no longer be accessed<br />
after it has been acquired, this key should be set to 1. This can affect loading time<br />
of saved games, as entities, that are no longer needed, don't need to be saved and<br />
restored.<br />
If the mapper also creates entities on the fly, with the help of scripts, it might<br />
better to set this flag on appropriate objects to free up the limited number of<br />
entities a map can hold. The usuals candidates for this flag are all the regular loot<br />
items, because they wont be used anymore after they have been found (lik coins, purses,<br />
etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since<br />
droppabale items must be turned into entities again to be placed in the map.<br />
<br />
inv_loot_type : [ 0 | 1 | 2 | 3 ]<br />
* 0 = No lootitem (default)<br />
* 1 = Jewelry/Gems<br />
* 2 = Gold<br />
* 3 = Goods<br />
This has to be set in order to define what kind of item it is and if it is a loot item,<br />
which category of loot it should account for.<br />
<br />
inv_loot_value : <N><br />
Determines the amount of loot this item accounts for. This value is ignore if it is<br />
set on an item, which is of loot_type = 0.<br />
<br />
inv_map_start : [0|1]<br />
Determines wether this object should be assigned to an inventory at map start.<br />
<br />
inv_target : <entityname><br />
If the item should be assigned to an entity at map start, this should get the name<br />
of the entity who shold recive it. To give an item to the player, you would use<br />
"player1" as the name, because this is the name that the player entity gets by<br />
default. If inv_map_start is not set or set to 0, then this key doesn't need to be<br />
set and is ignored. Since the name can be arbitrary, this means of course, that you<br />
can also give it to an AI, which the player later on meets. This should not be confused<br />
with loot, that is to be attached to an AI though. If you attach a purse or a key to<br />
an AI, which the player can frob later on, then it doesn't need to get this set, because<br />
such things will not be stored in the inventory. You could assign such things to an<br />
chest though, to give the objects to the player when he opens it. This is not directly<br />
support though, because it is assumed that chests will be filled with real objects, like<br />
TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2243Inventory2007-02-12T20:57:05Z<p>Sparhawk: /* Spawnargs */</p>
<hr />
<div>= Overview =<br />
This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an errr message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
== Spawnargs ==<br />
<br />
inv_category : string<br />
Specifies the cagtegory that the object should be filed under. This <br />
allows for player convenience and also is needed for stackable items.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_name : string<br />
Specifies the name the object should display when it is activated in the inventory.<br />
Keep in mind that the display name and the category together are used to determine,<br />
if the inv_stackable flag is set to 1, wether this is a similar item or not. So if you<br />
create to "Health Potion" but with different categories, they are treated as different<br />
items.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_icon : D3 path to icon<br />
Points to an icon that is to be displayed when the object is selected in the inventory.<br />
This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
inv_stackable : [0/1]<br />
Determines wether an item is an individual or can be a stack of similar objects. An<br />
Example would be the various potions. The player can pick up more than one health <br />
potion, but in the inventory he will only get one item with a counter. Keep in mind<br />
though, that a stack of gold coins is not per se stackable, because usually it will be<br />
only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it<br />
is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
inv_item_id : string<br />
This key can be set by the mapper to an arbitrary value. This is needed if the mapper<br />
wants to implement custom behaviour and he uniquily need to identfy an item or a group<br />
of items. Normally the mapper could also use the inv_name for this key, but this doesn't <br />
allow the additional flexibillity. For example a mapper can create a fake health potion<br />
which shows up in the inventory just like a regular one, with the same name but a differten<br />
map model. So if the player picks this bottle up, because he doesn't look carefull and<br />
thinks he got a health potion, he might have aquired a real one, while this one actually<br />
may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This<br />
will of course only work with additional scripting, because the mapper must know what to<br />
do with it. In this case the mapper might set a flag on the callback, and the next time the <br />
player uses a health potion, the action is triggered.<br />
<br />
inv_count : <N><br />
Determines the number of items this represents. This is only needed for items where<br />
stackable is 1, otherwise it is set to 0. Als the option for stackable must always <br />
precede the count, otherwise the count is set to 0.<br />
<br />
inv_droppable : [0/1]<br />
If set to 1 the item can be dropped into the map by the player. This will not<br />
work for anonymous items, since they will have no representation after they<br />
were put into the inventory.<br />
<br />
inv_delete : [0/1]<br />
Determines if an anonymous object can be deleted, after it was put into the inventory.<br />
This is advisable, because the entity will stay in memory and a mapper could still<br />
access it via scripting. If the mapper decides that an item will no longer be accessed<br />
after it has been acquired, this key should be set to 1. This can affect loading time<br />
of saved games, as entities, that are no longer needed, don't need to be saved and<br />
restored.<br />
If the mapper also creates entities on the fly, with the help of scripts, it might<br />
better to set this flag on appropriate objects to free up the limited number of<br />
entities a map can hold. The usuals candidates for this flag are all the regular loot<br />
items, because they wont be used anymore after they have been found (lik coins, purses,<br />
etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since<br />
droppabale items must be turned into entities again to be placed in the map.<br />
<br />
inv_loot_type : [ 0 | 1 | 2 | 3 ]<br />
* 0 = No lootitem (default)<br />
* 1 = Jewelry/Gems<br />
* 2 = Gold<br />
* 3 = Goods<br />
This has to be set in order to define what kind of item it is and if it is a loot item,<br />
which category of loot it should account for.<br />
<br />
inv_loot_value : <N><br />
Determines the amount of loot this item accounts for. This value is ignore if it is<br />
set on an item, which is of loot_type = 0.<br />
<br />
inv_map_start : [0|1]<br />
Determines wether this object should be assigned to an inventory at map start.<br />
<br />
inv_target : <entityname><br />
If the item should be assigned to an entity at map start, this should get the name<br />
of the entity who shold recive it. To give an item to the player, you would use<br />
"player1" as the name, because this is the name that the player entity gets by<br />
default. If inv_map_start is not set or set to 0, then this key doesn't need to be<br />
set and is ignored. Since the name can be arbitrary, this means of course, that you<br />
can also give it to an AI, which the player later on meets. This should not be confused<br />
with loot, that is to be attached to an AI though. If you attach a purse or a key to<br />
an AI, which the player can frob later on, then it doesn't need to get this set, because<br />
such things will not be stored in the inventory. You could assign such things to an<br />
chest though, to give the objects to the player when he opens it. This is not directly<br />
support though, because it is assumed that chests will be filled with real objects, like<br />
TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2242Inventory2007-02-12T20:55:50Z<p>Sparhawk: /* Spawnargs */</p>
<hr />
<div>= Overview =<br />
This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an errr message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
== Spawnargs ==<br />
<br />
inv_category : string<br />
Specifies the cagtegory that the object should be filed under. This <br />
allows for player convenience and also is needed for stackable items.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_name : string<br />
Specifies the name the object should display when it is activated in the inventory.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_icon : D3 path to icon<br />
Points to an icon that is to be displayed when the object is selected in the inventory.<br />
This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
inv_stackable : [0/1]<br />
Determines wether an item is an individual or can be a stack of similar objects. An<br />
Example would be the various potions. The player can pick up more than one health <br />
potion, but in the inventory he will only get one item with a counter. Keep in mind<br />
though, that a stack of gold coins is not per se stackable, because usually it will be<br />
only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it<br />
is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
inv_item_id : string<br />
This key can be set by the mapper to an arbitrary value. This is needed if the mapper<br />
wants to implement custom behaviour and he uniquily need to identfy an item or a group<br />
of items. Normally the mapper could also use the inv_name for this key, but this doesn't <br />
allow the additional flexibillity. For example a mapper can create a fake health potion<br />
which shows up in the inventory just like a regular one, with the same name but a differten<br />
map model. So if the player picks this bottle up, because he doesn't look carefull and<br />
thinks he got a health potion, he might have aquired a real one, while this one actually<br />
may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This<br />
will of course only work with additional scripting, because the mapper must know what to<br />
do with it. In this case the mapper might set a flag on the callback, and the next time the <br />
player uses a health potion, the action is triggered.<br />
<br />
inv_count : <N><br />
Determines the number of items this represents. This is only needed for items where<br />
stackable is 1, otherwise it is set to 0. Als the option for stackable must always <br />
precede the count, otherwise the count is set to 0.<br />
<br />
inv_droppable : [0/1]<br />
If set to 1 the item can be dropped into the map by the player. This will not<br />
work for anonymous items, since they will have no representation after they<br />
were put into the inventory.<br />
<br />
inv_delete : [0/1]<br />
Determines if an anonymous object can be deleted, after it was put into the inventory.<br />
This is advisable, because the entity will stay in memory and a mapper could still<br />
access it via scripting. If the mapper decides that an item will no longer be accessed<br />
after it has been acquired, this key should be set to 1. This can affect loading time<br />
of saved games, as entities, that are no longer needed, don't need to be saved and<br />
restored.<br />
If the mapper also creates entities on the fly, with the help of scripts, it might<br />
better to set this flag on appropriate objects to free up the limited number of<br />
entities a map can hold. The usuals candidates for this flag are all the regular loot<br />
items, because they wont be used anymore after they have been found (lik coins, purses,<br />
etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since<br />
droppabale items must be turned into entities again to be placed in the map.<br />
<br />
inv_loot_type : [ 0 | 1 | 2 | 3 ]<br />
* 0 = No lootitem (default)<br />
* 1 = Jewelry/Gems<br />
* 2 = Gold<br />
* 3 = Goods<br />
This has to be set in order to define what kind of item it is and if it is a loot item,<br />
which category of loot it should account for.<br />
<br />
inv_loot_value : <N><br />
Determines the amount of loot this item accounts for. This value is ignore if it is<br />
set on an item, which is of loot_type = 0.<br />
<br />
inv_map_start : [0|1]<br />
Determines wether this object should be assigned to an inventory at map start.<br />
<br />
inv_target : <entityname><br />
If the item should be assigned to an entity at map start, this should get the name<br />
of the entity who shold recive it. To give an item to the player, you would use<br />
"player1" as the name, because this is the name that the player entity gets by<br />
default. If inv_map_start is not set or set to 0, then this key doesn't need to be<br />
set and is ignored. Since the name can be arbitrary, this means of course, that you<br />
can also give it to an AI, which the player later on meets. This should not be confused<br />
with loot, that is to be attached to an AI though. If you attach a purse or a key to<br />
an AI, which the player can frob later on, then it doesn't need to get this set, because<br />
such things will not be stored in the inventory. You could assign such things to an<br />
chest though, to give the objects to the player when he opens it. This is not directly<br />
support though, because it is assumed that chests will be filled with real objects, like<br />
TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Inventory&diff=2241Inventory2007-02-12T20:54:00Z<p>Sparhawk: /* Spawnargs */</p>
<hr />
<div>= Overview =<br />
This article describes how to set up inventory items and how they can be given to an entity. The purpose of the inventory is, to keep track of all items that are in an entities possessions. I delibaretly use "entity" here because, in principle, all entities can have an inventory, even though it may only make sense for AI and the player to actuall have one. For future improvements it might be usefull for other purposes as well though.<br />
Also included is a script interface, so that a mapper can interact with the inventory in a more sophisticated way, if the default implementation is not sufficient.<br />
<br />
== Definitions ==<br />
<br />
The spawnargs can be either set in the def file as a default, or in the map file to override settings for specific entities. Naturaly this also means that they can be manipulated by scripts as well, since they are the standard way of configuring objects in Doom 3.<br />
<br />
'''IMPORTANT!!!''' Normally items will vanish from the map as soon as the item is successfully put into the inventory. If this doesn't work, then the item will stay visible. This is a intentionally so, to make the mapper aware of the problem. Currently there is only one error condition that can really trigger this, which is that an item is configured to not be anonymous, but has an empty inv_icon entry. Additionally to not becoming invisible, you can also look into the logfile, because there you can find an errr message with the name of the entity that was causing the problem.<br />
<br />
There are several terms and types of items that can be used in the inventory:<br />
<br />
* '''anonymous items''' An anonymous object means that it will not show up as a seperate item in the inventory. An example would be normal loot like coins or golden dishes. Since they should not be stored in the inventory as seperate items, they don't need to be displayed either. In this case they only count for the total of loot and are discarded afterwards. Anonymous items also can not be dropped after they went into the inventory because they essentially no longer exist. For the loot count it obviously doesn't matter wether an item is anonymous or not, as all are added up into the loot categories. Examples are gold coins and all the other (mostly loot) items that are collected but not being used individually. <br />
<br />
* '''stackable items''' These are items that can be stacked in the inventory. This means that the player can acquire multiple instances of such items, but only one entry is shown in the inventory with a counter of how many currently are available. An example would be a health potion. The player can posses more than one health potion at a time and this would be indicated by the counter. Stackable items are identified by setting the stackable property. They also must always use the same name and category. If this doesn't match, they are considered to be of different types. This also allows for dealing out i.e. fake health potions which have no effect or deal damage instead (as an example).<br />
<br />
* '''Category''' is a classification of items, to visually group them together. This allows the player to faster scroll through the inventory because he doesn't have to cycle through all the individual items. For example a category would be 'Readables' where books and scrolls are stored, and another Category would be 'Tools' where lockpicks and other items can be stored. Note that this category is entirely up to the mapper to decide and also is option. it doesn't has any consequence as to the playabillity and is only a convenience for the player. Categories can switched of on the HUD, so that the player can use the inventory also in the Thief style (which is the default).<br />
<br />
== Spawnargs ==<br />
<br />
inv_category : string<br />
Specifies the cagtegory that the object should be filed under. This <br />
allows for player convenience and also is needed for stackable items.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_name : string<br />
Specifies the name the object should display when it is activated in the inventory.<br />
example: "inv_name" "Health Potion"<br />
<br />
inv_icon : D3 path to icon<br />
Points to an icon that is to be displayed when the object is selected in the inventory.<br />
This entry also determines wether an object is to be considered anonymous or not. <br />
<br />
inv_stackable : [0/1]<br />
Determines wether an item is an individual or can be a stack of similar objects. An<br />
Example would be the various potions. The player can pick up more than one health <br />
potion, but in the inventory he will only get one item with a counter. Keep in mind<br />
though, that a stack of gold coins is not per se stackable, because usually it will be<br />
only one model of a stack of coin with a value of i.E. 10 Gold, so this means that it<br />
is not to be confused with a single gold coin having 10 items with a value of 1 each.<br />
<br />
inv_item_id : string<br />
This key can be set by the mapper to an arbitrary value. This is needed if the mapper<br />
wants to implement custom behaviour and he uniquily need to identfy an item or a group<br />
of items. Normally the mapper could also use the inv_name for this key, but this doesn't <br />
allow the additional flexibillity. For example a mapper can create a fake health potion<br />
which shows up in the inventory just like a regular one, with the same name but a differten<br />
map model. So if the player picks this bottle up, because he doesn't look carefull and<br />
thinks he got a health potion, he might have aquired a real one, while this one actually<br />
may deal some damage or doesn't work at all, or whatever the mapper wants it to do. This<br />
will of course only work with additional scripting, because the mapper must know what to<br />
do with it.<br />
<br />
inv_count : <N><br />
Determines the number of items this represents. This is only needed for items where<br />
stackable is 1, otherwise it is set to 0. Als the option for stackable must always <br />
precede the count, otherwise the count is set to 0.<br />
<br />
inv_droppable : [0/1]<br />
If set to 1 the item can be dropped into the map by the player. This will not<br />
work for anonymous items, since they will have no representation after they<br />
were put into the inventory.<br />
<br />
inv_delete : [0/1]<br />
Determines if an anonymous object can be deleted, after it was put into the inventory.<br />
This is advisable, because the entity will stay in memory and a mapper could still<br />
access it via scripting. If the mapper decides that an item will no longer be accessed<br />
after it has been acquired, this key should be set to 1. This can affect loading time<br />
of saved games, as entities, that are no longer needed, don't need to be saved and<br />
restored.<br />
If the mapper also creates entities on the fly, with the help of scripts, it might<br />
better to set this flag on appropriate objects to free up the limited number of<br />
entities a map can hold. The usuals candidates for this flag are all the regular loot<br />
items, because they wont be used anymore after they have been found (lik coins, purses,<br />
etc.). Also note that, if dropappable is set to 1, then this key will be ignored, since<br />
droppabale items must be turned into entities again to be placed in the map.<br />
<br />
inv_loot_type : [ 0 | 1 | 2 | 3 ]<br />
* 0 = No lootitem (default)<br />
* 1 = Jewelry/Gems<br />
* 2 = Gold<br />
* 3 = Goods<br />
This has to be set in order to define what kind of item it is and if it is a loot item,<br />
which category of loot it should account for.<br />
<br />
inv_loot_value : <N><br />
Determines the amount of loot this item accounts for. This value is ignore if it is<br />
set on an item, which is of loot_type = 0.<br />
<br />
inv_map_start : [0|1]<br />
Determines wether this object should be assigned to an inventory at map start.<br />
<br />
inv_target : <entityname><br />
If the item should be assigned to an entity at map start, this should get the name<br />
of the entity who shold recive it. To give an item to the player, you would use<br />
"player1" as the name, because this is the name that the player entity gets by<br />
default. If inv_map_start is not set or set to 0, then this key doesn't need to be<br />
set and is ignored. Since the name can be arbitrary, this means of course, that you<br />
can also give it to an AI, which the player later on meets. This should not be confused<br />
with loot, that is to be attached to an AI though. If you attach a purse or a key to<br />
an AI, which the player can frob later on, then it doesn't need to get this set, because<br />
such things will not be stored in the inventory. You could assign such things to an<br />
chest though, to give the objects to the player when he opens it. This is not directly<br />
support though, because it is assumed that chests will be filled with real objects, like<br />
TDS did it. However the T1/T2 style chests are still possible to do with some scripting.<br />
<br />
== Default equipment for map start ==<br />
<br />
This describes how to give items to the player at the mapstart, but the same mechanism can be applied to any other AI (or entity for that matter) as well.<br />
<br />
* First create your object in the editor, just like you would if you wanted to put it in the map. Create brush, select the item and/or models and place it anywhere you like in the map<br />
<br />
* Set the key inv_map_start on the object entity to the value 1.<br />
<br />
* Set the key inv_target on the object entity to the value player1. If you want to assign this object to, as an example, a guard with the name Benny, then set it to benny, assuming the entity key "name" is also set to "benny".<br />
<br />
The objects can really be placed anyhwere you like and it doesn't really matter. As soon as the map starts, the objects will be put in the inventory, and will vanish from the map. So you could put them right in front of the players eyes, and he still wouldn't see them, as this happens at the intialization time, before the map actually becomes visible.<br />
<br />
That's it. Quite simple I would say. :)<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Objectives&diff=2189Objectives2007-02-05T21:00:02Z<p>Sparhawk: /* Objective Attributes */</p>
<hr />
<div>{{Original_Reference|Ishtvan|4121}}<br />
<br />
= Overview =<br />
A mapper may add on objectives by setting key/values on a [[target_addobjectives]] and triggering it. If you want to add objectives at the very beginning of the map, put in a target_addobjectives and put that entity in as a target of the [[worldspawn]]. The worldspawn will trigger it on map start.<br />
<br />
Objectives consist of overall objectives, objective components, and boolean relationships for failure and success. A map can have any number of overall objectives, and each objective can have any number of components.<br />
<br />
== Example ==<br />
Objective 1 text: ''"Kidnap Benny and get out to the streets"''<br />
<br />
'''Objective 1 Components:'''<br />
# Benny is KO'd<br />
# Benny is at the map exit<br />
# Player is at the map exit<br />
# NOT( Benny is dead )<br />
<br />
'''Boolean relationship for Obj. 1 COMPLETION:'''<br />
1 AND 2 AND 3 AND 4<br />
<br />
'''Boolean relationship for Obj. 1 FAILURE:'''<br />
NOT(4) (If Benny is dead we can't kidnap him alive)<br />
<br />
= Objective Attributes =<br />
<br />
* '''Possible Objective States:'''<br />
:* OBJ_INCOMPLETE<br />
:* OBJ_COMPLETE<br />
:* OBJ_FAILED<br />
:* OBJ_INVALID<br />
<br />
* '''Mandatory:''' Set to false for optional objective that doesn't fail the mission if you fail it.<br />
<br />
* '''Irreversible:''' Irreversible objectives lock their state once they're changed to COMPLETE or FAILED. Irreversible components will only change state once and then stay in that state. (Note: There are scriptfunctions to reset irreversible objectives and components if the FM author wants to let them change again for some reason).<br />
<br />
* '''Ongoing:''' Use this for objectives that should remain successful, but won't be checked off until the end of the mission. For example, "don't blackjack more than two people" is successful at the start of the mission, because you haven't blackjacked anyone yet, but when you KO one person and the KO callback is made to the objective system, and the system then sees that only one person has been KO'd, the system needs some way of knowing not to say "Objective Complete" when you KO that first person, i.e., that this is an ongoing objective.<br />
<br />
* '''Visible:''' Whether the objective appears in the player's Objectives GUI. Use invalidated and hidden objectives to queue up objectives for later, or hidden but valid objectives as anothe way of scripting events when the player does a certain thing, since objectives can launch an arbitrary script after they're completed.<br />
<br />
* '''Difficulty:''' NOT YET IMPLEMENTED<br />
<br />
* '''Enabling Objectives:''' This is a list of other objectives that must first be completed before this objective can be completed. For example, we shouldn't mark "objective complete" for exiting the mission until all the other mission goals have been completed.<br />
<br />
* '''Completion/Failure scripts:''' Name of a script to call when this objective is completed or failed. For example, this could be used in campaigns to set up optional objectives in one mission that effect other missions. This feature could also be used as a general scripting aide if the author wants to set up the conditions for something happening using a hidden objective.<br />
<br />
= Objective Component Attributes =<br />
<br />
'''Possible 'Objective Component' Types:'''<br />
* item (picked up or dropped an inventory item)<br />
* kill (also includes non-living things being destroyed)<br />
* ko<br />
* ai_find_item (not implemented)<br />
* ai_find_body (not implemented)<br />
* alert<br />
* location (Item A at location B, where "A" is any entity that must have the key "objective_ent" set to "1" on it, and location B is a special entity info_objective_location. Later on we may support using the D3 location system as well)<br />
* custom (custom component that is set true/false by a map script)<br />
<br />
These components are triggered every N milliseconds by a system clock:<br />
* distance (distance between the origin of entity X and that of entity Y)<br />
* custom_clocked (runs a custom map script that should check something and set the objective)<br />
<br />
'''Specification Methods:'''<br />
Specification methods determine what the objective component is looking for. Does it look at how many AI of a specific team you've KO'd, how many humans, how many overall, or whether you've KO'd an AI with a certain name? Each objective component can have up to two of the following specifiers (Not all components can take two specifiers, and not all specifiers make sense for all component types, future documentation will cover that).<br />
<br />
'''The following apply to both AIs and items:'''<br />
* none<br />
* name (name of entity)<br />
* overall (overall count of something: kills, loot, kos, etc)<br />
* group (inventory group)<br />
* classname (soft/scripting classname)<br />
* spawnclass (hard / SDK classname)<br />
<br />
'''The following specification methods apply only to AI:'''<br />
* ai_type (human, beast, undead, bot, etc)<br />
* ai_team (mapper defined team of the AI)<br />
* ai_innocence (For distinguishing noncombatants)<br />
<br />
'''Integer and String Arguments:'''<br />
A component can have an arbitrary number of int and string arguments that are fed in space delimited lists. The type of component and specifier determines which args it will use and what it will do with them. For example, the first integer arg is often used to determine how many times something can happen, e.g., the player is only allowed 4 KOs, or must get 500 loot. Not all events are counted up though. The only things that are counted up are things in the mission statistics like loot and kills, so everything else is pretty much a one shot deal where it happens once. Future documentation will detail which objective events are counted up and which are one shots.<br />
<br />
== Additional Component Attributes ==<br />
<br />
* not (If this is set, the component is considered NOTed. So if the component is to kill 5 AI, and it's NOTted, it will remain true until 5 AI are killed, then be set to false)<br />
* Irreversible<br />
* clock_interval (For clocked components, this determines how often they are updated)<br />
<br />
= Conclusion =<br />
Using components that combine component types with up to 2 entity arguments and 2 specifier types, plus objectives that are a boolean combination of those components should hopefully allow for a variety of different objectives.<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Objectives&diff=2188Objectives2007-02-05T20:57:05Z<p>Sparhawk: </p>
<hr />
<div>{{Original_Reference|Ishtvan|4121}}<br />
<br />
= Overview =<br />
A mapper may add on objectives by setting key/values on a [[target_addobjectives]] and triggering it. If you want to add objectives at the very beginning of the map, put in a target_addobjectives and put that entity in as a target of the [[worldspawn]]. The worldspawn will trigger it on map start.<br />
<br />
Objectives consist of overall objectives, objective components, and boolean relationships for failure and success. A map can have any number of overall objectives, and each objective can have any number of components.<br />
<br />
== Example ==<br />
Objective 1 text: ''"Kidnap Benny and get out to the streets"''<br />
<br />
'''Objective 1 Components:'''<br />
# Benny is KO'd<br />
# Benny is at the map exit<br />
# Player is at the map exit<br />
# NOT( Benny is dead )<br />
<br />
'''Boolean relationship for Obj. 1 COMPLETION:'''<br />
1 AND 2 AND 3 AND 4<br />
<br />
'''Boolean relationship for Obj. 1 FAILURE:'''<br />
NOT(4) (If Benny is dead we can't kidnap him alive)<br />
<br />
= Objective Attributes =<br />
<br />
* '''Possible Objective States:'''<br />
:* OBJ_INCOMPLETE<br />
:* OBJ_COMPLETE<br />
:* OBJ_FAILED<br />
:* OBJ_INVALID<br />
<br />
* '''Mandatory:''' Set to false for optional objective that doesn't fail the mission if you fail it.<br />
<br />
* '''Irreversible:''' Irreversible objectives lock their state once they're changed to COMPLETE or FAILED. Irreversible components will only change state once and then change in that state. (Note: There are scriptfunctions to reset irreversible objectives and components if the FM author wants to let them change again for some reason).<br />
<br />
* '''Ongoing:''' Use this for objectives that should remain successful, but won't be checked off until the end of the mission. For example, "don't blackjack more than two people" is successful at the start of the mission, because you haven't blackjacked anyone yet, but when you KO one person and the KO callback is made to the objective system, and the system then sees that only one person has been KO'd, the system needs some way of knowing not to say "Objective Complete" when you KO that first person, i.e., that this is an ongoing objective.<br />
<br />
* '''Visible:''' Whether the objective appears in the player's Objectives GUI. Use invalidated and hidden objectives to queue up objectives for later, or hidden but valid objectives as anothe way of scripting events when the player does a certain thing, since objectives can launch an arbitrary script after they're completed.<br />
<br />
* '''Difficulty:''' NOT YET IMPLEMENTED<br />
<br />
* '''Enabling Objectives:''' This is a list of other objectives that must first be completed before this objective can be completed. For example, we shouldn't mark "objective complete" for exiting the mission until all the other mission goals have been completed.<br />
<br />
* '''Completion/Failure scripts:''' Name of a script to call when this objective is completed or failed. For example, this could be used in campaigns to set up optional objectives in one mission that effect other missions. This feature could also be used as a general scripting aide if the author wants to set up the conditions for something happening using a hidden objective.<br />
<br />
= Objective Component Attributes =<br />
<br />
'''Possible 'Objective Component' Types:'''<br />
* item (picked up or dropped an inventory item)<br />
* kill (also includes non-living things being destroyed)<br />
* ko<br />
* ai_find_item (not implemented)<br />
* ai_find_body (not implemented)<br />
* alert<br />
* location (Item A at location B, where "A" is any entity that must have the key "objective_ent" set to "1" on it, and location B is a special entity info_objective_location. Later on we may support using the D3 location system as well)<br />
* custom (custom component that is set true/false by a map script)<br />
<br />
These components are triggered every N milliseconds by a system clock:<br />
* distance (distance between the origin of entity X and that of entity Y)<br />
* custom_clocked (runs a custom map script that should check something and set the objective)<br />
<br />
'''Specification Methods:'''<br />
Specification methods determine what the objective component is looking for. Does it look at how many AI of a specific team you've KO'd, how many humans, how many overall, or whether you've KO'd an AI with a certain name? Each objective component can have up to two of the following specifiers (Not all components can take two specifiers, and not all specifiers make sense for all component types, future documentation will cover that).<br />
<br />
'''The following apply to both AIs and items:'''<br />
* none<br />
* name (name of entity)<br />
* overall (overall count of something: kills, loot, kos, etc)<br />
* group (inventory group)<br />
* classname (soft/scripting classname)<br />
* spawnclass (hard / SDK classname)<br />
<br />
'''The following specification methods apply only to AI:'''<br />
* ai_type (human, beast, undead, bot, etc)<br />
* ai_team (mapper defined team of the AI)<br />
* ai_innocence (For distinguishing noncombatants)<br />
<br />
'''Integer and String Arguments:'''<br />
A component can have an arbitrary number of int and string arguments that are fed in space delimited lists. The type of component and specifier determines which args it will use and what it will do with them. For example, the first integer arg is often used to determine how many times something can happen, e.g., the player is only allowed 4 KOs, or must get 500 loot. Not all events are counted up though. The only things that are counted up are things in the mission statistics like loot and kills, so everything else is pretty much a one shot deal where it happens once. Future documentation will detail which objective events are counted up and which are one shots.<br />
<br />
== Additional Component Attributes ==<br />
<br />
* not (If this is set, the component is considered NOTed. So if the component is to kill 5 AI, and it's NOTted, it will remain true until 5 AI are killed, then be set to false)<br />
* Irreversible<br />
* clock_interval (For clocked components, this determines how often they are updated)<br />
<br />
= Conclusion =<br />
Using components that combine component types with up to 2 entity arguments and 2 specifier types, plus objectives that are a boolean combination of those components should hopefully allow for a variety of different objectives.<br />
<br />
[[Category:Editing]]<br />
[[Category:Tutorial]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Main_Page&diff=2066Main Page2006-11-01T13:27:50Z<p>Sparhawk: </p>
<hr />
<div><p style="margin:2em 0 0 0; text-align:center; font-size:200%;">Welcome to the Dark Wiki</p><br />
<p style="margin:0 0 3em 0; text-align:center; font-size:94%">A wiki documenting the Dark Mod for Doom 3</p><br />
<br />
<table align="center" width="90%" cellspacing="10"><tr><br />
<td style="width:50%; vertical-align:top; padding:2em; border:1px solid #e1e1e1; background-color:#f9f9f9"><br />
<br />
<p style="font-size:130%">'''New to the site?'''</p><br />
<br />
This wiki is focused on documenting the various aspects involved with developing, and mapping for, [[The Dark Mod]]. Please visit the about page or talk to some of our editors in #darkmod on irc.starchat.net if you want to learn more about this project.<br />
<br />
<p style="font-size:130%">'''Want to help?'''</p><br />
<br />
As the modwiki is a community project, feel free to register and join us on this great endeavour! Please check out the style guide first and follow these guidelines. Visit open tasks to find out which pages need help. You can also visit the sandbox to experiment with the wiki markup language.<br />
<br />
<p style="font-size:130%">'''Need Help with Wiki Articles?'''</p><br />
If you need help creating, editing or formatting wiki articles, take a look at our '''[[Basic Wiki Tutorial]]'''.<br />
<br />
<p style="font-size:130%">'''High quality links:'''</p><br />
<br />
Other interesting Dark Mod related links:<br />
<br />
; [http://www.thedarkmod.com www.thedarkmod.com] : The project website<br />
; [http://www.modetwo.net/darkmod www.modetwo.net/darkmod] : The project forum<br />
<br />
[[TheDarkWiki:Policy|The Dark Wiki Editing Policy]]<br />
<br />
</td><td style="vertical-align:top; padding:2em; border:1px solid #e1e1e1; background-color:#f9f9f9"><br />
<br />
<p style="font-size:130%">'''Editing Categories:'''</p><br />
<br />
; [[Installation]] : Information how to get The Dark Mod running<br />
; [[Bindings and User Settings]] : Key binding and interface documentation.<br />
; [[Universe]] : Information about The Dark Mod universe and setting<br />
; [[:Category:Tutorial|Tutorials]] : Complete tutorials about setting up certain characteristics<br />
; [[:Category:Editing|Editing]] : Information about level design and the tools<br />
; [[Textures]] : Explanation of material shaders and image files<br />
; [[Modeling]] : Modeling and file format information<br />
; [[Sound]] : Soundeffects, ambients and how to get them ingame<br />
; [[Coding]] : Source code modification, level and GUI scripting<br />
; [[Release]] : How to pack a mission, and get it tested and released!<br />
; [[Developer Info]] : Internal informations for developers of the core team<br />
; [[Articles that need to be fixed]] : Links to pages which have wrong or missing information or otherwise require attention.<br />
<br />
</td></tr></table><br />
<p style="margin:2em 0 2em 0; text-align:center; font-size:94%">(Create a new page by making a link to it, then click it. Or you can just go to www.thirdfilms.com/darkwiki/yourpagename)</p></div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Tutorials&diff=1619Tutorials2006-06-20T07:41:19Z<p>Sparhawk: </p>
<hr />
<div>Each tutorial is supposed to cover a complete topic without assuming prior knowledge about the topic in question.<br />
<br />
[[Creating doors]]<br />
<br />
[[Stim/Response]]</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Main_Page&diff=1618Main Page2006-06-20T07:39:39Z<p>Sparhawk: </p>
<hr />
<div><p style="margin:2em 0 0 0; text-align:center; font-size:200%;">Welcome to the Dark Wiki</p><br />
<p style="margin:0 0 3em 0; text-align:center; font-size:94%">A wiki documenting the Dark Mod for Doom 3</p><br />
<br />
<table align="center" width="90%" cellspacing="10"><tr><br />
<td style="width:50%; vertical-align:top; padding:2em; border:1px solid #e1e1e1; background-color:#f9f9f9"><br />
<br />
<p style="font-size:130%">'''New to the site?'''</p><br />
<br />
This wiki is focused on documenting the various aspects involved with developing, and mapping, for The Dark Mod. Please visit the about page or talk to some of our editors in #darkmod on irc.starchat.net if you want to learn more about this project.<br />
<br />
<p style="font-size:130%">'''Want to help?'''</p><br />
<br />
As the modwiki is a community project, feel free to register and join us on this great endeavour! Please check out the style guide first and follow these guidelines. Visit open tasks to find out which pages need help. You can also visit the sandbox to experiment with the wiki markup language.<br />
<br />
<p style="font-size:130%">'''High quality links:'''</p><br />
<br />
Other interesting Dark Mod related links:<br />
<br />
; [http://www.thedarkmod.com www.thedarkmod.com] : The project website<br />
; [http://www.modetwo.net/darkmod www.modetwo.net/darkmod] : The project forum<br />
<br />
[[TheDarkWiki:Policy|The Dark Wiki Editing Policy]]<br />
<br />
</td><td style="vertical-align:top; padding:2em; border:1px solid #e1e1e1; background-color:#f9f9f9"><br />
<br />
<p style="font-size:130%">'''Editing Categories:'''</p><br />
<br />
; [[Installation]] : Information how to get The Dark Mod running<br />
; [[Universe]] : Information about The Dark Mod universe and setting<br />
; [[Tutorials]] : Complete tutorials about setting up certain characteristics<br />
; [[Editing]] : Information about level design and the tools<br />
; [[Textures]] : Explanation of material shaders and image files<br />
; [[Modeling]] : Modeling and file format information<br />
; [[Sound]] : Soundeffects, ambients and how to get them ingame<br />
; [[Coding]] : Source code modification, level and GUI scripting<br />
; [[Release]] : How to pack a mission, and get it tested and released!<br />
; [[Developer Info]] : Internal informations for developers of the core team<br />
<br />
</td></tr></table><br />
<p style="margin:2em 0 2em 0; text-align:center; font-size:94%">(Create a new page by making a link to it, then click it. Or you can just go to www.thirdfilms.com/darkwiki/yourpagename)</p></div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Stim/Response&diff=1613Stim/Response2006-02-07T12:38:52Z<p>Sparhawk: </p>
<hr />
<div>'''Stim/Response system for The Dark Mod'''<br />
<br />
This article describes how the stim/response system works for '''The Dark Mod'''. The name is taken from the Dromed Stim/Response system. However this does '''not''' mean that you should assume any other similarities. The system was described to me (sparhawk) and I coded it accordingly, but I have no Dromed experience, beyond some '''very''' simple maps, without any special features. I never got beyond the "Create a room and texture it" stage. :)<br />
So while this system may be similar on how it works as seen by the users, you can't assume that this is is more then a fleeting similarity as defined by it's common requirements.<br />
<br />
<br />
<br />
'''How does it work?'''<br />
<br />
The general concept is pretty easy to understand. The mapper populates his map with entities. Each of this entities, can be either a kind of actor (a stim) or an actee (the response). Any entity can be both at the same time, however stims don't affect the owner itself. So if the entity carries a stim and it triggers, it will not be act on himself, even if the entity has a response for that stim.<br />
Stims and responses are defined by numbers. '''The Dark Mod''' already defines some very common stims (like water) and reserves numbers for them. For a complete list you should take a look at thje darkmod_stim_response.script in the script folder. You will notice that there is one stim named USER. This stim has no special meaning. Instead it defines the lowest number that users can use for themself. So if you define new stims to be used in your maps, you should use USER+N for your individual stims. All numbers below USER are assumed to be known stims and may trigger specific actions if needed, which possibly includes specific SDK support code.<br />
<br />
As explained above, stims and responses are identified by their id's (the numbers). Whenever a stim is active, the system evaluates all stims and checks if appropriate responses are within it's reach. A response is identified by having teh same id as the stim. When such a response is found, the response is triggered and a script action is executed for it. If the response doesn't have a scriptaction associated, nothing will happen, but this is usually a waste of CPU, unless the response is coded in C++ directly in the SDK.<br />
One major difference between stims and responses is, that responses have an action associated with it, while stims don't.<br />
<br />
Stims and responses can be enabled and disabled at runtime. This is not only a feature, it is very important for the health of the system. If stims are not destroyed after they are used up, they will take up memory and hog your machine down after time. Also accumulating stims will cause the system to respond slower after time, as more and more stims have to be tested. For example: The arrows (like the water arrow) will spawn an entity that carries the water stim, when the arrow explodes. If that stim is not destroyed, it will continue to fire. Once a water arrow is exploded it doesn't makes sense though to keep it running, so it has to be destroyed. However, there is no definite rule when a stim has to be destroyed because it depends on their actual usage. Some stims may run throughout the game and others should be destroyed after they are used up.<br />
<br />
<br />
'''How to set it up?'''<br />
<br />
Bascially there are several methods to create a stim/response. The most obvious one is to add it in the SDK code, but this is probably the least prefered. For all practical purposes, stims and responses should be added either via scripting or the map editor, without the need of coding in the SDK environment.<br />
<br />
'''Setting it up in the map editor'''<br />
<br />
For this I use as an example a candle that should be stimmed by water and fire. The water stim will turn it off, while the fire stim will turn it back on. The actual water and fire stims don't need to be created here, because they are created through the water, resp. fire arrow.<br />
<br />
The first thing you do is to create brush and assign a candle model to it.<br />
Then create one or more lights, that will carry the light of your candle, as the candle itself doesn't have lighting properties. Note down the names of the lights or change them to something you might recognize.<br />
<br />
Add the following keys:<br />
"sr_class_1" "R"<br />
"sr_type_1" "STIM_WATER"<br />
"sr_state_1" "1"<br />
"sr_script_STIM_WATER" "response_water_action"<br />
"sr_argc" "2"<br />
"sr_argv_1" "ligth1_name"<br />
"sr_argv_2" "light2_name"<br />
"sr_model_1" "candle_turned_off"<br />
<br />
"sr_class_2" "R"<br />
"sr_type_2" "STIM_FIRE"<br />
"sr_state_2" "1"<br />
"sr_script_STIM_FIRE" "response_fire_action"<br />
"sr_model_2" "candle_turned_on"<br />
<br />
Depending on type (Stim or response) some keys are only valid for stims and others only for responses while some others are shared. Since an entity can have multiple different stims and responses, each type has a number in the keyname. However some keys don't need the number. Since each stimtype can exist only once per entity, the script for a given stim can only exist once, even though the scriptname can be reused multiple times (which is not recommended though) or for different stimtypes.<br />
<br />
If you want to have multiple stims/responses for the same entity just increase the number on the class.The numbers may have no gaps.<br />
<br />
The following keys are mandatory and must be set for every stim/responsetype.<br />
<br />
"sr_class_1" "R"<br />
this key defines wether the entity gets a stim (S) or a response (R). Other values will be ignored and nothing is created. The stim/response is attached to your entity when it spawns. <br />
<br />
"sr_type_1" "STIM_WATER"<br />
This defines the id of the stim or response and must be defined for both classes. You can either use a name, which must be the same as provided by the darkmod_stim_response.script or a number. For user defined stimtypes only numbers are recognized. In case of predefined stmitypes you can also use the number, but using the name is more rcognizable. So in this case you could also write "sr_type_1" "2", which is the id for the water stim. Howevery, if you do this, you must keep in mind that the script key must use the same syntax. In this case instead of writing "sr_script_STIM_WATER" it would also need to be "sr_script_2".<br />
<br />
"sr_state_1" "1"<br />
this key determines wether the stim or response is enabled (1) or disabled (0). If the stim/response is disabled it will not fire (or get triggered).<br />
<br />
"sr_script_STIM_WATER" "response_water_action"<br />
This key defines the response action script that should handle the response when it is triggered. Note that the name must match the stim id. So if you have a numbered id, then you must name the key accordingly (i.e. "sr_type_1" "100" -> "sr_script_100"). For how to apply the ids, also look at the sr_type description above.<br />
<br />
<br />
The now following keys are scripted and may be changed for different actions. This is for the default implementation though on the water stim. So if you want to do something different you can ignore these keys entirely and write your own script to handle the response.<br />
<br />
"sr_model_1" "candle_turned_off"<br />
This key defines a model that should be swapped in for the existing model, when this <br />
response is triggered. In our case we want to replace it with a turned off candle (and possibly add a smoke particle trail for a few seconds).<br />
<br />
"sr_argc" "2"<br />
This key defines how many lights you created for the given entity. In my case I used two. These lights are switched off.<br />
<br />
"sr_argv_1" "ligth1_name"<br />
"sr_argv_2" "light2_name"<br />
These keys determine the names of the light entites, that need to be switched off when the candle is extuinguished. Consequently when the fire arrow is shot at them, these are the lights that should be relighted.</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Stim/Response&diff=1612Stim/Response2006-02-07T10:43:13Z<p>Sparhawk: </p>
<hr />
<div>'''Stim/Response system for The Dark Mod'''<br />
<br />
This article describes how the stim/response system works for '''The Dark Mod'''. The name is taken from the Dromed Stim/Response system. However this does '''not''' mean that you should assume any other similarities. The system was described to me (sparhawk) and I coded it accordingly, but I have no Dromed experience, beyond some '''very''' simple maps, without any special features. I never got beyond the "Create a room and texture it" stage. :)<br />
So while this system may be similar on how it works as seen by the users, you can't assume that this is is more then a fleeting similarity as defined by it's common requirements.<br />
<br />
'''How does it work?'''<br />
<br />
The general concept is pretty easy to understand. The mapper populates his map with entities. Each of this entities, can be either a kind of actor (a stim) or an actee (the response). Any entity can be both at the same time, however stims don't affect the owner itself. So if the entity carries a stim and it triggers, it will not be act on himself, even if the entity has a response for that stim.<br />
Stims and responses are defined by numbers. '''The Dark Mod''' already defines some very common stims (like water) and reserves numbers for them. For a complete list you should take a look at thje darkmod_stim_response.script in the script folder. You will notice that there is one stim named USER. This stim has no special meaning. Instead it defines the lowest number that users can use for themself. So if you define new stims to be used in your maps, you should use USER+N for your individual stims. All numbers below USER are assumed to be known stims and may trigger specific actions if needed, which possibly includes specific SDK support code.<br />
<br />
As explained above, stims and responses are identified by their id's (the numbers). Whenever a stim is active, the system evaluates all stims and checks if appropriate responses are within it's reach. A response is identified by having teh same id as the stim. When such a response is found, the response is triggered and a script action is executed for it. If the response doesn't have a scriptaction associated, nothing will happen, but this is usually a waste of CPU, unless the response is coded in C++ directly in the SDK.<br />
<br />
Stims and responses can be enabled and disabled at runtime. This is not only a feature, it is very important for the health of the system. If stims are not destroyed after they are used up, they will take up memory and hog your machine down after time. Also accumulating stims will cause the system to respond slower after time, as more and more stims have to be tested. For example: The arrows (like the water arrow) will spawn an entity that carries the water stim, when the arrow explodes. If that stim is not destroyed, it will continue to fire. Once a water arrow is exploded it doesn't makes sense though to keep it running, so it has to be destroyed. However, there is no definite rule when a stim has to be destroyed because it depends on their actual usage. Some stims may run throughout the game and others should be destroyed after they are used up.</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Stim/Response&diff=1611Stim/Response2006-02-07T10:36:41Z<p>Sparhawk: </p>
<hr />
<div>'''Stim/Response system for The Dark Mod'''<br />
<br />
This article describes how the stim/response system works for '''The Dark Mod'''. The name is taken from the Dromed Stim/Response system. However this does '''not''' mean that you should assume any other similarities. The system was described to me (sparhawk) and I coded it accordingly, but I have no Dromed experience, beyond some '''very''' simple maps, without any special features. I never got beyond the "Create a room and texture it" stage. :)<br />
So while this system may be similar on how it works as seen by the users, you can't assume that this is is more then a fleeting similarity as defined by it's common requirements.<br />
<br />
'''How does it work?'''<br />
<br />
The general concept is pretty easy to understand. The mapper populates his map with entities. Each of this entities, can be either a kind of actor (a stim) or an actee (the response). Any entity can be both at the same time, however stims don't affect the owner itself. So if the entity carries a stim and it triggers, it will not be act on himself, even if the entity has a response for that stim.<br />
Stims and responses are defined by numbers. '''The Dark Mod''' already defines some very common stims (like water) and reserves numbers for them. For a complete list you should take a look at thje darkmod_stim_response.script in the script folder. You will notice that there is one stim named USER. This stim has no special meaning. Instead it defines the lowest number that users can use for themself. So if you define new stims to be used in your maps, you should use USER+N for your individual stims. All numbers below USER are assumed to be known stims and may trigger specific actions if needed, which possibly includes specific SDK support code.</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Stim/Response&diff=1610Stim/Response2006-02-07T10:31:11Z<p>Sparhawk: </p>
<hr />
<div>'''Stim/Response system for The Dark Mod'''<br />
<br />
This article describes how the stim/response system works for The Dark Mod. The name is taken from the Dromed Stim/Response system. However this does '''not''' mean that you should assume any other similarities. The system was described to me (sparhawk) and I coded it accordingly, but I have no Dromed experience, beyond some '''very''' simple maps, without any special features. I never got beyond the "Create a room and texture it" stage. :)<br />
So while this system may be similar on how it works as seen by the users, you can't assume that this is is more then a fleeting similarity as defined by it's common requirements.<br />
<br />
'''How does it work?'''</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Editing&diff=1609Editing2006-02-07T10:27:26Z<p>Sparhawk: </p>
<hr />
<div>The general hub for DarkMod specific editing - links to articles about:<br />
<br />
[[AI]]<br />
<br />
[[Sound Prop]]<br />
<br />
[[Creating doors]]<br />
<br />
[[Visportals]]<br />
<br />
[[Stim/Response]]<br />
<br />
<br />
and other specifics that are relevant to the mod.</div>Sparhawkhttps://wiki.thedarkmod.com/index.php?title=Editing&diff=1608Editing2006-02-07T10:27:00Z<p>Sparhawk: </p>
<hr />
<div>The general hub for DarkMod specific editing - links to articles about:<br />
<br />
[[AI]]<br />
[[Sound Prop]]<br />
[[Creating doors]]<br />
[[Visportals]]<br />
[[Stim/Response]]<br />
<br />
and other specifics that are relevant to the mod.</div>Sparhawk