This is an old revision of the document!
Table of Contents
Discuss this page on this page's Talk Page.
Overview
<ShipClass> defines the properties and behavior of a type of ship, including player ships.
Basic Attributes
Names
{Naming the ship class; naming individual ships with the <Names> element}
Image
{<Image> element}
Armor
{<Armor> element}
Devices
{<Devices> element}
Drive
{thrust, maneuverability, maxSpeed attributes plus effect of devices. Plus <DriveImages>}
Items
{<Items> element}
Explosions & Wrecks
{leavesWreck attrib, plus wreck type and explosion attributes}
AI Settings
{<AISettings> element}
Events
<CanDockAsPlayer>
[NOTE: This event was implemented in 1.08.]
This event is raised when a player attempts to dock with an object (using the 'D' key). The event may return True to indicate that docking should proceed. Or, to prevent docking, it may return a text string explaining the reason for failure.
gSource is the player ship object that is attempting to dock.
aDockTarget is the object that the ship is attempting to dock with.
<GetExplosionType>
<OnAttacked>
<OnAttackedByPlayer>
<OnCreate>
<OnCreateOrders>
<OnDamage>
<OnDestroy>
<OnEnteredGate>
<OnEnteredSystem>
<OnLoad>
<OnObjDestroyed>
<OnObjDocked>
<OnObjEnteredGate>
<OnObjJumped>
<OnObjJumpPosAdj>
<OnObjReconned>
<OnOrderChanged>
<OnOrdersCompleted>
<OnPlayerEnteredSystem>
<OnPlayerLeftSystem>
<OnSystemExplosion>
<OnSystemObjAttacked>
<OnSystemObjDestroyed>
<OnSystemWeaponFire>
<OnTranslateMessage>
Player Ships
See: Player ships See: PlayerSettings