Introduction

Installation

Configuring Objects

Spacecalls

Events

Coordinates

Tips & Tricks

Portable Space EngineBuilder's Guide

Please send comments to Mark Cooke <mpc@star.sr.bham.ac.uk> or vspace@geocities.com

>Spacecalls: Shield Console Calls

SpacecallReturn ValueObjectShip
shd_alloc_shield(Integer shield)Integer allocation  X
This function returns the amount of energy currently allocated to the specified shield, or -1 if the shield parameter was not valid for this ship.
shd_allocate(Integer Shd1, Integer Shd2, Integer Shd3, Integer Shd4, Integer Shd5, Integer Shd6)  X
This command allocates the specified amounts of energy to particular shields. If the total allocated is more than the current amount allocated to shields, the specified values are scaled down. On ships with 4 shields, Shd5 and Shd6 should be set to 0.
shd_cloak_off()  X
This command disengages the cloaking device for the ship.
shd_cloak_on()  X
This command attempts to engage a cloaking device for the ship. All the shields must be operational for this to work.
shd_cloak_status()String status  X
This function returns the current status of the cloaking device for the ship object. The possible return values are NONE, OFF, ON, CLOAKING, DECLOAKING.
shd_config_name()String name  X
This function returns the name of the shield configuration on the ship object. It can be one of the following: Type 1 Array (4/PSAF-60), Type 2 Array (6/PSDVAF-60), Type 3 Array (6/PSDVAF-45), Type 4 Array (4/PSVD), Type 5 Array (4/PSVD-45).
shd_full_name(Integer Shield)String name  X
This function returns the full name of the specified shield from the shield array of the ship.
shd_lower_shield(Integer shield)  X
This command lowers the specified shield.
shd_number()Integer shields  X
This function returns the number of shields on the ship. This can vary with the shield configuration selected for the ship.
shd_raise_shield(Integer shield)  X
This command attempts to raise the specified shield. Shields cannot be raised while cloaked, or if the shield is inoperable through damage.
shd_shield_action(Integer shield)String status  X
This function returns the current status of the shield. The return values can be one of STABLE, CHARGE, FALL, OVERLOAD
shd_shield_level(Integer shield)Integer level  X
This function returns the current shield level for the specified shield. If an invalid shield was specified, -1 is returned.
shd_shield_max_level(Integer shield)Integer level  X
This function returns the maximum shield level for the specified shield. If an invalid shield was specified, -1 is returned.
shd_shield_status(Integer shield)String status  X
This function returns the current state of the specified shield. The return values are READY, UP, DAMAGED.
shd_short_name(Integer Shield)String name  X
This function returns the short name of the specified shield from the shield array of the ship.


Last modified: 15th March 1998