User Tools

Site Tools


playground:playground

This is an old revision of the document!


PlayGround

4RPL Scripting Language

API reference

Arithmetic

add
div
mod
mod2
mul
pow
sub

Comparators

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



Game

ADALogOpen Get | Set
ApplyToDamageMap
BounceFadeBlack
Cancel
CanMoveUnits Get | Set
CloseGameMessage
CModEditMenuName Set
CModPlayerMenuName Set
CreeperGraphAvailable Set
DamageMesh
DepartButtonAvailable Set
DeregisterforMsg
EcoCounts Get
EditMode Get
FC
FieldRect Set
FinalDialogOpen Get
FindUnitEnemy
GameMessageText Set
GameTickCount Get
GameUpdateCount Get
GenerateEnergy
InvocationCount
IsADAMessageRead
IsADAMessageShowing
IsBuildUnitSelected
IsGameMessageShowing
IsMissionComplete
IsV2InMap
IsV3InMap
LastExecutionCount Get
MapSize Get
MissionScanComplete Get
NearestAirSac Get
NearestSniperTarget Get
NearestSpore Get
OpenBuildTab Get
OrbitalCount Get | Set
Pause Get | Set
RandMapCell Get
RefreshUnitLosCache
RegisterforMsg
RemoveUnitDamageMap
SelectedUnits Get
SendMsg
ShowADAMessage
ShowADAMessageAtCell
ShowADAMessageAtUnit
ShowGameMessage
ShowUIIndicator
SoylentMode Get
SoylentMode Set
StopConsole
SuppressTotemActivation
TerraformMenuOpen Get
TimeString Get
UFC
UnitsSelectable Set

Unit

AllLegalUnitCells Set
ClearUnitSpecifiedTarget
ClearUnitStun
CreateEffect
CreateMissile
CreateMist
CreateSniperShot
CreateUnit
CreateUnitOnTerrain
DamageUnit
DeployUnitShield
DestroyUnit
ERNPortal Get
ERNPortalEfficiency Get
Factory Get
LegalUnitCells Set
MinerMode Get
MoveTowardsAndAvoid
MoveTowardsCellAndAvoid
RiftLab Get
RotateUnit
RotateUnitTowards
RotateUnitTowardsCell
Script1Var Get | Set
ScriptVar Get | Set
Self
StunUnit
StunUnitsInRange
UnitCanBuild Get | Set
UnitCell Get | Set
UnitConnectedToRiftLab Get
UnitConstructing Get
UnitConstructingData Get
UnitCount Get
UnitDebugText Set
UnitForward Get | Set
UnitOutlineColor Set
UnitOutlineEnabled Set
UnitOutlineMode Set
UnitOutlineWidth Set
UnitPopupEnabled Set
UnitPopupText0 Set
UnitPopupText1 Set
UnitPosition Get | Set
UnitRotation Get | Set
UnitsByType Get
UnitSelectable Get | Set
UnitSelected Get | Set
UnitShieldRange Get | Set
UnitShieldVisible Set
Units Get
UnitsInRange Get
UnitSettings Get | Set
UnitSpecifiedTarget Get | Set
UnitSpecifiedTargetOccupiesMap Set
UnitSpecifiedTargetPathHeight Set
UnitSpecifiedTargetPathSourceOffset Set
UnitSpecifiedTargetShowPath Set
UnitSuppressMovement Get | Set
UnitType Get
UnitUIOptions Get | Set
UnitUIState Get | Set
UnitUIText Get | Set
UseLegalUnitCells
WallCharged Set

Unit Attributes

AddAsWareHolder
RemoveAsWareHolder
UnitAmmo Get | Set
UnitAnticreeperDamages Get | Set
UnitArmed Get | Set
UnitCanDestroy Get | Set
UnitCanStun 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
UnitStunCount Get
UnitSupplied Get | Set
UnitSuppressCount Get | Set
UnitTargetOffset Get | Set
UnitUpdateCount Get


Unit Objects

