[0.10.1 MINOR] help function and createentity train

[FreeER]

So, I thought I'd use the new makefile method to make a list of the help 'documentation' and found that these do not have a help method/property, or at least I've no idea how to find it lol.

Code: Select all

Lua/Entity
  Lua/Player
  Lua/Train
Lua/GUI (Lua/GuiElement?)
Lua/Inventory

Also, in the control script you have to access 'help' as a property, not as a function, aka whatever.help and not whatever.help() (but you do have to use whatever.help() in the console...), not sure if that was actually intended...

While testing I found that game.createentity{name="diesel-locomotive", position=game.findnoncollidingposition("diesel-locomotive", game.player.position, 100, 1)} will fail "for an unknown reason", unless there are tracks close enough for it to be placed on, in which case it works (basically...I've found the reason lol).

script I used for testing if you care to see it

script

Ignore all of the pcalls...I was initially going to loop through all of the entityprototypes, and use pcall(createentity{name...}.help) (because some entities can't be created through createentity, flame-thower-explosion, and others require more than just name and position, like a 'shooting target'?) and I just started copying and pasting later they should really be removed though because they do absolutely nothing, Factorio 'handles' the error internally (by halting the script) instead of passing the error onto the script for it to handle

Code: Select all

game.onevent(defines.events.onpickedupitem, function(event)
  local helplist = {}
  error, helplist[#helplist+1] = pcall(game.help)
  error, helplist[#helplist+1] = pcall(game.entityprototypes["stone-furnace"].help)
  error, helplist[#helplist+1] = pcall(game.itemprototypes["stone-furnace"].help)
  error, helplist[#helplist+1] = pcall(game.player.force.help)
  error, helplist[#helplist+1] = pcall(game.player.force.recipes["iron-plate"].help)
  error, helplist[#helplist+1] = pcall(game.player.force.technologies["steel-processing"].help)
  error, helplist[#helplist+1] = pcall(game.gettile(game.player.position.x,game.player.position.y).help)
  error, helplist[#helplist+1] = pcall(game.createunitgroup({position=game.player.position}).help)
  
  helplist = table.concat(helplist, "\r\n\r\n\r\n")
  game.makefile("help.txt", helplist)
  game.player.print("done")
end)

script output cause why not

Help for LuaGame:

Methods:
__index(...)
__newindex(...)
buildenemybase(...)
canplaceentity(...)
createentity(...)
createunitgroup(...)
disabletipsandtricks(...)
findenemyunits(...)
findentities(...)
findentitiesfiltered(...)
findnearestenemy(...)
findnoncollidingposition(...)
freezedaytime(...)
generateeventname(...)
getentitybytag(...)
geteventhandler(...)
getlocalisedentityname(...)
getlocaliseditemname(...)
getlocalisedtechnologyname(...)
getplayer(...)
getpollution(...)
gettext(...)
gettile(...)
gettileproperties(...)
isdemo(...)
ispathfinderbusy(...)
killallenemies(...)
load(...)
localise(...)
makefile(...)
onevent(...)
oninit(...)
onload(...)
onsave(...)
pollute(...)
printentitystatistics(...)
raiseevent(...)
regenerateentity(...)
regeneratetiles(...)
reloadscript(...)
removepath(...)
save(...)
saveatlas(...)
setgamestate(...)
setmulticommand(...)
settiles(...)
showmessagedialog(...)
takescreenshot(...)

Values:
alwaysday [RW]
darkness [R]
daytime [RW]
difficulty [R]
entityprototypes [R]
evolutionfactor [RW]
finished [R]
forces [R]
itemprototypes [R]
mapsettings [R]
peacefulmode [RW]
player [R]
speed [RW]
tick [RW]
windorientation [RW]
windorientationchange [RW]
windspeed [RW]






Help for LuaEntityPrototype:

Methods:
__gc(...)
__index(...)
__newindex(...)
hasflag(...)

Values:
infiniteresource [R]
maxhealth [R]
minimumresourceamount [R]
name [R]
resourcecategory [R]
type [R]
valid [R]






Help for LuaItemPrototype:

Methods:
__gc(...)
__index(...)
__newindex(...)
hasflag(...)

Values:
buildresult [R]
fuelvalue [R]
group [R]
name [R]
stacksize [R]
type [R]
valid [R]






Help for LuaForce:

Methods:
__gc(...)
__index(...)
__newindex(...)
chart(...)
clearchart(...)
disableallprototypes(...)
disableresearch(...)
enableallrecipes(...)
enablealltechnologies(...)
equals(...)
getammodamagemodifier(...)
getentitycount(...)
getgunspeedmodifier(...)
getshiplandinginprogress(...)
gettimetoland(...)
getturretattackmodifier(...)
researchalltechnologies(...)
reset(...)
resetrecipes(...)
resettechnologies(...)
setammodamagemodifier(...)
setgunspeedmodifier(...)
setturretattackmodifier(...)

Values:
currentresearch [RW]
ghosttimetolive [RW]
inserterstacksizebonus [RW]
laboratoryspeedmodifier [RW]
logisticrobotspeedmodifier [RW]
logisticrobotstoragemodifier [RW]
manualcraftingspeedmodifier [RW]
manualminingspeedmodifier [RW]
maximumfollowingrobotscount [RW]
name [R]
numbercharacterlogisticslots [R]
numberquickbars [RW]
recipes [R]
technologies [R]






Help for LuaRecipe:

Methods:
__gc(...)
__index(...)
__newindex(...)
reload(...)

Values:
category [R]
enabled [RW]
name [R]
valid [R]






Help for LuaTechnology:

Methods:
__gc(...)
__index(...)
__newindex(...)
reload(...)

Values:
enabled [RW]
name [R]
researched [RW]
valid [R]






Help for LuaTile:

Methods:
__gc(...)
__index(...)
__newindex(...)
collideswith(...)

Values:
name [R]
valid [R]






Help for LuaUnitGroup:

Methods:
__gc(...)
__index(...)
__newindex(...)
addmember(...)
destroy(...)
setautonomous(...)
setcommand(...)
startmoving(...)

Values:
members [R]
position [R]
state [R]
valid [R]

[cube]

Thanks for the reports.

• I added the missing help methods for 0.10.2.
• the help methods are mehtods everywhere. you use it as a property only as an argument to pcall (it takes a function as an argument and calls it -- basically it adds the method call brackets by itself)
• Train can be only placed on rails, that is a feature I changed the error message so that it doesn't sound so "unknown reason"

[FreeER]

I added the missing help methods for 0.10.2.

Awesome thanks!

you use it as a property only as an argument to pcall

...this makes me feel like an idiot now

Train can be only placed on rails, that is a feature

I did assume that Of course it could be argued that mining drills 'can only be placed on ore' but I wouldn't really want that implemented in createentity A more descriptive error message which was the reason I mentioned it though, so thanks for that too

[cube]

A more descriptive error message which was the reason I mentioned it though, so thanks for that too

It won't be more descriptive, it just won't say that it is an unknown reason