HW2 Function Reference

Note: Please do not create dummy pages for functions that have not yet been documented.

A abs acos

addAbility

addAmbientSound addAsteroid addCamera addCloud addDustCloud AddLocalizedText addNebula addPath addPebble addPoint addReactiveFleetResourceSlot addReactiveFleetSlot addRegion addSalvage addShield AddShipAbility AddShipMultiplier AddSpeechEvent addSphere addSquadron addSquadronToSOBGroup AddSubSystemAbility AddSubSystemMultiplier AddSubtitleEvent addTheme addToSOBGroup AddWeaponResult AdjustForBadDrivers appendto AREA AreAllied ascii asin assert atan atan2 ATI_AddColour ATI_AddFloat ATI_AddGraphic2D ATI_AddGraphic3D ATI_AddPosition ATI_AddScale ATI_AddString ATI_AddWString ATI_Clear ATI_CreateParameters ATI_Display2D ATI_Display3D ATI_LoadTemplates

B BattleChatMisc bind1 bindEffect bindup BreakAlliance

C call cameraCollision Camera_AllowControl Camera_AltFocus Camera_AltFocusWithVolume Camera_FocusCameraPoint Camera_FocusCancel Camera_FocusRestore Camera_FocusSave Camera_FocusSobGroup Camera_FocusSobGroupWithBuffer Camera_FocusVolume Camera_FocusVolumeKeepingEyePosition Camera_FocusVolumeWithBuffer Camera_GetDistanceToSobGroup Camera_GetLastZoomAmount Camera_Interpolate Camera_IsFocused Camera_PanCmd Camera_PlayerHasFocused Camera_PlayerHasPanned Camera_PlayerHasRotated Camera_ResetFocused Camera_ResetPanned Camera_ResetRotated Camera_SetLetterboxState Camera_SetLetterboxStateNoUI Camera_UseCameraPoint Camera_UsePanning Camera_ZoomClose Campaign_QuickSaveNb ceil ChatterMisc ChatterMiscHighPriority Chatter_Init ClearAllControlGroups ClearSelectedFromControlGroups ClearTOSettings clock closefile collectgarbage CommandAttackGiven CommandCancelOrder CommandCaptureGiven CommandCombatMan CommandConstructionComplete CommandConstructionStarted CommandDefenseFieldChanged CommandDockGiven CommandEngagementRangeChanged CommandEngagementRangeForceChanged CommandGuardGiven CommandHotKeyGroupSelected CommandHyperspaceGiven CommandLaunchGiven CommandMoveAttackGiven CommandMoveGiven CommandMoveToSobGiven CommandMultiplay CommandParadeGiven CommandPaused CommandResourceGiven CommandRetireGiven CommandShipsSelected CommandStrikeGroupFormed CommandTacticsChanged CommandWayPointMoveGiven copytagmethods cos CPU_AddDefendSobGroup CPU_AddDefendTarget CPU_AddSobGroup CPU_DoFile CPU_DoString CPU_Enable CPU_EnableAll CPU_Exist CPU_GetDebugFlag CPU_GetVar CPU_GetVarString CPU_IsDebugFlagSet CPU_RemoveDefendTarget CPU_RemoveResourceBlob CPU_RemoveSobGroup CPU_SetAttackTargetPriority CPU_SetDebug CPU_SetDebugFlag CPU_SetDebugMode CPU_SetDebugPlayer CPU_SetDefendTargetCapturePriority CPU_SetDefendTargetPriority CPU_SetDefendTargetRadius createAmbientLight createDirLight createSOBGroup

D date debug debugRegionMode deg distlessthan distsqvec3 dofile dofilepath dostring dr_clear dr_setautoclear dr_setdisplay dr_text2d

E EnableATIDisplay EnableBuildInBadges Enable_Pebble_Distribution error EventPointer_AddSobGroup EventPointer_AddSubSystemFromSobGroup EventPointer_AddVolume EventPointer_Remove Event_IsDone Event_Start Event_Stop execute exit exp