CreateTrail
DestroyTrail
ObjActive Get | Set
ObjColor Get | Set
ObjFacingAngle Get
ObjFacingAngleCell Get
ObjForward Get | Set
ObjLightConeVisible Set
ObjPosition Get | Set
ObjRotation Get | Set
ObjScale Get | Set
ObjText Set
ObjTextBillboard Set
ObjTextColor Set
ObjTextFontSize Set
RotateObj
RotateObjTowards
RotateObjTowardsCell

Beams

AttachBeam
BeamBrightness Set
BeamColor Set
BeamEnd Set
BeamForceLocalEnd Set
BeamStart Set
BeamVisible Set
BeamWidth Set
CreateBeam
DestroyAllAttachedBeams
DestroyAllBeams
DestroyBeam
IsBeam
UnattachBeam

IO

CameraMode Get
CameraPosition Get | Set
CameraRotation Get | Set
DefaultCameraPosition Get
Key Get
KeyDown Get
MapPanEnabled Set
MappedKey Get
MappedKeyDown Get
MapRotateEnabled Set
MapZoomEnabled Set
MouseButton Get
MouseButtonDown Get
MouseButtonUp Get
MouseScrollDelta Get
PointerTerrainCoords Get
ResetCamera
RPLCam Set
RPLCamCopyPosAndRot
RPLCamPosition Set
RPLCamRotation Set
RPLCamTween
RPLCamTweenLookAt

Theme

ApplyTheme
ThemeCliffLight Get | Set
ThemeCliffLightBoost Get | Set
ThemeCliffNormal Get | Set
ThemeCliffNormalAmt Get | Set
ThemeCliffNormalScale Get | Set
ThemeCliffScale Get | Set
ThemeCliffTexture Get | Set
ThemeNormal Get | Set
ThemeNormalAmt Get | Set
ThemeNormalScale Get | Set
ThemeTexture Get | Set
ThemeTextureDeTile Get | Set
ThemeTextureLight Get | Set
ThemeTextureLightBoost Get | Set
ThemeTextureScale Get | Set


Tables

CreateTable
GlobalTable Get | Set
RemoveTableElement
Table
TableElement Get | Set
TableElementRPN Set
TableKeys Get
TableN
TableValues Get

Data

IsNull
NULL
Type Get

Timers

Timer0 Get | Set
Timer1 Get | Set
Timer2 Get | Set
Timer3 Get | Set
TimerObeyPause0 Set
TimerObeyPause1 Set
TimerObeyPause2 Set
TimerObeyPause3 Set


Eggs/Orbs

CreateEgg
CreateOrb
EggOrbData Set

Terrain

BounceEdgeCollision
BounceTerrainCollision
ExactTerrain Get
ExactTerrainAndNormal Get
ExactTerrainWithShield Get
FloodFillTerrain
Terrain Get | Set
TerrainInRange Set
TerrainLine Set
TerrainLOS Get
TerrainOverride Get | Set
TerrainSpecial Get | Set
TerrainVector Get
VoidHeight Get | Set

Creeper

AddCreeper
AddCreeperInRange
AddCreeperWithCap
AddCreeperWithCapInRange
ClipCreeperLine
ConvertACToCreeper
ConvertCreeperToAC
Creeper Get | Set
CreeperCutoff Get | Set
CreeperInRange Set
Crimson Set
Crimson Get
DamageCreeper
ExactCreeperHeight Get
Flow Get | Set
IsCreeperCutoff
MaxACCell Get
MaxCreeperCell Get
MaxCreeperCellWithDamage Get
MinACCell Get
MinCreeperCell Get
MinCreeperCellWithDamage Get
TotalAC Get
TotalCreeper Get

Mission

AcquireMissionObjective
CustomObjectiveText Set
EndMission
MissionObjectiveEnabled Get | Set
MissionObjectiveRequired Get | Set
MissionObjectiveState Get

Decals

DecalVisible Get | Set
DecalColor Get | Set
DecalSize Get | Set
DecalPosition Get | Set

playground/playground.1611332423.txt.gz · Last modified: 2021/01/22 11:20 by Karsten75