API Reference


BlockStyle :BlockStyle

Enum of terrain block styles.
Type:
Properties:
Name Type Description
COLOR0 BlockStyle Palette color 0. White.
COLOR1 BlockStyle Palette color 1. Gray.
COLOR2 BlockStyle Palette color 2. Really, really bright red. Oh, my eyes, my eyes!
COLOR3 BlockStyle Palette color 3. Bright yellow.
COLOR4 BlockStyle Palette color 4. Bright green.
COLOR5 BlockStyle Palette color 5. Bright cyan.
COLOR6 BlockStyle Palette color 6. Bright blue.
COLOR7 BlockStyle Palette color 7. Bright pink.
COLOR8 BlockStyle Palette color 8. Light blue, the color of the ocean in games, which is no where near the color of the ocean in real life.
COLOR9 BlockStyle Palette color 9. Light yellow (more like sand).
COLOR10 BlockStyle Palette color 10. Light orange (salmon).
COLOR11 BlockStyle Palette color 11. Red. Bright, but not as bright as color 2.
COLOR12 BlockStyle Palette color 12. Burgundy (dark red).
COLOR13 BlockStyle Palette color 13. Teal.
COLOR14 BlockStyle Palette color 14. Blue-green. Or is it green-blue?
COLOR15 BlockStyle Palette color 15. Light pink. Maybe mauve? I have terrible color vocabulary.
STONE BlockStyle Stone block style.
SCIFI BlockStyle Sci-fi (space) style.
GRASS BlockStyle Grass style.
SNOW_ROCK BlockStyle Snow/rock.
DIRT BlockStyle Dirt.
GRASS_STONE BlockStyle Grass/stone.
GREY_CRATERS BlockStyle Grey craters.
ICE BlockStyle Ice.
LAVA BlockStyle Lava.
SAND BlockStyle Sand.
WATER BlockStyle Water.
WOODEN BlockStyle Wooden.
RED_CRATERS BlockStyle Red craters.
INDUSTRIAL_GREEN BlockStyle Industrial green.
INDUSTRIAL_RED BlockStyle Industrial red.
GREY_BRICKS BlockStyle Grey bricks.
METAL_BEIGE BlockStyle Metal beige.
RED_BRICKS BlockStyle Red bricks.
ROAD BlockStyle Road.
ROAD_CROSSING BlockStyle Road with pedestrian crossing.
ROAD_WHITE_BROKEN_LINE BlockStyle Road with white broken line.
ROAD_YELLOW_UNBROKEN_LINE BlockStyle Road with yellow continuous line.
PAVEMENT BlockStyle Pavement (sidewalk).
PAVEMENT_CONCAVE_CORNER BlockStyle Pavement (sidewalk), concave corner.
PAVEMENT_CONVEX_CORNER BlockStyle Pavement (sidewalk), convex corner.

BlockStyle

Properties:
Name Type Description
COLOR0 number
COLOR1 number
COLOR2 number
COLOR3 number
COLOR4 number
COLOR5 number
COLOR6 number
COLOR7 number
COLOR8 number
COLOR9 number
COLOR10 number
COLOR11 number
COLOR12 number
COLOR13 number
COLOR14 number
COLOR15 number
STONE number
SCIFI number
GRASS number
SNOW_ROCK number
DIRT number
GRASS_STONE number
GREY_CRATERS number
ICE number
LAVA number
SAND number
WATER number
WOODEN number
RED_CRATERS number
INDUSTRIAL_GREEN number
INDUSTRIAL_RED number
GREY_BRICKS number
METAL_BEIGE number
RED_BRICKS number
ROAD number
ROAD_CROSSING number
ROAD_WHITE_BROKEN_LINE number
ROAD_YELLOW_UNBROKEN_LINE number
PAVEMENT number
PAVEMENT_CONCAVE_CORNER number
PAVEMENT_CONVEX_CORNER number

