About

This is the unofficial documentation consisting of the official documentation on a readthedocs page, because it’s easier to view and search.

What is starbound

Starbound is a space exploration game on a 2D side scrolling plane. It can be played single player or multiplayer and can be modified in many ways.

Documentation

Contents:

• actor mcontroller
  • RectF mcontroller.boundBox()
  • PolyF mcontroller.collisionPoly()
  • PolyF mcontroller.collisionBody()
  • Vec2F mcontroller.position()
  • float mcontroller.xPosition()
  • float mcontroller.yPosition()
  • Vec2F mcontroller.velocity()
  • float mcontroller.xVelocity()
  • float mcontroller.yVelocity()
  • float mcontroller.rotation()
  • bool mcontroller.isColliding()
  • bool mcontroller.isNullColliding()
  • bool mcontroller.isCollisionStuck()
  • float mcontroller.stickingDirection()
  • float mcontroller.liquidPercentage()
  • LiquidId mcontroller.liquidId()
  • bool mcontroller.onGround()
    • void mcontroller.setAnchorState(EntityId anchorableEntity, size_t anchorPosition)
    • void mcontroller.resetAnchorState()
    • EntityId, int mcontroller.anchorState()
  • void mcontroller.setPosition(Vec2F position)
  • void mcontroller.setXPosition(float x)
  • void mcontroller.setYPosition(float y)
  • void mcontroller.translate(Vec2F direction)
  • void mcontroller.setVelocity(Vec2F velocity)
  • void mcontroller.setXVelocity(Vec2F xVelocity)
  • void mcontroller.setYVelocity(Vec2F yVelocity)
  • void mcontroller.addMomentum(Vec2F momentum)
  • void mcontroller.setRotation(float angle)
    • ActorMovementParameters mcontroller.baseParameters()
    • bool mcontroller.walking()
    • bool mcontroller.running()
    • int mcontroller.movingDirection()
    • int mcontroller.facingDirection()
    • bool mcontroller.crouching()
    • bool mcontroller.flying()
    • bool mcontroller.falling()
    • bool mcontroller.canJump()
    • bool mcontroller.groundMovement()
    • bool mcontroller.liquidMovement()
    • void mcontroller.controlRotation(float rotation)
    • void mcontroller.controlAcceleration(Vec2F acceleration)
    • void mcontroller.controlForce()
    • void mcontroller.controlApproachVelocity(Vec2F targetVelocity, float maxControlForce)
  • void mcontroller.controlApproachVelocityAlongAngle(float angle, float targetVelocity, float maxControlForce, bool positiveOnly = false)
  • void mcontroller.controlApproachXVelocity(float targetVelocity, float maxControlForce)
  • void mcontroller.controlApproachYVelocity(float targetVelocity, float maxControlForce)
    • void mcontroller.controlParameters(ActorMovementParameters parameters)
    • void mcontroller.controlModifiers(ActorMovementModifiers modifiers)
    • void mcontroller.controlMove(float direction, bool run)
    • void mcontroller.controlFace(float direction)
    • void mcontroller.controlDown()
    • void mcontroller.controlCrouch()
    • void mcontroller.controlJump()
    • void mcontroller.controlHoldJump()
    • void mcontroller.controlFly(Vec2F velocity)
    • bool mcontroller.autoClearControls()
    • void mcontroller.setAutoClearControls(bool enabled)
    • void mcontroller.clearControls()
