{"id":680,"date":"2022-05-21T23:29:50","date_gmt":"2022-05-22T04:29:50","guid":{"rendered":"https:\/\/chronocrash.com\/obor\/wiki\/?p=680"},"modified":"2023-12-28T14:51:12","modified_gmt":"2023-12-28T19:51:12","slug":"weapons","status":"publish","type":"post","link":"https:\/\/chronocrash.com\/obor\/wiki\/weapons\/","title":{"rendered":"Weapons"},"content":{"rendered":"\n

OpenBOR includes a native weapon system, allowing in game characters to attain new abilities, power ups, or as the name implies, usable weapons. In actuality, each weapon is an alternate model that partially replaces traits from the default model. For example, the weapon model for a sword might replace idle, walking, and jumping animations with new ones carrying a sword, and the attack animation with a sword swing. All the other model traits like name, hit-points, and so on remain the same.<\/p>\n\n\n\n

All entity types can use weapons. By default computer controlled entities will seek out and collect available weapon pickups.<\/p>\n\n\n\n

Initial Setup<\/h3>\n\n\n\n

To begin, you will need to create a new model for the weapon (see Weapon Model<\/a>). It is similar in principal to a normal model, but you do not need to include any properties or animations which are the same as the original model. When the weapon is in use, the original model is “upgraded” with the new model. Properties (animations, icons, etc.) that differ from the original model are replaced. Any new properties are added. Properties not found in the weapon model text are unchanged unless noted otherwise.<\/p>\n\n\n\n

The original model’s com list<\/a> is not copied. This is so you can redefine available commands in the weapon model (i.e. no hurricane kick if you’re carrying a two ton rock over your head). Cancel commands<\/a> do copy since they are part of an animation. If you want to disable cancels, just include the animation in your weapon model without the cancels in it.<\/p>\n\n\n\n

Make sure the weapon model is loaded before you try to use it. This works like loading any other model. Once you have a weapon model, you need to add it to the original model’s weapons list<\/a>. After this step, your model is ready to use the weapon. Weapons can be equipped in a variety of ways, including collectable items, commands, or script.<\/p>\n\n\n\n

If the weapon is meant to be an item found in levels or taken from opponents, you will also need a Weapon Item<\/a>. Weapon items are very similar to other collectable items, with some properties added to activate the weapon model.<\/p>\n\n\n\n

By default, entities lose a weapon when taking any hits. If the weapon was an item pickup, it drops in front of the entity that carried it. After three drops, the weapon is killed<\/a>. You can modify any of these behaviors and much more, so be sure to study the properties below.<\/p>\n\n\n\n

Properties<\/h2>\n\n\n\n

General<\/h3>\n\n\n\n

Unless noted otherwise, these properties are usable by both the default model and any weapon models. This allows you to dictate new weapon behaviors based on the current weapon. For example, you might want to prevent picking up other weapons while carrying a large barrel or rock to throw.<\/p>\n\n\n\n

\n

Weapon List\u200b<\/h4>\n\n\n
\nweapons &lt;weapon models>\n\n#default\nweapons none\n<\/pre><\/div>\n\n\n
List of weapons a model can use. Accepts a list of model names. The first model weapon is weapon 1, the next weapon 2, and so on (weapon 0 is the default model with no weapon). When an entity is instructed to set its weapon it switches to the weapon model by its position in the list. For example, if the second model in the weapon list is baseball_bat<\/code>, picking up an item with weapnum 2<\/code> (see below) will switch to the baseball_bat model.

You may use none<\/code> for a model name to disable that weapon number. For example if the weapons list is weapons none baseball_bat knife<\/code>, the entity will ignore any attempt to set its weapon to 1.<\/p>\n<\/div><\/div>\n\n\n\n
\n
Weapon Loss Condition\u200b<\/h4>\n\n\n
\nweapon_loss_condition &lt;flags>\n\n#default\nweapon_loss_condition pain fall grab\n<\/pre><\/div>\n\n\n
Set in game conditions that cause loss of carried weapon. Accepts one or more of the following flags. If used, you must provide all the flags you want to enable.<\/p>\n\n\n\n