Difference between revisions of "Script commands"

From NexusWiki
Jump to: navigation, search
(HzVrzbaFIZxWlv)
Line 1: Line 1:
−
I have yet to deMystify' the games produced by the Miller Brothers, hovweer I've very much enjoyed the hours of staring at and widgeting the puzzles that tease and mentally provoke. While the story is primarly of caucasion characters in lead, the ideology of the premis seems to lean toward many cultures. I think this is a wise sifting of demographic origins. And yet the aboriginal seems, to me, the target of colonialism. A bit exploited. The sense of India and English embattlement throughout Ghandis timely influence is a reference. Also, I'm reminded of the East being the most advanced societies in times of the Medieval through time forgotten and once again  dis-covered'. T.E. Lawrence comes to mind  Seven Pillars Of Wisdom'. The reasons of nomadic displacement in the middle east. In any event, the storys arc (Myst) is ripe with possible sociological premis. The books  could  be along the depth of Frank Herberts  Dune'. When made into a movie spectacular on as many levels. I would hope a message embedded within (the arc) could be incorporated. My heartfelt support for your projects (plural) completion.
+
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===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[Choose]]
 +
*[[ChooseFirst]]
 +
*[[Delay]]
 +
! style="width: 33%" |
 +
*[[If]]
 +
*[[IsValid]]
 +
*[[When]]
 +
! style="vertical-align:top; width: 33%;" |
 +
*[[While]]
 +
|}
 +
 
 +
===Variable manager===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[Ceil]]
 +
*[[Cos]]
 +
*[[Exp]]
 +
*[[Floor]]
 +
*[[Log]]
 +
*[[Max]]
 +
*[[Min]]
 +
*[[Not]]
 +
*[[Pow]]
 +
*[[Rnd]]
 +
*[[Round]]
 +
*[[Sin]]
 +
*[[Sqrt]]
 +
*[[Col]]
 +
*[[CHeat]]
 +
*[[CPlanck]]
 +
*[[CInv]]
 +
*[[CAdd]]
 +
*[[CAdda]]
 +
*[[CMul]]
 +
*[[CLerp]]
 +
! style="width: 33%" |
 +
*[[CBrig]]
 +
*[[CEqu]]
 +
*[[GetVal]]
 +
*[[IsName]]
 +
*[[Rot]]
 +
*[[V2Rot]]
 +
*[[R2Vec]]
 +
*[[Requ]]
 +
*[[RNull]]
 +
*[[SLen]]
 +
*[[SCat]]
 +
*[[SSub]]
 +
*[[SNum]]
 +
*[[SNumPad]]
 +
*[[SCmp]]
 +
*[[SiCmp]]
 +
*[[Set]]
 +
*[[SetVal]]
 +
*[[XfIdent]]
 +
*[[XfTran]]
 +
*[[XfRotX]]
 +
! style="width: 33%" |
 +
*[[XfRotY]]
 +
*[[XfRotZ]]
 +
*[[XfRot]]
 +
*[[XfScale]]
 +
*[[XfInv]]
 +
*[[XfTran]]
 +
*[[XfMul]]
 +
*[[Vec]]
 +
*[[VNull]]
 +
*[[VRandomOrth]]
 +
*[[VLen]]
 +
*[[VSqLen]]
 +
*[[VNorm]]
 +
*[[VNeg]]
 +
*[[VAdd]]
 +
*[[VSub]]
 +
*[[VMul]]
 +
*[[VDot]]
 +
*[[VCross]]
 +
*[[VEqu]]
 +
*[[VXform]]
 +
|}
 +
 
 +
===Selection===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[AddItem]]
 +
*[[AddList]]
 +
*[[AllNum]]
 +
*[[Copy]]
 +
*[[CopyIf]]
 +
*[[DeleteSelect]]
 +
*[[Deselect]]
 +
*[[Dim]]
 +
*[[Empty]]
 +
*[[ExecList]]
 +
*[[obj:Colony]]
 +
! style="width: 33%" |
 +
*[[FindUnder]]
 +
*[[FirstNotScanned]]
 +
*[[GetFreeSel]]
 +