F FE_ExitToMainMenu FE_ExitToWindows FE_FocusOnLastEvent FE_GetCurrentPlayerIndex FE_LoadGameScreen FE_LoadGameScreen_Campaign FE_LoadGameScreen_RecordedGame FE_NextTutorial FE_RestartGame FE_Retire FE_SaveGameScreen FE_SaveGameScreen_Campaign FE_TaskbarIgnoreProfilePhase floor flush fogAddInterpolator fogSetActive fogSetColour fogSetDensity fogSetEnd fogSetStart fogSetType foreach foreachi foreachvar format formationSlot formStrikeGroup FOWVis FOW_ForceUpdate FOW_RevealGroup frexp function_set_error FX_DestroyEffectOnBackground FX_Flush FX_FlushLod FX_Lights FX_PlayEffect FX_PlayEffectBetweenPoints FX_PlayEffectOnBackground FX_PlayEffectOnBackgroundVolume FX_StartEvent FX_StopEffect FX_StopEffectOnBackground FX_StopEvent

G gamemisc_dumprules gcinfo GetActualPlayerFleetExtraRU GetActualPlayerFleetSizeInRU GetControlTabs getenv GetFOWVis GetGameSettingAsNumber GetGameSettingAsString getglobal getLevelOfDifficulty getLoopCount GetMultiplierForExtraRU GetMultiplierForExtraShips getn getPauseTime GetResearchId GetShipId getState GetSubSystemId getSyncCheckingLevel gettagmethod getTime getType GetVersionInfo globals gsub

H HEIGHT HW2_CameraPanned HW2_CameraRotated HW2_CreateEventPointerSobGroup HW2_CreateEventPointerSubSystem HW2_CreateEventPointerVolume HW2_DisableBuilderOnCapture HW2_Fade HW2_GrantBuild HW2_GrantResearch HW2_InitializeBuilder HW2_IsRunTimeSobGroupAlive HW2_IsRunTimeSobGroupEmpty HW2_Letterbox HW2_LocationCardEvent HW2_Pause HW2_PingCreateWithLabel HW2_PingCreateWithLabelPoint HW2_PlayerHasMilitary HW2_ReactiveInfo HW2_RestrictBuild HW2_RestrictResearch HW2_rgb HW2_SetResearchLevel HW2_SobGroup_AddHealthPercentage HW2_SobGroup_ReduceHealthPercentage HW2_SubTitleEvent HW2_VaygrBuildShips HW2_VaygrOrder HW2_Wait Hyperspace_SetStateForPlayer Hyperspace_SetStateForVolume

I instantParadeOnSkip isAnimRunning isCapital

L ldexp leaveStrikeGroup loadBackground LoadGame LoadHODFile LoadModel loadNIS loadPatchList LoadRecordedGame LoadSharedModel loadShipPatchList LocationCard LocationCard_IsDone LOD_SetAllowGoblins LOD_SetDesiredFPS LOD_SetEnabled log log10

M MainUI_DisableAllCommands MainUI_DisableCommand MainUI_PopAllEnabledCommandStates MainUI_PopEnabledCommandState MainUI_UserEventData MainUI_UserEventData2 math_and math_or math_shl math_shr max maxActiveLights min mod movieOutputDirectory movieOverExpose movieRecorderStart movieRecorderStop MPRestrict

N newtag next nextvar NISComplete NISDebug NISDisableInterface NISGetPlayingHandle NISLoad NISPlay NISPlayFromGroup NISSeek NISSeekForward NISSetSkippable

O Objective_Add Objective_AddDescription Objective_GetState Objective_Select Objective_SetState OnInit openfile

P paradeSlot pauseAnim persistentFeedback Ping_AddDescription Ping_AddPoint Ping_AddSobGroup Ping_LabelVisible Ping_Remove playAnimatic playAnimaticNis playBgLightAnim Player_AllowDockFromUIOverride Player_CancelResearch Player_CanResearch Player_FillProximitySobGroup Player_FillShipsByType Player_FillSobGroupInVolume Player_GetName Player_GetNumberOfSquadronsOfTypeAwakeOrSleeping Player_GetRace Player_GetRU Player_GetShipsByType Player_GrantAllResearch Player_GrantResearchOption Player_HasQueuedBuild Player_HasQueuedResearch Player_HasResearch Player_HasShipWithBuildQueue Player_InstantDockAndParade Player_InstantlyGatherAllResources Player_IsAlive Player_IsShipInVolume Player_Kill Player_NumberOfAwakeShips Player_Research Player_RestrictBuildOption Player_RestrictResearchOption Player_SetBadgeTexture Player_SetBounty Player_SetDefaultShipTactic Player_SetPlayerName Player_SetRU Player_SetTeamColours Player_ShareVision Player_UnrestrictBuildOption Player_UnrestrictResearchOption playNIS playPatch playSpeechActor playSpeechActorLinked playSpeechFreq postLevelComplete Preload_Ship print Profile_SetMissionsComplete Profile_SetSingleMissionComplete Profile_UnlockAll Profile_UnlockMovies proposeAlliance