• animator
  • bool animator.setAnimationState(String stateType, String State, bool startNew = false)
  • String animator.animationState(String stateType)
  • Json animator.animationStateProperty(String stateType, String propertyName)
  • void animator.setGlobalTag(String tagName, String tagValue)
  • void animator.setPartTag(String partType, String tagName, String tagValue)
  • void animator.setAnimationRate(float rate)
  • void animator.rotateGroup(String rotationGroup, float targetAngle, bool immediate)
  • float animator.currentRotationAngle(String rotationGroup)
  • bool animator.hasTransformationGroup(String transformationGroup)
  • void animator.translateTransformationGroup(String transformationGroup, Vec2F translate)
  • void animator.rotateTransformationGroup(String transformationGroup, float rotation)
  • void animator.scaleTransformationGroup(String transformationGroup, float scale, [Vec2F scaleCenter])
  • void animator.transformTransformationGroup(String transformationGroup, float a, float b, float c, float d, float tx, float ty)
  • void animator.resetTransformationGroup(String transformationGroup)
  • void animator.setParticleEmitterActive(String emitterName, bool active)
  • void animator.setParticleEmitterEmissionRate(String emitterName, float emissionRate)
  • void animator.setParticleEmitterBurstCount(String emitterName, unsigned burstCount)
  • void animator.setParticleEmitterOffsetRegion(String emitterName, RectF offsetRegion)
  • void animator.burstParticleEmitter(String emitterName)
  • void animator.setLightActive(String lightName, bool active)
  • void animator.setLightPosition(String lightName, Vec2F position)
  • void animator.setLightColor(String lightName, Color color)
  • void animator.setLightPointAngle(String lightName, float angle)
  • bool animator.hasSound(String soundName)
  • void animator.setSoundPool(String soundName, List<String> soundPool)
  • void animator.setSoundPosition(String soundName, Vec2F position)
  • void animator.playSound(String soundName, [int loops = 0])
  • void animator.setSoundVolume(String soundName, float volume, [float rampTime = 0.0])
  • void animator.setSoundPitch(String soundName, float pitch, [float rampTime = 0.0])
  • void animator.stopAllSounds(String soundName)
  • void animator.setEffectActive(String effect, bool enabled)
  • Vec2F animator.partPoly(String partName, String propertyName)
  • PolyF animator.partPoly(String partName, String propertyName)
• config
  • Json config.getParameter(String parameter, Json default)
• entity
  • EntityId entity.id()
    • LuaTable entity.damageTeam()
    • bool entity.isValidTarget(EntityId entityId)
    • Vec2F entity.distanceToEntity(EntityId entityId)
    • bool entity.entityInSight(EntityId entityId)
    • Vec2F entity.position()
    • String entity.entityType()
    • String entity.uniqueId()
• item
  • String item.name()
  • size_t item.count()
  • size_t item.setCount(size_t count)
  • size_t item.maxStack()
  • bool item.is(ItemDescriptor desc)
  • bool item.matches(ItemDescriptor desc)
  • Json item.matchingDescriptors()
  • bool item.consume(size_t count)
  • bool item.empty()
  • ItemDescriptor item.descriptor()
  • String item.description()
  • String item.friendlyName()
  • int item.rarity()
  • String item.rarityString()
  • size_t item.price()
  • unsigned item.fuelAmount()
  • Json item.iconDrawables()
  • Json item.dropDrawables()
  • String item.largeImage()
  • String item.tooltipKind()
  • String item.category()
  • String item.pickupSound()
  • bool item.twoHanded()
  • float item.timeToLive()
  • Json item.learnBlueprintsOnPickup()
  • bool item.hasItemTag(String itemTag)
  • Json item.pickupQuestTemplates()
• mcontroller
  • MovementParameters mcontroller.parameters()
  • void mcontroller.applyParameters(Json parameters)
  • void mcontroller.resetParameters()
  • Vec2F mcontroller.position()
  • float mcontroller.xPosition()
  • float mcontroller.yPosition()
  • Vec2F mcontroller.velocity()
  • float mcontroller.xVelocity()
  • float mcontroller.yVelocity()
  • float mcontroller.rotation()
  • PolyF mcontroller.collisionBody()
  • RectF mcontroller.collisionBoundBox()
  • RectF mcontroller.localBoundBox()
  • bool mcontroller.isColliding()
  • bool mcontroller.isNullColliding()
  • bool mcontroller.isCollisionStuck()
  • float mcontroller.stickingDirection()
  • float mcontroller.liquidPercentage()
  • LiquidId mcontroller.liquidId()
  • bool mcontroller.onGround()
  • void mcontroller.setPosition(Vec2F position)
  • void mcontroller.setXPosition(float x)
  • void mcontroller.setYPosition(float y)
  • void mcontroller.translate(Vec2F direction)
  • void mcontroller.setVelocity(Vec2F velocity)
  • void mcontroller.setXVelocity(Vec2F xVelocity)
  • void mcontroller.setYVelocity(Vec2F yVelocity)
  • void mcontroller.addMomentum(Vec2F momentum)
  • void mcontroller.setRotation(float angle)
  • void mcontroller.rotate(float angle)
  • void mcontroller.accelerate(Vec2F acceleration)
  • void mcontroller.force(Vec2F force)
  • void mcontroller.approachVelocity(Vec2F targetVelocity, float maxControlForce)
  • void mcontroller.approachVelocityAlongAngle(float angle, float targetVelocity, float maxControlForce, bool positiveOnly = false)
  • void mcontroller.approachXVelocity(float targetVelocity, float maxControlForce)
  • void mcontroller.approachYVelocity(float targetVelocity, float maxControlForce)
