Difference between revisions of "Lua Command Line"

From Sapiens Wiki
Jump to navigation Jump to search
 
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Stub Notice}}
[[File:Lua.png|220px|thumb|right|The Lua Command Line]]
[[File:Lua.png|220px|thumb|right|The Lua Command Line]]


==Overview==
=Overview=


The '''Lua Command Line''' is a command line tool that allows direct interaction with the Sapiens game engine.  It can be accessed by entering the game chat using '''Ctrl+C''' and then typing "/lua".  Once the command line has started, Lua commands can be executed directly allowing the player to modify various game behaviors.  The Lua Command Line can be exited by typing '''/exit'''.
The '''Lua Command Line''' is an in-game command line tool that allows direct interaction with the Sapiens Lua game engine.  It can be accessed by pressing '`'.  Once the command line has started (the prompt should turn to "lua>"), Lua commands can be executed directly allowing the player to modify various game behaviors.  The Lua Command Line can be exited by typing '''/exit'''.


==Commands==
==Commands==


===spawn===
{| class="wikitable"
|-
! Command
! Description
|-
| completeCheat()
| Enables instant build mode.
|-
| setDebugObject()
| There is an option in the game menu that turns on debug mode. With that enabled, new buttons appear in the UI when you select any object in the world. If you click the debug button for that object, it logs all of the details about that object to every log, and is now set to be the target object for objectLog. These mj:objectLogs are scattered throughout the code base, in particular around the sapiens AI, so this is useful for tracking exactly what one particular sapien is doing.  This command allows you to set a debug object from the lua command line.
|-
| setSunrise()
| Advances the game time of day to sunrise.
|-
| setSunset()
| Advances the game time of day to sunset.
|-
| printType()
| Allows you to find the typeIndex or typeKey for an object.
Example:<br>
<code>
<strong>lua></strong>printType("gameObject.wheat")<br>
typeKey:gameObject.wheat = 338<br>
<strong>lua></strong>printType(338)<br>
typeIndex:338 = gameObject.wheat<br>
<strong>lua></strong>spawn(338)<br>
</code>
|-
| spawn([[#Spawnable Game Objects|object]], count)
| Spawn an item in the game.
 
To spawn an item in the game type:
To spawn an item in the game type:


<code>spawn("apple",1)</code>
<code>spawn("apple",1)</code>


Please note if the quantity is omitted, 1 will default.
Please note if the quantity is omitted, 1 will default. In other words...
 
<code>spawn("apple",1)</code>
 
and
 
<code>spawn("apple")</code>
 
...produce the same result. [[Lua Command Line#Spawnable Game Objects|List of Spawnable Game Objects]]
|-
| tp()
| Teleport to a location.
|}
 
== Spawnable Game Objects==
 
The following is a list of the spawnable game objects that can be used in conjunction with the "spawn()" command:
 
{| class="wikitable"
|-
! 1 || 2 || 3 || 4
|-
| aloeLeaf || aloeLeafRotten || alpacaMeat || alpacaMeatCooked
|-
| apple || appleRotten || aspenBigSeed || aspenBigSeedRotten
|-
| aspenSeed || aspenSeedRotten || balafon || bambooSeed
|-
| bambooSeedRotten || banana || bananaRotten || beetroot
|-
| beetrootCooked || beetrootRotten || beetrootSeed || beetrootSeedRotten
|-
| birchSeed || birchSeedRotten || bone || boneFlute
|-
| bone_hatchet || boneKnife || boneSpear || boneSpearHead
|-
| branch || branchRotten || breadDough || breadDoughRotten
|-
| burntBranch || chickenMeat || chickenMeatCooked || clay
|-
| coconut || coconutRotten || deadAlpaca || deadChicken
|-
| deadChickenRotten || dirt || echinaceaFlower || echinaceaFlowerRotten
|-
| elderberry || elderberryRotten || firedBowl || firedBowlBurnMedicine
|-
| firedBowlFoodPoisoningMedicine || firedBowlInjuryMedicine || firedBowlMedicineRotten || firedBowlVirusMedicine
|-
| firedBrick || firedTile || firedUrn || firedUrnFlour
|-
| firedUrnFlourRotten || firedUrnHulledWheat || firedUrnHulledWheatRotten || flax
|-
| flaxDried || flaxRotten || flaxSeed || flaxSeedRotten
|-
| flaxTwine || flint || flintAxeHead || flintHatchet
|-
| flintKnife || flintPickaxe || flintPickaxeHead || flintSpear
|-
| flintSpearHead || flatbread || flatbreadRotten || garlic
|-
| garlicRotten || giant_bone || gingerRoot || gingerRootRotten
|-
| gooseberry || gooseberryRotten || grass || hay
|-
| hayRotten || log || logDrum || mammothMeat
|-
| mammothMeatCooked || marigoldFlower || marigoldFlowerRotten || mudBrickDry
|-
| mudBrickWet || mudTileDry || mudTileWet || orange
|-
| orangeRotten || peach || peachRotten || pineCone
|-
| pineConeBig || pineConeBigRotten || pineConeRotten || poppyFlower
|-
| poppyFlowerRotten || pumpkin || pumpkinCooked || pumpkinRotten
|-
| quernstone || raspberry || raspberryRotten || rock
|-
| rockSmall || sand || splitLog || stoneAxeHead
|-
| stoneHatchet || stoneKnife || stonePickaxe || stonePickaxeHead
|-
| stoneSpear || stoneSpearHead || sunflowerSeed || sunflowerSeedRotten
|-
| turmericRoot || turmericRootRotten || unfiredBowlBurnMedicine || unfiredBowlDry
|-
| unfiredBowlFoodPoisoningMedicine || unfiredBowlInjuryMedicine || unfiredBowlMedicineRotten || unfiredBowlVirusMedicine
|-
| unfiredBowlWet || unfiredUrnDry || unfiredUrnFlour || unfiredUrnFlourRotten
|-
| unfiredUrnHulledWheat || unfiredUrnHulledWheatRotten || unfiredUrnWet || wheat
|-
| wheatRotten || willowSeed || willowSeedRotten || woodenPole
|-
| woolskin
|}

Latest revision as of 17:55, 11 August 2024

The Lua Command Line

Overview

The Lua Command Line is an in-game command line tool that allows direct interaction with the Sapiens Lua game engine. It can be accessed by pressing '`'. Once the command line has started (the prompt should turn to "lua>"), Lua commands can be executed directly allowing the player to modify various game behaviors. The Lua Command Line can be exited by typing /exit.

Commands

Command Description
completeCheat() Enables instant build mode.
setDebugObject() There is an option in the game menu that turns on debug mode. With that enabled, new buttons appear in the UI when you select any object in the world. If you click the debug button for that object, it logs all of the details about that object to every log, and is now set to be the target object for objectLog. These mj:objectLogs are scattered throughout the code base, in particular around the sapiens AI, so this is useful for tracking exactly what one particular sapien is doing. This command allows you to set a debug object from the lua command line.
setSunrise() Advances the game time of day to sunrise.
setSunset() Advances the game time of day to sunset.
printType() Allows you to find the typeIndex or typeKey for an object.

Example:
lua>printType("gameObject.wheat")
typeKey:gameObject.wheat = 338
lua>printType(338)
typeIndex:338 = gameObject.wheat
lua>spawn(338)

spawn(object, count) Spawn an item in the game.

To spawn an item in the game type:

spawn("apple",1)

Please note if the quantity is omitted, 1 will default. In other words...

spawn("apple",1)

and

spawn("apple")

...produce the same result. List of Spawnable Game Objects

tp() Teleport to a location.

Spawnable Game Objects

The following is a list of the spawnable game objects that can be used in conjunction with the "spawn()" command:

1 2 3 4
aloeLeaf aloeLeafRotten alpacaMeat alpacaMeatCooked
apple appleRotten aspenBigSeed aspenBigSeedRotten
aspenSeed aspenSeedRotten balafon bambooSeed
bambooSeedRotten banana bananaRotten beetroot
beetrootCooked beetrootRotten beetrootSeed beetrootSeedRotten
birchSeed birchSeedRotten bone boneFlute
bone_hatchet boneKnife boneSpear boneSpearHead
branch branchRotten breadDough breadDoughRotten
burntBranch chickenMeat chickenMeatCooked clay
coconut coconutRotten deadAlpaca deadChicken
deadChickenRotten dirt echinaceaFlower echinaceaFlowerRotten
elderberry elderberryRotten firedBowl firedBowlBurnMedicine
firedBowlFoodPoisoningMedicine firedBowlInjuryMedicine firedBowlMedicineRotten firedBowlVirusMedicine
firedBrick firedTile firedUrn firedUrnFlour
firedUrnFlourRotten firedUrnHulledWheat firedUrnHulledWheatRotten flax
flaxDried flaxRotten flaxSeed flaxSeedRotten
flaxTwine flint flintAxeHead flintHatchet
flintKnife flintPickaxe flintPickaxeHead flintSpear
flintSpearHead flatbread flatbreadRotten garlic
garlicRotten giant_bone gingerRoot gingerRootRotten
gooseberry gooseberryRotten grass hay
hayRotten log logDrum mammothMeat
mammothMeatCooked marigoldFlower marigoldFlowerRotten mudBrickDry
mudBrickWet mudTileDry mudTileWet orange
orangeRotten peach peachRotten pineCone
pineConeBig pineConeBigRotten pineConeRotten poppyFlower
poppyFlowerRotten pumpkin pumpkinCooked pumpkinRotten
quernstone raspberry raspberryRotten rock
rockSmall sand splitLog stoneAxeHead
stoneHatchet stoneKnife stonePickaxe stonePickaxeHead
stoneSpear stoneSpearHead sunflowerSeed sunflowerSeedRotten
turmericRoot turmericRootRotten unfiredBowlBurnMedicine unfiredBowlDry
unfiredBowlFoodPoisoningMedicine unfiredBowlInjuryMedicine unfiredBowlMedicineRotten unfiredBowlVirusMedicine
unfiredBowlWet unfiredUrnDry unfiredUrnFlour unfiredUrnFlourRotten
unfiredUrnHulledWheat unfiredUrnHulledWheatRotten unfiredUrnWet wheat
wheatRotten willowSeed willowSeedRotten woodenPole
woolskin
Retrieved from "http://wiki.playsapiens.com/index.php?title=Lua_Command_Line&oldid=27453"