R raceHelper rad random RandomIntMax RandomRange randomseed rawget rawgetglobal rawgettable rawset rawsetglobal rawsettable read readfrom RecorderPauseUniverse RecorderSwitchPlayer RecordGame remove rename RenderEffects RenderShips resetPatchList RestrictOptions Rule_Add Rule_AddInterval Rule_Exists Rule_Remove

S SaveDetGame SaveGame SaveRecordedGame saveVar screenshot seek SelectBuildFacility SelectNextIdleHarvester SendBuildOrder SendCancelShipOrder SendCancelSubSystemOrder SendPauseShipOrder SendPauseSubSystemOrder Sensors_EnableCameraZoom Sensors_EnableToggle Sensors_FlashWorldPlane Sensors_ManagerIsUp Sensors_SetCameraMinMax Sensors_SetZoomOutDistance Sensors_Switch Sensors_Toggle setAccuracy SetAlliance setAngles setDefaultMusic setDetailLevel setDustCloudAmbient setEngineBurn setEngineTrail setForceLOD setGameOver setGlareIntensity setglobal setGlobalFrequencyMax setGlobalFrequencyMin setGlobalFrequencyModifier setJointVisible setLevelOfDifficulty setLevelShadowColour setLightColour setLightSpecular setlocale setLoopCount setMiscValues