• Json root.assetJson(String assetPath)
• Json root.makeCurrentVersionedJson(String versioningIdentifier, Json content)
• Json root.loadVersionedJson(Json versionedContent, String versioningIdentifier)
• double root.evalFunction(String functionName, double input)
• double root.evalFunction2(String functionName, double input1, double input2)
• Vec2U root.imageSize(String imagePath)
• List<Vec2I> root.imageSpaces(String imagePath, Vec2F worldPosition, float spaceScan, bool flip)
• RectU root.nonEmptyRegion(String imagePath)
• Json root.npcConfig(String npcType)
• float root.projectileGravityMultiplier(String projectileName)
• Json root.projectileConfig(String projectileName)
• JsonArray root.recipesForItem(String itemName)
• String root.itemType(String itemName)
• JsonArray root.itemTags(String itemName)
• bool root.itemHasTag(String itemName, String tagName)
• Json root.itemConfig(ItemDescriptor descriptor, [float level], [unsigned seed])
• ItemDescriptor root.createItem(ItemDescriptor descriptor, [float level], [unsigned seed])
• Json root.tenantConfig(String tenantName)
• JsonArray root.getMatchingTenants(map<String, unsigned> colonyTags)
• JsonArray root.liquidStatusEffects(LiquidId liquid)
• table root.behaviorModule(String moduleName)
• String root.generateName(String assetPath, [unsigned seed])
• Json root.questConfig(String questTemplateId)
• JsonArray root.npcPortrait(String portraitMode, String species, String npcType, float level, [unsigned seed], [Json parameters])
• JsonArray root.monsterPortrait(String typeName, [Json parameters])
• bool root.isTreasurePool(String poolName)
• JsonArray root.createTreasure(String poolName, float level, [unsigned seed])
• String root.materialMiningSound(String materialName, [String modName])
• String root.materialFootstepSound(String materialName, [String modName])
• status
  • Json status.statusProperty(String name, Json default)
  • void status.setStatusProperty(String name, Json value)
  • float status.stat(String statName)
  • bool status.statPositive(String statName)
  • List<String> status.resourceNames()
  • bool status.isResource(String resourceName)
  • float status.resource(String resourceName)
  • bool status.resourcePositive(String resourceName)
  • void status.setResource(String resourceName, float value)
  • void status.modifyResource(String resourceName, float value)
  • float status.giveResource(String resourceName, float value)
  • bool status.consumeResource(String resourceName, float amount)
  • bool status.overConsumeResource(String resourceName, float amount)
  • bool status.resourceLocked(String resourceName)
  • void status.setResourceLocked(String resourceName, bool locked)
  • void status.resetResource(String resourceName)
  • void status.resetAllResources()
  • float status.resourceMax(String resourceName)
  • float status.resourcePercentage(String resourceName)
  • void status.setResourcePercentage(String resourceName, float value)
  • void status.modifyResourcePercentage(String resourceName, float value)
  • JsonArray status.getPersistentEffects(String effectCategory)
  • void status.addPersistentEffect(String effectCategory, Json effect)
  • void status.addPersistentEffects(String effectCategory, JsonArray effects)
  • void status.setPersistentEffects(String effectCategory, JsonArray effects)
  • void status.clearPersistentEffects(String effectCategory)
  • void status.clearAllPersistentEffects()
  • void status.addEphemeralEffect(String effectName, [float duration], [EntityId sourceEntity])
  • void status.addEphemeralEffects(JsonArray effects, [EntityId sourceEntity])
  • void status.removeEphemeralEffect(String effectName)
  • void status.clearEphemeralEffects()
  • List<pair<DamageNotification>>, uint64_t status.damageTakenSince([uint64_t since = 0]])
  • List<pair<EntityId,DamageRequest>>, uint64_t status.inflictedHitsSince([uint64_t since = 0]])
  • List<DamageNotification>, uint65_t status.functionName([uint64_t since = 0])
