Function; SobGroup_Tumble - HWRM/KarosGraveyard GitHub Wiki

SobGroup_Tumble(<sSobGroupName>, <tTumbleVector>)

Description

Causes ships in sSobGroupName to tumble, meaning their pitch/yaw/roll values are forcibly altered. Naturally works best with immobile ships.

Example

SobGroup_Tumble("my-group", { 0.75, 0.0, -0.75 })

Arguments

Arg	Type	Description
sSobGroupName	string	The name of the group to apply the tumble effect to.
tTumbleVector	table	The pitch/yaw/roll values to tumble the group's ships to. Works best with immobile ships.

Related Pages

• SobGroup_ClearTumble
• FunctionReference

Comments

Be careful not to call this function with high values in tTumbleVector, or repeatedly call this function again and again with vector values which will only increase - ships can begin spinning wildly out of control and will be immobile/unusable until they finally slow down (which can be minutes).

Although SobGroup_ClearTumble exists, it's generally unnecessary to use if the target ships aren't tumbling too wildly, as calling SobGroup_Tumble does not prevent ships from moving/righting themselves.

Page Status

• Updated Formatting? N/A
• Updated for HWRM? N/A