setMissionComplete setMusicPath setNebulaAmbient setOutOfSync setPatchListUI setPatchParams setPatchVol setPauseTime setPenetration setSensorsManagerCameraDistances SetSpeechFolder SetStartFleetSuffix setState settag settagmethod setTime SetTOSettings setUseLighting setWorldBoundsInner setWorldBoundsOuter ShowBackground ShowBattleScar ShowEngines ShowInfo ShowLevelVolumes showNISDebug ShowPathTolerance ShowResourceDebug ShowShipDebug ShowUnitCaps ShowWeaponDebug sin SobGroup_AbilityActivate SobGroup_AllowPassiveActionsAlways SobGroup_AreAllInHyperspace SobGroup_AreAllInRealSpace SobGroup_AreAnyFromTheseAttackFamilies SobGroup_AreAnyOfTheseTypes SobGroup_AreAnySquadronsInsideDustCloud SobGroup_AreAnySquadronsInsideNebula SobGroup_AreAnySquadronsOutsideDustCloud SobGroup_AreAnySquadronsOutsideNebula SobGroup_AssignedToGroup SobGroup_Attack SobGroup_AttackPlayer SobGroup_AttackSobGroupHardPoint SobGroup_AutoEngineGlow SobGroup_AvoidanceIgnore SobGroup_CanDoAbility SobGroup_CaptureSobGroup SobGroup_ChangePower SobGroup_Clear SobGroup_Count SobGroup_CountByPlayer SobGroup_Create SobGroup_CreateShip SobGroup_CreateSubSystem SobGroup_DeployMines SobGroup_DeSelectAll SobGroup_Despawn SobGroup_DockSobGroup SobGroup_DockSobGroupAndStayDocked SobGroup_DockSobGroupInstant SobGroup_DoDamageProximitySobGroup SobGroup_Empty SobGroup_EnterHyperSpaceOffMap SobGroup_ExitHyperSpace SobGroup_ExitHyperSpaceSobGroup SobGroup_FillBattleScar SobGroup_FillBattleScar_Debug SobGroup_FillCompare SobGroup_FillProximitySobGroup SobGroup_FillShipsByType SobGroup_FillSobGroupInVolume SobGroup_FillSubstract SobGroup_FillUnion SobGroup_FollowPath SobGroup_ForceStayDockedIfDocking SobGroup_FormHyperspaceGate SobGroup_FormStrikeGroup SobGroup_GetActualSpeed SobGroup_GetAttackers SobGroup_GetHardPointHealth SobGroup_GetPosition SobGroup_GetSobGroupBeingCapturedGroup SobGroup_GetSobGroupCapturingGroup SobGroup_GetSobGroupDockedWithGroup SobGroup_GetSobGroupRepairingGroup SobGroup_GetSobGroupSalvagingGroup SobGroup_GetSpeed SobGroup_GetSquadronsInsideDustCloud SobGroup_GetSquadronsInsideNebula SobGroup_GetTactics SobGroup_GroupInGroup SobGroup_GuardSobGroup SobGroup_HasFiredAtSobGroup SobGroup_HasUpgrade SobGroup_HealthPercentage SobGroup_InStrikeGroup SobGroup_InWorldBound SobGroup_IsBuilding SobGroup_IsCloaked SobGroup_IsDocked SobGroup_IsDockedSobGroup SobGroup_IsDoingAbility SobGroup_IsGateDeployed SobGroup_IsGuardingSobGroup SobGroup_IsInControlGroup SobGroup_IsInVolume SobGroup_IsSelectable SobGroup_IsShipNearPoint SobGroup_Kamikaze SobGroup_Launch SobGroup_LoadPersistantData SobGroup_MakeSelectable SobGroup_MakeUntargeted SobGroup_ManualEngineGlow SobGroup_Move SobGroup_MoveToSobGroup SobGroup_OnScreen SobGroup_OwnedBy SobGroup_ParadeSobGroup SobGroup_PlayerIsInSensorRange SobGroup_RemoveType SobGroup_RepairSobGroup SobGroup_ResearchModuleExistOrSelected SobGroup_ResetAvoidanceIgnore SobGroup_Resource SobGroup_RestrictBuildOption SobGroup_SalvagedByPlayer SobGroup_SalvageSobGroup SobGroup_Selected SobGroup_SelectSobGroup SobGroup_SetAsDeployed SobGroup_SetAutoLaunch SobGroup_SetBuildSpeedMultiplier SobGroup_SetCaptureAlwaysDisables SobGroup_SetCaptureState SobGroup_SetDisplayedRestrictedHardpoint SobGroup_SetFiredAtSobGroup SobGroup_SetHardPointHealth SobGroup_SetHealth SobGroup_SetInvulnerability SobGroup_SetInvulnerabilityOfHardPoint SobGroup_SetMadState SobGroup_SetMaxSpeedMultiplier SobGroup_SetSpeed SobGroup_SetSwitchOwnerFlag SobGroup_SetTactics SobGroup_SetTeamColours SobGroup_SobGroupAdd SobGroup_Spawn SobGroup_SpawnNewShipInSobGroup SobGroup_Stop SobGroup_SubSystemSelected SobGroup_SwitchOwner SobGroup_TakeDamage SobGroup_UnderAttack SobGroup_UnRestrictBuildOption SobGroup_UseHyperspaceGate sort Sound_EnableAllSpeech Sound_EnterIntelEvent Sound_ExitIntelEvent Sound_MusicPlay Sound_MusicPlayType Sound_Reload Sound_SetMuteActor Sound_SFXPlay3D Sound_SFXPlay3DPos Sound_SpeechPlay Sound_SpeechSubtitlePath Sound_StingerPlay Sound_ToggleSpeech SpawnSalvageOnDeath SpawnShipOnDeath sqrt ssJPG ssSetMode ssSetPosterRes ssSetSuperSample ssUI startAnim StartAsteroidConfig StartCloudConfig StartDustCloudConfig startEffect StartMissileConfig StartNebulaConfig startParamAnim StartPebbleConfig StartSalvageConfig

StartShipConfig

StartShipHardPointConfig

StartShipWeaponConfig

StartSubSystemConfig

StartSubSystemWeaponConfig

StartWeaponConfig