• float world.magnitude(Vec2F position1, Vec2F position2)
• Vec2F world.distance(Vec2F position1, Vec2F position2)
• bool world.polyContains(PolyF poly, Vec2F position)
• Vec2F world.xwrap(Vec2F position)
• float world.xwrap(float xPosition)
• Variant<Vec2F, float> world.nearestTo(Variant<Vec2F, float> sourcePosition, Variant<Vec2F, float> targetPosition)
• bool world.pointCollision(Vec2F point, [CollisionSet collisionKinds])
• bool world.pointTileCollision(Vec2F point, [CollisionSet collisionKinds])
• bool world.lineCollision(Vec2F startPoint, Vec2F endPoint, [CollisionSet collisionKinds])
• bool world.lineTileCollision(Vec2F startPoint, Vec2F endPoint, [CollisionSet collisionKinds])
• bool world.rectCollision(RectF rect, [CollisionSet collisionKinds])
• bool world.rectTileCollision(RectF rect, [CollisionSet collisionKinds])
• bool world.polyCollision(PolyF poly, [Vec2F position], [CollisionSet collisionKinds])
• List<Vec2I> world.collisionBlocksAlongLine(Vec2F startPoint, Vec2F endPoint, [CollisionSet collisionKinds], [int maxReturnCount])
• List<pair<Vec2I, LiquidLevel>> world.liquidAlongLine(Vec2F startPoint, Vec2F endPoint)
• Vec2F world.resolvePolyCollision(PolyF poly, Vec2F position, float maximumCorrection, [CollisionSet collisionKinds])
• bool world.tileIsOccupied(Vec2I tilePosition, [bool foregroundLayer], [bool includeEphemeral])
• bool world.placeObject(String objectName, Vec2I tilePosition, [int direction], [Json parameters])
• EntityId world.spawnItem(ItemDescriptor item, Vec2F position, [unsigned count], [Json parameters])
• List<EntityId> world.spawnTreasure(Vec2F position, String poolName, float level, [unsigned seed])
• EntityId world.spawnMonster(String monsterType, Vec2F position, [Json parameters])
• EntityId world.spawnNpc(Vec2F position, String npcType, String species, float level, [unsigned seed], [Json parameters])
• EntityId world.spawnStagehand(Vec2F position, String type, [Json overrides])
• EntityId world.spawnProjectile(String projectileName, Vec2F position, [EntityId sourceEntityId], [Vec2F direction], [bool trackSourceEntity], [Json parameters])
• EntityId world.spawnVehicle(String vehicleName, Vec2F position, [Json overrides])
• double world.time()
• unsigned world.day()
• double world.timeOfDay()
• float world.dayLength()
• Json world.getProperty(String propertyName, [Json defaultValue])
• void world.setProperty(String propertyName, Json value)
• LiquidLevel world.liquidAt(Vec2I position)
• LiquidLevel world.liquidAt(RectF region)
• float world.gravity(Vec2F position)
• bool world.spawnLiquid(Vec2F position, LiquidId liquid, float quantity)
• LiquidLevel world.destroyLiquid(Vec2F position)
• bool world.isTileProtected(Vec2F position)
• PlatformerAStar::Path world.findPlatformerPath(Vec2F startPosition, Vec2F endPosition, ActorMovementParameters movementParameters, PlatformerAStar::Parameters searchParameters)
• PlatformerAStar::PathFinder world.platformerPathStart(Vec2F startPosition, Vec2F endPosition, ActorMovementParameters movementParameters, PlatformerAStar::Parameters searchParameters)
  • bool explore([int nodeLimit])
  • PlatformerAStar::Path result()
