GSC reference › bgb
bgb::register()
Script function
Server + client
bgb helper: register. BO3's decompiled scripts carry no docs for this one: the description is ours, from its name and use.
Signature
bgb::register(name, limit_type)
Needs #using the script that defines it (scripts/zm/_zm_bgb.gsc).
Parameters
| Name |
|---|
| name |
| limit_type |
The decompiled scripts don't keep default values, so some of these may be optional: check the real uses below.
Real uses in BO3's scripts
Called 126 times in the decompiled scripts. A few, zombies first:
- scripts/zm/bgbs/_zm_bgb_aftertaste.csc, line 40
bgb::register("zm_bgb_aftertaste", "rounds"); - scripts/zm/bgbs/_zm_bgb_aftertaste.gsc, line 44
bgb::register("zm_bgb_aftertaste", "rounds", 3, &event, undefined, undefined, undefined); - scripts/zm/bgbs/_zm_bgb_alchemical_antithesis.csc, line 40
bgb::register("zm_bgb_alchemical_antithesis", "activated"); - scripts/zm/bgbs/_zm_bgb_alchemical_antithesis.gsc, line 41
bgb::register("zm_bgb_alchemical_antithesis", "activated", 2, undefined, undefined, &validation, &activation); - scripts/zm/bgbs/_zm_bgb_always_done_swiftly.csc, line 40
bgb::register("zm_bgb_always_done_swiftly", "rounds");
More in bgb::
- bgb::is_enabled()True/false check: is enabled?
- bgb::do_one_shot_use()Runs one shot use.
- bgb::get_active()Returns the active.
- bgb::set_timer()Sets the timer.
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).