statMon statMonLog Stats_BuildShipsBuilt Stats_BuildShipsBuiltInRUs Stats_DumpFramesToDisk Stats_EnemyShipsCaptured Stats_EnemyShipsCapturedInRUs Stats_GatheredRUAsteroid Stats_GatheredRUDustCloud Stats_GatheredRUNebula Stats_GatheredRUs Stats_GatheredRUSalvage Stats_HarvestersBuilt Stats_HarvestersBuiltInRUs Stats_OwnShipsCaptured Stats_OwnShipsCapturedInRUs Stats_PlayerAt Stats_PlayerCount Stats_ResearchCount Stats_ResearchRUValue Stats_ResearchTotal Stats_ShipsCaptured Stats_ShipsCapturedInRUs Stats_ShipsCreated Stats_ShipsCreatedInRUs Stats_ShipsFirstBuilt Stats_ShipsLost Stats_ShipsLostInRUs Stats_SpentRUs Stats_SquadronsActive Stats_SquadronsMax Stats_SquadronsQueued Stats_SubsystemsBuilt Stats_SubsystemsBuiltInRUs Stats_TimeKilled Stats_TotalDuration Stats_TotalKills Stats_TotalKillsInRUs Stats_TotalLosses Stats_TotalLossesInRUs Stats_TotalShipsBuilt Stats_TotalShipsBuiltInRUs Stats_TotalSquadKillsInRUs Stats_TotalSquadLossesInRUs Stats_TributeDonated Stats_TributeReceived StatusAttackComplete StatusBattleMomentum StatusBuildAvailable StatusCaptureComplete StatusCloud StatusCriticallyDamaged StatusDamaged StatusHyperspaceExit StatusHyperspaceInterrupted StatusInMineField StatusRepairs StatusResearchAvailable StatusResearchComplete StatusResearchNoRUs StatusResources StatusRetaliating StatusShipDestroyed StatusShipDocked StatusSubsystem StatusTakingHeavyDamage StatusTakingLightDamage StatusUnderAttack StatusUnderFireNeedOrders StatusUpdgradeNoRUs StatusUpgradeAvailable StatusUpgradeComplete stopAnim strbyte strchar strfind strlen strlower strrep strsub strupper Subtitle_Add Subtitle_IsDone Subtitle_IsMessageDone Subtitle_Message Subtitle_TimeCounter Subtitle_TimeCounterEnd

T tag tan Timer_Add Timer_Display Timer_End Timer_GetRemaining Timer_Pause Timer_Resume Timer_Start tinsert tmpname toggleEngineBurns toggleNavLights tonumber tostring tremove type typeid

U UC_Family UC_FamilyOverride UC_ShipType UC_ShipTypeOverride UI_AddToEventScreen UI_BindKeyEvent UI_ClearEventScreen UI_DialogAccept UI_DialogAcceptID UI_DialogCancel UI_DialogCancelID UI_ExitApp UI_FlashButton UI_GetCurrentScreenID UI_GetScreenID UI_GiveFocus UI_HideScreen UI_IsNamedElementVisible UI_IsScreenActive UI_NextScreen UI_PlaySound UI_PopState UI_PreviousScreen UI_PushState UI_ReloadAllScreens UI_ReloadCurrentScreen UI_ReloadScreen UI_ScreenIsActive UI_SetButtonPressed UI_SetButtonTextHotkey UI_SetElementEnabled UI_SetElementPosition UI_SetElementSize UI_SetElementVisible UI_SetInterfaceEnabled UI_SetInterfaceVisible UI_SetLabelTextHotkey UI_SetNextScreen UI_SetPreviousScreen UI_SetScreenEnabled UI_SetScreenVisible UI_SetTextLabelText UI_ShowDialog UI_ShowScreen UI_StartGameWithSelectedLevel UI_StopFlashButton UI_SubtitleNarrow UI_SubtitleWide UI_ToggleScreen UI_ToggleScreenElement UI_ToggleScreenGameRubrick UI_UnBindKeyEvent Universe_AllowClicks Universe_AllowPlayerOrders Universe_AllowSelect Universe_ClipToWorldBounds Universe_CurrentPlayer Universe_EnableCmd Universe_EnableSkip Universe_Fade Universe_GameTime Universe_GetCurrentMoveHeight Universe_GetWorldBounds Universe_IsPiePlateActive Universe_MoveRestrictToVolume Universe_NebulaDelete Universe_Pause Universe_PlayerCount Universe_SetAvoidance Universe_SlowDown''' unpauseAnim'''

V version Volume_AddCube Volume_AddSphere Volume_Delete

W Wait_End Wait_Start WIDTH Wireframe write writeto