playground:playground

This is an old revision of the document!

Table of Contents

PlayGround
4RPL Scripting Language
- API reference
  - Variables
  - Functions
  - Arithmetic
  - Comparators
  - Logic
  - Constants
  - Debugging
  - Flow Control
  - Lists
  - Vector
  - Output
  - Stack
  - Math
  - Game
  - Unit
  - Unit Attributes
  - Unit Objects
  - Beams
  - IO
  - Theme
  - Editing
  - Strings
  - Tables
  - Sound
  - Raster
  - Data
  - Timers
  - Eggs/Orbs
  - Terrain
  - Creeper
  - Mission
  - Decals
- Full Index

PlayGround

4RPL Scripting Language

Read the Overview, or see some Tutorials

API reference

Variables

$init_var
$$init_var
<-var
->var
-?var
--var
<-!
->!
-?!
--?
ClearLocals
NotPersist

Special var syntax
· Vectors
· Lists
· Tables

Functions

@FUNC_NAME
:FUNC_NAME

Built in Function Callbacks
:Awake
:GameLoaded
:Destroyed
:Once
:BuildComplete
:_UICallback

Arithmetic

_Note¹⁾
add
sub
mul
div
mod
mod2

Comparators

_Note²⁾
gt
gte
lt
lte
eq
neq
gt0
gte0
lt0
lte0
eq0
neq0

Logic

and
or
xor
not
true
false

Constants

PI
TwoPI
TAU
HalfPI
QuarterPI
ThreeQuarterPI
ThreeHalvesPI
E
Rad2Deg
Deg2Rad
Vector0

Debugging

Debug
DebugAllSp
Trace
TraceAll
TraceAllSp
Trace2
Trace3
Trace4
Trace5
TraceStack
ClearTraceLog
GetTimeString

Flow Control

if
else
endif
while
repeat
endwhile
break
do
loop
I
J
K
once
endonce
refcall
return

Lists

CreateList
GlobalList get | set
List
ListN
CreateListStartingSize
ListElement get set
set ListElementRPN
AppendToList
PushList
PopList
PrependToList
AppendStackToList
PrependStackToList
InsertListElement
RemoveListElement
get ListCount
ListContains
ReverseList
ClearList

Vector

Dot
Cross
V2
V3
V4
EV2
EV3
EV4
ToCell
FromCell
Magnitude
SqrMagnitude
Normalize

Output

DQ
CR
LF
TAB
Print
PrintAll
PrintAllSp
Print2
Print3
Print4
Print5
PrintStack

Stack

dup
dup2
swap
pop
ClearStack
StackSize
Copy
DeepCopy

Game

InvocationCount
GetLastExecutionCount
IsMissionComplete
Self
ShowADAMessage
ShowADAMessageAtCell
ShowADAMessageAtUnit
IsADAMessageShowing
IsADAMessageRead
GetADALogOpen
SetADALogOpen
GetFinalDialogOpen
GetTerraformMenuOpen
GetMissionScanComplete
ShowGameMessage
CloseGameMessage
IsGameMessageShowing
SetGameMessageText
ShowUIIndicator
GetSoylentMode
SetSoylentMode
GetCanMoveUnits
SetCanMoveUnits
SetCModEditMenuName
SetCModPlayerMenuName
SetUnitsSelectable
SetCreeperGraphAvailable
SetDepartButtonAvailable
GetOpenBuildTab
GetOrbitalCount
SetOrbitalCount
GetEcoCounts
IsBuildUnitSelected
GetSelectedUnits
GetPause
SetPause
GetEditMode
Cancel
RegisterforMsg
DeregisterforMsg
SendMsg
StopConsole
GetGameUpdateCount
GetGameTickCount
GetMapSize
FC
UFC
IsV3InMap
IsV2InMap
GetRandMapCell
SetFieldRect
DamageMesh
FindUnitEnemy
GetNearestSpore
GetNearestAirSac
GetNearestSniperTarget
RefreshUnitLosCache
ApplyToDamageMap
RemoveUnitDamageMap
GenerateEnergy
SuppressTotemActivation
BounceFadeBlack

Unit

