Difference between revisions of "Script commands"

From NexusWiki
Jump to: navigation, search
(Created page with '==Script structure commands== ===Structure=== {| style="width: 600px; background-color: transparent; text-align: left;" ! style="width: 33%" | *Choose *ChooseFirst *[[D...')
 
(Undo revision 34958 by 200.203.89.82 (talk))
 
(18 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 +
This aims to be a complete listing of all the script commands available while editing [[Nexus - The Jupiter Incident]] files. It is sorted using the same structure as the official modding documentation, that has been included in the game. If you're looking for more info about a particular command, then click on it and read the detailed description.
 +
 
==Script structure commands==
 
==Script structure commands==
  
 
===Structure===
 
===Structure===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
−
{| style="width: 600px; background-color: transparent; text-align: left;"
+
 
! style="width: 33%" |
 
! style="width: 33%" |
 
*[[Choose]]
 
*[[Choose]]
Line 17: Line 18:
  
 
===Variable manager===
 
===Variable manager===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
−
{| style="width: 600px; background-color: transparent; text-align: left;"
+
 
! style="width: 33%" |
 
! style="width: 33%" |
 
*[[Ceil]]
 
*[[Ceil]]
Line 88: Line 88:
  
 
===Selection===
 
===Selection===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
−
{| style="width: 600px; background-color: transparent; text-align: left;"
+
 
! style="width: 33%" |
 
! style="width: 33%" |
 
*[[AddItem]]
 
*[[AddItem]]
Line 129: Line 128:
  
 
===Event handling===
 
===Event handling===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[Call]]
 
*[[Call]]
 
*[[ClearTimer]]
 
*[[ClearTimer]]
Line 138: Line 138:
 
*[[MEvent]]
 
*[[MEvent]]
 
*[[PEvent]]
 
*[[PEvent]]
 +
! style="width: 33%" |
 
*[[Return]]
 
*[[Return]]
 
*[[RootEvent]]
 
*[[RootEvent]]
Line 146: Line 147:
 
*[[UTimer]]
 
*[[UTimer]]
 
*[[EnableGUIEvents]]
 
*[[EnableGUIEvents]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[RequestFiredEvent]]
 
*[[RequestFiredEvent]]
 
*[[obj:tRequestCriticalDamageEvent]]
 
*[[obj:tRequestCriticalDamageEvent]]
Line 153: Line 155:
 
*[[obj:tRequestOverforceEvent]]
 
*[[obj:tRequestOverforceEvent]]
 
*[[obj:tRequestShipInRangeEvent]]
 
*[[obj:tRequestShipInRangeEvent]]
 +
|}
  
 
===Statemachine===
 
===Statemachine===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[ChangeState]]
 
*[[ChangeState]]
 
*[[ChangeTick]]
 
*[[ChangeTick]]
 +
! style="width: 33%" |
 
*[[GetMachine]]
 
*[[GetMachine]]
 
*[[IsInState]]
 
*[[IsInState]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[LeaveState]]
 
*[[LeaveState]]
 +
|}
  
 
===Multiplay===
 
===Multiplay===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[MpGameOver]]
 
*[[MpGameOver]]
 
*[[MpGetPlayer]]
 
*[[MpGetPlayer]]
Line 172: Line 180:
 
*[[MpGetTeamGain]]
 
*[[MpGetTeamGain]]
 
*[[MpGetTeamRace]]
 
*[[MpGetTeamRace]]
 +
! style="width: 33%" |
 
*[[MpGetWinningCondition]]
 
*[[MpGetWinningCondition]]
 
*[[MpGetWinningConditionParam]]
 
*[[MpGetWinningConditionParam]]
Line 180: Line 189:
 
*[[MpEnableJumpIn]]
 
*[[MpEnableJumpIn]]
 
*[[MpEnableJumpOut]]
 
*[[MpEnableJumpOut]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[MpSetDead]]
 
*[[MpSetDead]]
 
*[[MpSetTeamGain]]
 