• float world.lightLevel(Vec2F position)
• float world.windLevel(Vec2F position)
• bool world.breathable(Vec2F position)
• bool world.underground(Vec2F position)
• Variant<String, bool> world.material(Vec2F position, String layerName)
• String world.mod(Vec2F position, String layerName)
• bool world.damageTiles(List<Vec2I> positions, String layerName, Vec2F sourcePosition, String damageType, float damageAmount, [unsigned harvestLevel])
• bool world.damageTileArea(Vec2F center, float radius, String layerName, Vec2F sourcePosition, String damageType, float damageAmount, [unsigned harvestLevel)
• bool world.placeMaterial(Vec2I position, String layerName, String materialName, [int hueShift], [bool allowOverlap])
• bool world.placeMod(Vec2I position, String layerName, String modName, [int hueShift], [bool allowOverlap])
• List<EntityId> world.entityQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.monsterQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.npcQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.objectQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.itemDropQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.playerQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.loungeableQuery(Vec2F position, Variant<Vec2F, float positionOrRadius, [Json options])
• List<EntityId> world.entityLineQuery(Vec2F startPosition, Vec2F endPosition, [Json options])
• List<EntityId> world.objectLineQuery(Vec2F startPosition, Vec2F endPosition, [Json options])
• List<EntityId> world.npcLineQuery(Vec2F startPosition, Vec2F endPosition, [Json options])
• bool world.entityExists(EntityId entityId)
• DamageTeam world.entityDamageTeam(EntityId entityId)
• bool world.entityCanDamage(EntityId sourceId, EntityId targetId)
• bool world.entityAggressive(EntityId entity)
• String world.entityType(EntityId entityId)
• Vec2F world.entityPosition(EntityId entityId)
• Vec2F world.entityVelocity(EntityId entityId)
• unsigned world.entityMoney(EntityId entityId)
• unsigned world.entityHasCountOfItem(EntityId entityId, String itemName)
• Vec2F world.entityHealth(EntityId entityId)
• String world.entitySpecies(EntityId entityId)
• String world.entityGender(EntityId entityId)
• String world.entityName(EntityId entityId)
• String world.entityDescription(EntityId entityId, [String species])
• JsonArray world.entityPortrait(EntityId entityId, String portraitMode)
• String world.entityHandItem(EntityId entityId, String handName)
• ItemDescriptor world.entityHandItemDescriptor(EntityId entityId, String handName)
• String world.entityUniqueId(EntityId entityId)
• Json world.getObjectParameter(EntityId entityId, String parameterName, [Json defaultValue])
• List<Vec2I> world.objectSpaces(EntityId entityId)
• int world.farmableStage(EntityId entityId)
• int world.containerSize(EntityId entityId)
• bool world.containerClose(EntityId entityId)
• bool world.containerOpen(EntityId entityId)
• JsonArray world.containerItems(EntityId entityId)
• ItemDescriptor world.containerItemAt(EntityId entityId, unsigned offset)
• bool world.containerConsume(EntityId entityId, ItemDescriptor item)
• bool world.containerConsumeAt(EntityId entityId, unsigned offset, unsigned count)
• unsigned world.containerAvailable(EntityId entityId, ItemDescriptor item)
• JsonArray world.containerTakeAll(EntityId entityId)
• ItemDescriptor world.containerTakeAt(EntityId entityId, unsigned offset)
• ItemDescriptor world.containerTakeNumItemsAt(EntityId entityId, unsigned offset, unsigned count)
• unsigned world.containerItemsCanFit(EntityId entityId, ItemDescriptor item)
• Json world.containerItemsFitWhere(EntityId entityId, ItemDescriptor items)
• ItemDescriptor world.containerAddItems(EntityId entityId, ItemDescriptor items)
• ItemDescriptor world.containerStackItems(EntityId entityId, ItemDescriptor items)
• ItemDescriptor world.containerPutItemsAt(EntityId entityId, ItemDescriptor items, unsigned offset)
• ItemDescriptor world.containerItemApply(EntityId entityId, ItemDescriptor items, unsigned offset)
• ItemDescriptor world.containerSwapItemsNoCombine(EntityId entityId, ItemDescriptor items, unsigned offset)
• ItemDescriptor world.containerSwapItems(EntityId entityId, ItemDescriptor items, unsigned offset)
• LuaValue world.callScriptedEntity(EntityId entityId, String functionName, [LuaValue args ...])
• RpcPromise<Json> world.sendEntityMessage(Variant<EntityId, String> entityId, String messageType, [LuaValue args ...])
• RpcPromise<Vec2F> world.findUniqueEntity(String` uniqueId)
• bool world.loungeableOccupied(EntityId entityId)
• bool world.isMonster(EntityId entityId, [bool aggressive])
• String world.monsterType(EntityId entityId)
• bool world.isNpc(EntityId entityId, [int damageTeam])
• String world.npcType(EntityId entityId)
• String world.stagehandType(EntityId entityId)
• void world.debugPoint(Vec2F position, Color color)
• void world.debugLine(Vec2F startPosition, Vec2F endPosition, Color color)
• void world.debugPoly(PolyF poly, Color color)
• void world.debugText(String formatString, [LuaValue formatValues ...], Vec2F position, Color color)
• bool world.breakObject(EntityId entityId, bool smash)
• bool world.isVisibleToPlayer(RectF region)
• bool world.loadRegion(RectF region)
• bool world.regionActive(RectF region)
• void world.setTileProtection(DungeonId dungeonId, bool protected)
• DungeonId world.dungeonId(Vec2F position)
• bool world.isPlayerModified(RectI region)
• LiquidLevel world.forceDestroyLiquid(Vec2F position)
• EntityId world.loadUniqueEntity(String uniqueId)
• void world.setUniqueId(EntityId entityId, [String uniqueId])
• ItemDescriptor world.takeItemDrop(EntityId targetEntityId, [EntityId sourceEntityId])
• void world.setPlayerStart(Vec2F position, [bool respawnInWorld])
• List<EntityId> world.players()