UseLegalUnitCells
SetLegalUnitCells
SetAllLegalUnitCells
GetUnitCanBuild
GetUnitCount
SetUnitCanBuild
GetUnitSelected
SetUnitSelected
GetUnitSelectable
SetUnitSelectable
SetUnitOutlineEnabled
SetUnitOutlineWidth
SetUnitOutlineColor
SetUnitOutlineMode
GetUnitConstructing
GetUnitConstructingData
GetUnitConnectedToRiftLab
GetUnitSuppressMovement
SetUnitSuppressMovement
GetUnitSpecifiedTarget
SetUnitSpecifiedTarget
ClearUnitSpecifiedTarget
SetUnitSpecifiedTargetShowPath
SetUnitSpecifiedTargetPathHeight
SetUnitSpecifiedTargetPathSourceOffset
SetUnitSpecifiedTargetOccupiesMap
SetUnitDebugText
CreateUnit
CreateUnitOnTerrain
DestroyUnit
CreateEffect
CreateMist
CreateMissile
CreateSniperShot
SetWallCharged
GetERNPortalEfficiency
GetRiftLab
GetFactory
GetERNPortal
GetMinerMode
GetUnitPosition
SetUnitPosition
GetUnitCell
SetUnitCell
GetUnitRotation
SetUnitRotation
GetUnitForward
SetUnitForward
RotateUnit
RotateUnitTowards
RotateUnitTowardsCell
GetUnitsInRange
GetUnitsByType
GetScriptVar
SetScriptVar
GetScript1Var
SetScript1Var
DamageUnit
GetUnitUIState
SetUnitUIState
GetUnitUIText
SetUnitUIText
GetUnitUIOptions
SetUnitUIOptions
GetUnitShieldRange
SetUnitShieldRange
DeployUnitShield
SetUnitShieldVisible
SetUnitPopupEnabled
SetUnitPopupText0
SetUnitPopupText1
MoveTowardsAndAvoid
MoveTowardsCellAndAvoid

Unit Attributes

AddAsWareHolder
RemoveAsWareHolder
UnitAmmo Get | Set
UnitAnticreeperDamages Get | Set
UnitArmed Get | Set
UnitCanDestroy Get | Set
UnitConnectable Get | Set
UnitCreeperDamages Get | Set
UnitDamagedByAC Get | Set
UnitDamagedByCreeper Get | Set
UnitDestroyed Get
UnitDestroyUnevenLand Get | Set
UnitEnabled Get | Set
UnitERNState Get
UnitFireOffset Get | Set
UnitFootprintResistsCreeperHeight Get | Set
UnitHealth Get | Set
UnitLOSEnabled Set
UnitMaxAmmo Get | Set
UnitMaxHealth Get | Set
UnitOccupiesLand Get | Set
UnitOfficialName Get
UnitPacketRequestRate Get | Set
UnitRange Get | Set
UnitRangeWithMods Get
UnitRequestPackets Get | Set
UnitSupplied Get | Set
UnitSuppressCount Get | Set
UnitTargetOffset Get | Set
UnitUpdateCount Get

Beams

CreateBeam
DestroyBeam
SetBeamVisible
SetBeamColor
SetBeamBrightness
SetBeamWidth
SetBeamStart
SetBeamEnd
AttachBeam
UnattachBeam
SetBeamForceLocalEnd
IsBeam
DestroyAllBeams
DestroyAllAttachedBeams

Editing

EditAddUndo
EditRestoreUndo
EditRedo
ShowTerrainRangeIndicator
DestroyTerrainRangeIndicator

Strings

asstring
Concat
Concat3
Concat4
Substring
StartsWith
EndsWith
Split
StringToList
StringLength
ToUpper
ToLower
StringReplace

Tables

CreateTable
GetGlobalTable
SetGlobalTable
GetTableElement
SetTableElement
SetTableElementRPN
RemoveTableElement
Table
TableN
GetTableKeys
GetTableValues

Sound

PlaySoundAtPosition
PlaySound
PlaySoundLoop
StopSoundLoop

Raster

ShowRaster
SetRasterSize
ClearRaster
SetRaster
SetRasterC
RasterColor
BlitRaster
BlitFadeRaster

Data

GetType
IsNull
NULL

Timers

SetTimerObeyPause0
SetTimerObeyPause1
SetTimerObeyPause2
SetTimerObeyPause3
SetTimer0
SetTimer1
SetTimer2
SetTimer3
GetTimer0
GetTimer1
GetTimer2
GetTimer3

Eggs/Orbs

CreateOrb
CreateEgg
SetEggOrbData

Terrain

GetTerrain
GetTerrainVector
SetTerrain
GetTerrainSpecial
SetTerrainSpecial
SetTerrainInRange
SetTerrainLine
GetExactTerrain
GetExactTerrainWithShield
FloodFillTerrain
BounceTerrainCollision
BounceEdgeCollision
GetTerrainLOS
GetVoidHeight
SetVoidHeight

Mission

GetMissionObjectiveState
AcquireMissionObjective
SetCustomObjectiveText
GetMissionObjectiveRequired
SetMissionObjectiveRequired
GetMissionObjectiveEnabled
SetMissionObjectiveEnabled
EndMission

Decals

GetDecalVisible
SetDecalVisible
GetDecalColor
SetDecalColor
GetDecalSize
SetDecalSize
GetDecalPosition
SetDecalPosition

Full Index

^1),
2) alternate notation in symbol_aliasing

playground/playground.1611004844.txt.gz · Last modified: 2021/01/18 16:20 by Karsten75