*[[MpSetTeamGain]]
Line 187: Line 197:
 
*[[MpSpawnPoint]]
 
*[[MpSpawnPoint]]
 
*[[SetSceneRadius]]
 
*[[SetSceneRadius]]
 +
|}
  
 
==Mission script commands==
 
==Mission script commands==
  
 
===Scene===
 
===Scene===
−
 
+
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[AddMechaLegion]]
 
*[[AddMechaLegion]]
 
*[[AddNavigPoint]]
 
*[[AddNavigPoint]]
Line 209: Line 221:
 
*[[GuiEnable]]
 
*[[GuiEnable]]
 
*[[GuiSelect]]
 
*[[GuiSelect]]
 +
! style="width: 33%" |
 
*[[MissionObjective]]
 
*[[MissionObjective]]
 
*[[MoveNPC]]
 
*[[MoveNPC]]
Line 226: Line 239:
 
*[[SetAreaAbs]]
 
*[[SetAreaAbs]]
 
*[[SetFogColor]]
 
*[[SetFogColor]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[SetFogDensity]]
 
*[[SetFogDensity]]
 
*[[SetListOrder]]
 
*[[SetListOrder]]
Line 241: Line 255:
 
*[[StopCountdown]]
 
*[[StopCountdown]]
 
*[[Transmission]]
 
*[[Transmission]]
 +
|}
  
 
===Jump===
 
===Jump===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[AppearFleet]]
 
*[[AppearFleet]]
 
*[[JumpInShips]]
 
*[[JumpInShips]]
 +
! style="width: 33%" |
 
*[[SetFleetEntry]]
 
*[[SetFleetEntry]]
 
*[[StartJump]]
 
*[[StartJump]]
 +
! style="width: 33%; vertical-align: top;" |
 +
|}
  
 
===Operations of races===
 
===Operations of races===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[ForbidFirePurp]]
 
*[[ForbidFirePurp]]
 
*[[GetNavigPoint]]
 
*[[GetNavigPoint]]
 +
! style="width: 33%" |
 
*[[GetRelation]]
 
*[[GetRelation]]
 
*[[Race2civilization]]
 
*[[Race2civilization]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[SetRelation]]
 
*[[SetRelation]]
 +
|}
  
 
===Messages and postings===
 
===Messages and postings===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[Dialog]]
 
*[[Dialog]]
 
*[[DeletePendingDialogs]]
 
*[[DeletePendingDialogs]]
 
*[[HideDialog]]
 
*[[HideDialog]]
 +
! style="width: 33%" |
 
*[[NoTitle]]
 
*[[NoTitle]]
 
*[[NoTutorial]]
 
*[[NoTutorial]]
 
*[[Title]]
 
*[[Title]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[TitleNoTime]]
 
*[[TitleNoTime]]
 
*[[Tutorial]]
 
*[[Tutorial]]
 +
|}
  
 
===Camera handling===
 
===Camera handling===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[CamBoatView]]
 
*[[CamBoatView]]
 
*[[CamGoRound]]
 
*[[CamGoRound]]
Line 273: Line 305:
 
*[[CamLookAt]]
 
*[[CamLookAt]]
 
*[[CamMoveAndTurn]]
 
*[[CamMoveAndTurn]]
 +
! style="width: 33%" |
 
*[[CamMoveTo]]
 
*[[CamMoveTo]]
 
*[[CamOrient]]
 
*[[CamOrient]]
Line 280: Line 313:
 
*[[CamShift]]
 
*[[CamShift]]
 
*[[CamTargetView]]
 
*[[CamTargetView]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[CamTripleMode]]
 
*[[CamTripleMode]]
 
*[[CamTurnTo]]
 
*[[CamTurnTo]]
Line 285: Line 319:
 
*[[ChangeLocation]]
 
*[[ChangeLocation]]
 
*[[FadeScreen]]
 
*[[FadeScreen]]
 +
|}
  
 
==Ship related commands==
 
==Ship related commands==
  
 
===General===
 
===General===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 
*[[Add2Fleet]]
 