*[[GetN]]
 +
*[[IndexOf]]
 +
*[[InSelection]]
 +
*[[MaxList]]
 +
*[[NumOf]]
 +
*[[Pick]]
 +
*[[PickFirst]]
 +
*[[PickMax]]
 +
! style="width: 33%" |
 +
*[[PickN]]
 +
*[[RemoveFirst]]
 +
*[[RemoveItem]]
 +
*[[Select]]
 +
*[[SelectBoats]]
 +
*[[SelectDevices]]
 +
*[[SelectEx]]
 +
*[[SelectShips]]
 +
*[[SelWeightMul]]
 +
*[[SetN]]
 +
*[[SubList]]
 +
|}
 +
 
 +
===Event handling===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[Call]]
 +
*[[ClearTimer]]
 +
*[[Disable]]
 +
*[[Enable]]
 +
*[[EventEx]]
 +
*[[LocalEvent]]
 +
*[[MEvent]]
 +
*[[PEvent]]
 +
! style="width: 33%" |
 +
*[[Return]]
 +
*[[RootEvent]]
 +
*[[Timer]]
 +
*[[StartTimer]]
 +
*[[UCall]]
 +
*[[UEvent]]
 +
*[[UTimer]]
 +
*[[EnableGUIEvents]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[RequestFiredEvent]]
 +
*[[obj:tRequestCriticalDamageEvent]]
 +
*[[obj:tRequestDetectionEvent]]
 +
*[[obj:tRequestEnergyOnMax]]
 +
*[[obj:tRequestNoShipsInRangeEvent]]
 +
*[[obj:tRequestOverforceEvent]]
 +
*[[obj:tRequestShipInRangeEvent]]
 +
|}
 +
 
 +
===Statemachine===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[ChangeState]]
 +
*[[ChangeTick]]
 +
! style="width: 33%" |
 +
*[[GetMachine]]
 +
*[[IsInState]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[LeaveState]]
 +
|}
 +
 
 +
===Multiplay===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[MpGameOver]]
 +
*[[MpGetPlayer]]
 +
*[[MpGetPlayerCount]]
 +
*[[MpGetPlayerKills]]
 +
*[[MpGetPlayerGain]]
 +
*[[MpGetTeamKills]]
 +
*[[MpGetTeamGain]]
 +
*[[MpGetTeamRace]]
 +
! style="width: 33%" |
 +
*[[MpGetWinningCondition]]
 +
*[[MpGetWinningConditionParam]]
 +
*[[MpHoldPrepare]]
 +
*[[MpHoldPrepare]]
 +
*[[MpIsIndividual]]
 +
*[[MpIsPlayerValid]]
 +
*[[MpEnableJumpIn]]
 +
*[[MpEnableJumpOut]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[MpSetDead]]
 +
*[[MpSetTeamGain]]
 +
*[[MpSetPlayerGain]]
 +
*[[MpSetWinnerTeam]]
 +
*[[MpSetWinnerPlayer]]
 +
*[[MpSpawnPoint]]
 +
*[[SetSceneRadius]]
 +
|}
 +
 
 +
==Mission script commands==
 +
 
 +
===Scene===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[AddMechaLegion]]
 +
*[[AddNavigPoint]]
 +
*[[Area]]
 +
*[[AreaExplosion]]
 +
*[[AssignSecret]]
 +
*[[celestial:uPlanetSurfBattle]]
 +
*[[ClearArea]]
 +
*[[CloseGate]]
 +
*[[EnableAI]]
 +
*[[EndTraffic]]
 +
*[[GameOver]]
 +
*[[GenAsteroidField]]
 +
*[[GetHidden]]
 +
*[[GetSceneObj]]
 +
*[[GetStation]]
 +
*[[GuiEnable]]
 +
*[[GuiSelect]]
 +
! style="width: 33%" |
 +
*[[MissionObjective]]
 +
*[[MoveNPC]]
 +
*[[npc:uStepRank]]
 +
*[[npc:uAddMedal]]
 +
*[[npc:uHasMedal]]
 +
*[[OpenGate]]
 +
