Function; SobGroup_Disable - HWRM/KarosGraveyard GitHub Wiki

SobGroup_Disable(<sSobGroup>, <iDisabled>)

Description

Causes sSobGroup to become 'stunned' (as if they'd been hit by a sufficiently strong EMP). This is permanent. To undo the effect, you must call this function again on the same ships and pass 0 for iDisabled!

Stunned ships can receive attack, move, dock, and many other orders. However, they are unable to perform most actions while 'stunned', and will instead drift powerlessly.

Some actions can still be performed, such as hyperspacing through a gate.

Example

-- stuns the group (permanently!)
SobGroup_Disable("my-group", 1);

-- unstuns the group
SobGroup_Disable("my-group", 0);

Arguments

Param Type Description
sSobGroup string The target SobGroup.
iDisabled number (int) 0 will enabled the group, 1 will disable.

Returns

nil

Scope

Related Pages

Comments

New HWRM fn.

⚠️ **GitHub.com Fallback** ⚠️