*[[Add2Fleet]]
 
*[[AddBreachPoint]]
 
*[[AddBreachPoint]]
Line 297: Line 334:
 
*[[CreateShip]]
 
*[[CreateShip]]
 
*[[DeleteShip]]
 
*[[DeleteShip]]
 +
! style="width: 33%" |
 
*[[Disappear]]
 
*[[Disappear]]
 
*[[DockOut]]
 
*[[DockOut]]
Line 305: Line 343:
 
*[[NumBreachPoints]]
 
*[[NumBreachPoints]]
 
*[[NumDockPoints]]
 
*[[NumDockPoints]]
 +
! style="width: 33%; vertical-align: top;" |
 
*[[PlayShipAnim]]
 
*[[PlayShipAnim]]
 
*[[RenameShip]]
 
*[[RenameShip]]
Line 313: Line 352:
 
*[[Terminate]]
 
*[[Terminate]]
 
*[[UniteShips]]
 
*[[UniteShips]]
 +
|}
  
 
===Tactics===
 
===Tactics===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[NumShooters]]
 +
*[[IsShot]]
 +
*[[EverShot]]
 +
*[[EnableEvacBoats]]
 +
*[[EnableUnit]]
 +
*[[GetDefense]]
 +
*[[SendCommand]]
 +
*[[SetFlakTargets]]
 +
*[[obj:tAwayFrom]]
 +
*[[obj:tAwayFromIntensity]]
 +
! style="width: 33%" |
 +
*[[obj:tClearAway]]
 +
*[[obj:tClearAwayAll]]
 +
*[[obj:tClearCommand]]
 +
*[[obj:tClearFire]]
 +
*[[obj:tClearForbid]]
 +
*[[obj:tClearGuard]]
 +
*[[obj:tClearTerritory]]
 +
*[[obj:tDamage]]
 +
*[[obj:tDamageRecalc]]
 +
*[[obj:tDange]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[obj:tDangerBase]]
 +
*[[obj:tAutoEnergyMode]]
 +
*[[obj:tEnergyMode]]
 +
*[[obj:tEngineMode]]
 +
*[[obj:tFireTo]]
 +
*[[obj:tGuard]]
 +
*[[obj:tPlayerControl]]
 +
*[[obj:tRequestFirstHitEvent]]
 +
*[[obj:tSetForbid]]
 +
|}
  
 
===Movement and territory===
 
===Movement and territory===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[ClearOrient]]
 +
*[[ClearLongRangeDir]]
 +
*[[CloseAbs]]
 +
*[[CloseOff]]
 +
*[[CloseShip]]
 +
*[[DeactivateEngine]]
 +
*[[Distance]]
 +
*[[EnableDodge]]
 +
*[[EnableFortPass]]
 +
*[[ForceOrient]]
 +
! style="width: 33%;" |
 +
*[[InArea]]
 +
*[[LongRangeArrive]]
 +
*[[PutShip]]
 +
*[[PutShipRel]]
 +
*[[Range]]
 +
*[[SetAbsSpeed]]
 +
*[[SetGlobalSpeedFactor]]
 +
*[[SetLongRangeDir]]
 +
*[[SetMicroJumpArea]]
 +
*[[SetSpeedFactor]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[SetTerrArea]]
 +
*[[SetTerritory]]
 +
*[[ShipGoRound]]
 +
*[[obj:tClearMove]]
 +
*[[obj:tGetMaxVelocity]]
 +
*[[obj:tGetVelocity]]
 +
*[[obj:tMoveTo]]
 +
*[[obj:tMoveToIntensity]]
 +
*[[obj:tSetTerritory]]
 +
|}
  
 
===Devices and weapons===
 
===Devices and weapons===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[ActivateDevice]]
 +
*[[ActivateDeviceType]]
 +
*[[CanPenetrate]]
 +
*[[DeleteDevice]]
 +
*[[DeviceFocused]]
 +
*[[EnableDevice]]
 +
*[[EnableActivateEvents]]
 +