*[[PlayEfx]]
 +
*[[PlayMovie]]
 +
*[[PlayMusic]]
 +
*[[PreCacheNPC]]
 +
*[[UQuitMission]]
 +
*[[ScanEnable]]
 +
*[[SelectShip]]
 +
*[[SelectSquadron]]
 +
*[[SetArea]]
 +
*[[SetAreaAbs]]
 +
*[[SetFogColor]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[SetFogDensity]]
 +
*[[SetListOrder]]
 +
*[[SetListPriority]]
 +
*[[SetMotionFactor]]
 +
*[[SetObjectivePrimary]]
 +
*[[SetOwnRace]]
 +
*[[SetPlayersRace]]
 +
*[[SetScreenFilter]]
 +
*[[SetXPCategories]]
 +
*[[ShowMissionStatus]]
 +
*[[SoundEnable]]
 +
*[[StartCountdown]]
 +
*[[StartTraffic]]
 +
*[[StopCountdown]]
 +
*[[Transmission]]
 +
|}
 +
 
 +
===Jump===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[AppearFleet]]
 +
*[[JumpInShips]]
 +
! style="width: 33%" |
 +
*[[SetFleetEntry]]
 +
*[[StartJump]]
 +
! style="width: 33%; vertical-align: top;" |
 +
|}
 +
 
 +
===Operations of races===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[ForbidFirePurp]]
 +
*[[GetNavigPoint]]
 +
! style="width: 33%" |
 +
*[[GetRelation]]
 +
*[[Race2civilization]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[SetRelation]]
 +
|}
 +
 
 +
===Messages and postings===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[Dialog]]
 +
*[[DeletePendingDialogs]]
 +
*[[HideDialog]]
 +
! style="width: 33%" |
 +
*[[NoTitle]]
 +
*[[NoTutorial]]
 +
*[[Title]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[TitleNoTime]]
 +
*[[Tutorial]]
 +
|}
 +
 
 +
===Camera handling===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[CamBoatView]]
 +
*[[CamGoRound]]
 +
*[[CamLinear]]
 +
*[[CamLocate]]
 +
*[[CamLockPos]]
 +
*[[CamLookAt]]
 +
*[[CamMoveAndTurn]]
 +
! style="width: 33%" |
 +
*[[CamMoveTo]]
 +
*[[CamOrient]]
 +
*[[CamOrientAbs]]
 +
*[[CamOrientRoll]]
 +
*[[CamRoll]]
 +
*[[CamShift]]
 +
*[[CamTargetView]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[CamTripleMode]]
 +
*[[CamTurnTo]]
 +
*[[CamWeaponView]]
 +
*[[ChangeLocation]]
 +
*[[FadeScreen]]
 +
|}
 +
 
 +
==Ship related commands==
 +
 
 +
===General===
 +
{| style="width: 100%; background-color: transparent; text-align: left;"
 +
! style="width: 33%" |
 +
*[[Add2Fleet]]
 +
*[[AddBreachPoint]]
 +
*[[AnimateShip]]
 +
*[[Appear]]
 +
*[[BlinkShip]]
 +
*[[ClearLampSignal]]
 +
*[[CreateShip]]
 +
*[[DeleteShip]]
 +
! style="width: 33%" |
 +
*[[Disappear]]
 +
*[[DockOut]]
 +
*[[Evacuate]]
 +
*[[Explode]]
 +
*[[GetDockPoint]]
 +
*[[SetLampSignal]]
 +
*[[NumBreachPoints]]
 +
*[[NumDockPoints]]
 +
! style="width: 33%; vertical-align: top;" |
 +
*[[PlayShipAnim]]
 +
*[[RenameShip]]
 +
*[[SendTransport]]
 +
*[[obj:tSetWarning]]
 +
*[[SetUndamageable]]
 +
*[[SplitShip]]
 +
*[[Terminate]]
 +
*[[UniteShips]]
 +
|}
 +
 
 +
===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===
 +
{| 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===
 +
{| 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===
 +
{| 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===
 +
{| 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]]

Revision as of 09:40, 19 October 2012

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=4202"