Function; SobGroup_SetAutoLaunch - HWRM/KarosGraveyard GitHub Wiki

SobGroup_SetAutoLaunch(<sSobGroupName>, <iLaunchSetting>)

Description

Sets the auto-launch setting for <sSobGroupName>. iLaunchSetting is a value between 0 and 2 (just use the pre-defined globals detailed below).

Example

SobGroup_SetAutoLaunch("Mothership", ShipHoldStayDockedAlways); -- ships which dock with ships in group `"Mothership"` will not auto-launch

Arguments

Variable Name	Value	Description
ShipHoldStayDockedAlways	2	The host ship will never auto-launch ships in its hold. Ships may still launch themselves (i.e via SobGroup_Launch), and the player may also launch ships.
ShipHoldStayDockedUpToLimit	1	The host ship will not auto-launch ships which dock with it, unless it has reached its shiphold capacity.
ShipHoldLaunch	0	Ships will auto-launch from the host ship under normal conditions.

Scope

Related Pages

• Function Reference
• SobGroup_Launch
• SCAR (SCripting at Relic) Reference

Comments

Page Status

Updated Formatting? Initial
Updated for HWRM? Initial