*[[EnableMechaEmitShip]]
 +
*[[FocusDevice]]
 +
! style="width: 33%;" |
 +
*[[GetDevices]]
 +
*[[GetDevScanned]]
 +
*[[HasDevType]]
 +
*[[InSet]]
 +
*[[InstallDevice]]
 +
*[[LoadWeapon]]
 +
*[[Purpose]]
 +
*[[SetDevScanned]]
 +
*[[SetPrecision]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[SetRepairFactor]]
 +
*[[SetScanned]]
 +
*[[TargetWeapon]]
 +
*[[TransferDevice]]
 +
*[[TransferSquadron]]
 +
*[[WeaponDamage]]
 +
*[[WeaponMode]]
 +
|}
  
 
===Detection===
 
===Detection===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[DetectEnable]]
 +
*[[FreezeReconState]]
 +
*[[GetDetected]]
 +
*[[GetIdentified]]
 +
*[[GetScanned]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[HideShip]]
 +
*[[IdentEnable]]
 +
*[[MakeFullyKnown]]
 +
*[[ScanEnable]]
 +
*[[SetDetected]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[SetDetectedFaded]]
 +
*[[SetDevScanned]]
 +
*[[SetIdentified]]
 +
*[[SetMisidentified]]
 +
*[[UnhideShip]]
 +
|}
  
 
===Formations===
 
===Formations===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[EndFormation]]
 +
*[[PutFormationWings]]
 +
*[[StartFormation]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[obj:tClearFollow]]
 +
*[[obj:tClearFormation]]
 +
*[[obj:tFollow]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[obj:tSetFormation]]
 +
|}
 +
 +
==Campaign script commands==
 +
 +
These commands are being used by the story rules located in ''universe/story/rules''. They control progression in the campaign and connect the individual missions to one another.
 +
 +
===Equipment and stock===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[obj:uInset]]
 +
*[[obj:uInstallDevice]]
 +
*[[obj:uRemoveDevice]]
 +
*[[obj:uSetRequired]]
 +
! style="width: 33%" |
 +
*[[obj:uSetResourcePoints]]
 +
*[[uAddDevicesToStock]]
 +
*[[uClearResourceStock]]
 +
*[[uFleetScreenReadOnly]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[uRepairPlayersFleet]]
 +
*[[uShowFleetScreen]]
 +
|}
 +
 +
===Mission progression===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[uEnterMission]]
 +
! style="width: 33%" |
 +
*[[uEnterMissionQuick]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[uSetNextMission]]
 +
|}
 +
 +
===Miscellaneous===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[obj:uCopyReproducableDevTypes]]
 +
*[[obj:uSetParent]]
 +
*[[uDifficultyLevel]]
 +
*[[uGet]]
 +
! style="width: 33%" |
 +
*[[uGetNPC]]
 +
*[[uGetPlayersFleet]]
 +
*[[uGui_EnableCommand]]
 +
*[[uPlayBink]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[uPlayBriefing]]
 +
*[[uSelectNR]]
 +
*[[uSetDetectionLevel]]
 +
*[[uSetStoryDate]]
 +
|}
 +
 +
 +
[[Category:Modding Help]]

Latest revision as of 10:20, 1 May 2013

This aims to be a complete listing of all the script commands available while editing Nexus - The Jupiter Incident files. It is sorted using the same structure as the official modding documentation, that has been included in the game. If you're looking for more info about a particular command, then click on it and read the detailed description.

Script structure commands

Structure

Variable manager

Selection

Event handling

Statemachine

Multiplay

Mission script commands

Scene

Jump

Operations of races

Messages and postings

Camera handling

Ship related commands

General

Tactics

Movement and territory

Devices and weapons

Detection

Formations

Campaign script commands

These commands are being used by the story rules located in universe/story/rules. They control progression in the campaign and connect the individual missions to one another.

Equipment and stock

Mission progression

Miscellaneous

Retrieved from "http://nexusthegame.net/w/index.php?title=Script_commands&oldid=35280"