Starbound Documentation
latest
  • actor mcontroller
  • animator
  • config
  • entity
  • item
  • mcontroller
  • 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
  • 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)
  • 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()
Starbound Documentation
  • Docs »
  • Search

© Copyright Starbound. Revision b09999e9.

Built with Sphinx using a theme provided by Read the Docs.