Jump to content

BSL:Inventory management: Difference between revisions

BSL:Inventory management (view source)

Revision as of 23:24, 17 November 2005

5,093 bytes added ,  17 November 2005
m
→‎Weapon Codes
Line 1: Line 1:


== Weapon Codes ==
==Management of inventory items==
==Giving items to characters==
====Weapons====
You can choose from four commands when giving a weapon to a character :
*<tt>void chr_giveweapon(string ai_name, string weapon_name)</tt>
*<tt>void chr_giveweapon(int script_id, string weapon_name)</tt>
*<tt>void chr_weapon(int chr_index, string weapon_name)</tt>
*<tt>void chr_weapon(int chr_index, int weapon_num)</tt>
All those have the effect of giving a new weapon to a character. The first argument can be :
*the "AI name", most often used for spawned AI, but also applicable to AI-less characters, such as Konoko (the name has then to be looked up).
*the "script ID", used for characters without an AI (Konoko and some cutscene puppets). Konoko's script ID is always 0.
*the "character index", used for any character : it's related to the position of the characters in memory (basically to the order in which they were spawned, Konoko's character index is thus always 0)
The second argument can be :
*the "weapon name", a string
*the "weapon number" an integer
A table summing up the weapon names and IDs :
{|border = "1"
!Weapon
!name
!ID (+/- 12)
|-
|Campbell Equalizer
|w1_tap
|3
|-
|Hughes Black Adder
|w2_sap
|4
|-
|Hughes Black Adder
|w3_sap
|5
|-
|Phase Stream Projector
|w4_psm
|6
|-
|Super Ball Gun
|w5_sbg
|7
|-
|Van de Graaff Pistol
|w6_vdg
|8
|-
|Scram Cannon
|w7_scc
|9
|-
|Mercury Bow
|w8_mbo
|10
|-
|Screaming Cannon
|w9_scr
|11
|-
|Homing Red Balls :D
|w10_sni
|0
|-
|Wave Motion Cannon
|w11_ba1
|1
|-
|
|w12_ba2
|2
|-
|
|w13_muro
|NONE
|-
|
|w14_muro
|NONE
|-
|
|w0_sec
|NONE
|}
*By (+/- 12) I mean that you can e.g. use <tt>chr_weapon(0, -11)</tt> or <tt>chr_weapon(0, 13)</tt> to give Konoko a Wave Motion Cannon.
*w12_ba2 is like w10_sni except it doesn't shoot... w13_muro, w14_muro and w0_sec don't work at all.
====Powerups====
You can choose from a few commands when giving powerups to a character :
*<tt>void chr_givepowerup(string ai_name, string powerup_name, int amount)</tt>
*<tt>void chr_givepowerup(string ai_name, string powerup_name)</tt>
*<tt>void chr_giveweapon(int script_id, string powerup_name, int amount)</tt>
*<tt>void chr_giveweapon(int script_id, string powerup_name)</tt>
*<tt>void give_powerup(string powerup_name, int amount, int character)</tt>
*<tt>void give_powerup(string powerup_name, int amount)</tt>
*<tt>void give_powerup(string powerup_name)</tt>
All those have the effect of giving a powerup to a character. The character is referred to by one of the following :
*the "AI name", same as in the case of weapons (see above)
*the "script ID", same as in the case of weapons (see above)
*the "character" index, same as "character index" in the case of weapons (see above)
The new thing here is that there is no "powerup ID", and some of the arguments are optional.<br>
In fact, those arguments have a default value, and omitting the argument is the same as providing that default value :
*the default value of "character" for the <tt>give_powerup</tt> command is 0 (Konoko's "character ID"). If you specify "character", you can't omit "amount".
*the default "amount" of powerups are summed up in the following table.
{|border = "1"
!Powerup
!name
!Default amount
!Max amount
|-
|Ballistic Ammo
|ammo
|1
|65535
|-
|Energy Cell
|cell
|1
|65535
|-
|Hypo Spray
|hypo
|1
|65535
|-
|Special
|lsi
|?
|?
|-
|Force Shield
|shield
|100
|65535
|-
|Phase Cloak
|invis
|1800
|65535
|}
*Giving negative amounts means taking away. Taking away more than you can means ''giving a lot''. If you have 1 clip of ammo and use <tt>give_powerup(ammo, -3)</tt>, you'll have 65534 ammo clips.
*Phase Cloak decays by 1 point every frame (1 second = 60 frames), so default is 30 seconds, max is 65534/60=1000 seconds
*When the Phase Cloak amount is set to 65535, there is ''no'' decay ('''moonshadow''' effectively sets this amount to either -1=65535 and 0)
*"Special" aka '''lsi''' can be one of the following : Datapad, Rappelling Harness, Laser Torch, Zip Line Rider, Truck Keys. Depending on the level.
*"amount" seems to be ignored in the case of '''lsi''', as the associated variable is a [[OSL:Data|boolean]]. In particular, you can't take an '''lsi''' item away.
==Spawning loose items==
It's much less complicated that giving items... or spawning characters.
===Spawning a weapon===


Campbell Equalizer - w1_tap<br>
==Associated stuff==
SMG Black Adder - w2_sap<br>
===Commands===
Plasma Rifle - w3_phr<br>
====chr_inv_reset (modifier)====
Phase Stream Projector - w4_psm<br>
*this takes all items away from a character (weapons, ammo, hypos, Force Shield, Phase Cloak, lsi)
Superball Gun - w5_sbg<br>
*as for most "character" commands, valid arguments are an "AI name" and a "script ID"
Van De Graff Pistol - w6_vdg<br>
*chr_inv_reset(0) resets the inventory of the character with script ID 0 i.e. Konoko.
Scram Cannon - v7_scc<br>
*chr_inv_reset(SomeAI) would reset the inventory of an AI called SomeAI.
Mercury Bow - w8_mbo<br>
===Predicates===
Screaming Cannon - w9_scr<br>
i.e. small functions returning a boolean (YES/NO) value informing you on the current state of the characters' inventory
<br>
====chr_has_lsi====
Mukade's Fireworks Ring - w10_sni<br>
*this one lets you know e.g. if the player character has found and picked up an '''lsi''' item.
Wave Motion Cannon - w11_ba1<br>
====chr_has_empty_weapon====
<br>
*this one lets you know if the character has run out of ammo for his weapon (and has nothing to reload with)
'''Other Unused Weapons'''<br>
===Variables===
w0_sec<br>
====wp_disable_fade====
w12_ba2<br>
*setting this to 1 will make dropped weapons ''not'' fade i.e. stay on the ground forever.
w13_muro<br>
====wp_fade_time====
w14_muro<br>
*should specify the time (in frames) over which weapons disappear, but setting it doesn't seem to have an effect
====ai2_barabbas_run====
*setting this variable to 0 will prevent the AI from running with the Wave Motion Cannon. The player character can never run with a WMC.
Retrieved from "https://wiki.oni2.net/Special:MobileDiff/424"