< All Functions
Transform
Position Get
getPosXgetPosYgetPosZgetPosgetDistanceTogetDistanceBetweengetLocalPosgetSpawnPosselfToWorldPosworldToSelfPosselfToWorldDirworldToSelfDir
Position Set
moveForwardmoveBackwardmoveLeftmoveRightmoveUpmoveDownmovemoveGlobalmoveTowardsetPosXsetPosYsetPosZsetPosXYZsetPossetSpawnPossetLocalPos
Rotation Get
getPointAheadgetPointBehindgetPointAbovegetPointBelowgetPointToRightOfgetPointToLeftOfgetYawgetPitchgetRollgetRotgetLocalRotgetSpawnRotgetForwardgetBackwardgetUpgetDowngetRightgetLeft
Rotation Set
setYawsetPitchsetRollsetYawPitchRollturnspinrotateapplyQuaternionapplyQuaternionSelfsetRotresetRotsetSpawnRotresetSpawnRotsetLocalRotresetLocalRotlookAtlookDirlookTowardlookTowardDir
Scale
getScaleUniformsetScaleUniformgetScalesetScalegrowshrink
Actors
Actors
ActorRefActorRefmyselfdestroySelfexistsgetActorsgetPlayerActorsgetActorsWithTaggetActorWithTaghasTaggetGameRulesActorisOnstageisOffstagegoOffstagegoOnstageisActorInGroupgetActorsInGroupgetActorGroupDescriptiongetClosestActorgetCardTargetActorgetCardTargetActorDescription
Attributes
getDisplayNamesetDisplayNamegetCommentTextsetCommentTextsetVardeleteVargetVargetAllVars
Cloning
getCloneParentisCloneclone
Properties
propspropNumberpropDecimalpropBooleanpropStringpropActorpropActorGrouppropImagepropSoundpropParticleEffectpropDeckpropColorpropEnumpropCardTargetActorpropNumberArraypropStringArraypropEnumArraypropActorArrayrequireTruerequireFalserequireEqualrequireNotEqualPropOptionsPropDeckOptionsPropDefRequirement
Memory
memcardtempdeclareMemoryUnchangedsaveRotloadRotsaveVecloadVec
Messages
cooldownsendsendDelayedsendToManysendToManyDelayedsendToSelfsendToSelfDelayedsendToAllbroadcastsendToAllDelayedgetMessageSendercallDeckcallActionDeckcallEventDeckdeactivateActionDeck
Player
Camera/Lights
CameraSettingssetCameraSettingssetLightclearLightrequestCameraOffsetgetLocalCameraPosgetLocalCameraRotgetLocalCameraForward
Hierarchy
Parenting
attachToParentdetachFromParentisAttachedgetParent
Rendering
Visibility
isVisibleshowhide
Body
getBodyPossetBodyPosgetBodyRotsetBodyRotgetBoundsSizegetBoundsRadiusOutergetBoundsRadiusInnergetBoundsRadiusAveragegetBoundsCenter
Color
setTintsetTintColorsetTintHexgetTintgetTintColorgetTintHex
Scene
SkyTypeSceneLightingModesetSkyTypegetSkyTypesetSkyColorgetSkyColorsetSceneLightinggetSceneLighting
Physics
Presets
PhysicsPresetsetPhysicsPresetgetPhysicsPreset
Attributes
setSolidisSolidsetKinematicisKinematicenableGravityisGravityEnabledenableKeepUprightisKeepUprightEnabledsetBouncinesssetMasssetDragsetAngularDrag
Velocity
getVelocityaddVelocityaddTorquepush
Casting
raycastraycastTerraincastAdvancedCastHitoverlapSpherecheckBoxCastMode
Collisions
onCollisiononTerrainCollision
Player Controls (high level input)
Actions
onJumponPrimaryActiononSecondaryAction
Controls
isGroundedisSprintinggetWorldThrottlegetThrottlegetRawThrottlegetLookAxessetCameraActorgetCameraActorresetCameraActorisPlayerControllablesetIsPlayerControllablesetControllingPlayergetControllingPlayer
Aiming
getAimTargetgetAimOrigingetAimDirectiongetLastAimHitPoint
Low Level Input
Keyboard
keyIsPressedkeyJustPressedkeyJustReleasedonKeyDownonKeyHeldonKeyUpKeyMessageKeyCode
Mouse
hasPlayerInputgetMouseXgetMouseYmouseIsPressedmousePressedmouseJustPressedmouseJustReleasedgetMouseRayOrigingetMouseRayDirgetMouseWheelgetActorUnderMousegetActorsUnderMousegetTerrainPointUnderMouseonMouseDownonMouseUponMouseHeldonActorClicked
Multiplayer
Players
isInMultiplayerModegetAllPlayersgetLocalPlayergetPlayerByNumbergetPlayerNickNamegetPlayerNumberplayerExistsisMasterPlayerisClaimedgetPlayerControlledActor
Events
onPlayerJoinedonPlayerLeftPlayerJoinedMessagePlayerLeftMessage
User Interface
Tooltips
Widgets
uiTextuiRectuiCircleuiTriangleuiLineuiButtonuiSpriteuiImageuiImageSliceuiGetTextWidthuiGetTextHeightuiGetScreenWidthuiGetScreenHeightuiGetScreenInfoUiColorShapeStyleRectStyleUiShapeOptionsUiImageOptionsUiButtonOptionsUiTextOptionsUiScreenInfo
Screen
getScreenPointgetScreenSpheregetScreenRect
Terrain
Blocks
BlockShapeBlockDirBlockStylesetBlocksetBlockAtPointgetBlockgetBlockAtPointclearBlockclearBlockAtPointgetBlockCoordsAtPointgetBlockCentergetBlockSize
Walls
Sound
SFX
playSoundtryPlaySoundSounds
Particle Effects
ParticleEffects
spawnParticleEffecttrySpawnParticleEffectParticles
Polite Requests
Requests
setPosPleasesetYawPleasesetPitchPleasesetRollPleasesetYawPitchRollPleaseturnPleaseapplyQuaternionPleaseapplyQuaternionSelfPleasesetRotPleaseresetRotPleaselookAtPleaselookDirPleasesetScaleUniformPleasesetScalePleaseattachToParentPleasedetachFromParentPleasesetVarPleasedeleteVarPleasesetDisplayNamePleasesetCommentTextPleasesetSolidPleasesetKinematicPleaseenableGravityPleaseenableKeepUprightPleasesetBouncinessPleasesetMassPleasesetDragPleasesetAngularDragPleasesetPhysicsPresetPleaseaddVelocityPleasesetCameraActorPleasesetIsPlayerControllablePleasesetControllingPlayerPleasesetBodyPosPleasesetBodyRotPleasesetTintColorPleasesetTintHexPleaseshowPleasehidePleasedestroySelfPlease
Misc
Time
deltaTimegetTimegetTimeSinceResetonTickonLocalTickonOffstageTick
Math
vec3degToRadradToDegrevToRadinterpvec3zerovec3onevec3xvec3yvec3zvec3addvec3addXvec3addYvec3addZvec3withXvec3withYvec3withZvec3subvec3scalevec3addScaledvec3negvec3lengthSqvec3lengthvec3normalizedvec3withLengthvec3toStringvec3equalvec3dotquatIdentquatAxisAnglequatApply
Colors
colorFromHexcolorToHex
Game
onResetGameonInitonSpawnAsCloneresetGame
Util
toFixedLengthdeepCopyloglogError
(Advanced) Cards
Cards
getCardStatusRuntimeCardStatusgetCardErrorMessageonCardRemoved
Reference
GActionCardGActionMessageGEventGEventCard