on_research_started has a poor description

Place to report issues and suggest improvements to the API documentation.
User avatar
PennyJim
Long Handed Inserter
Long Handed Inserter
Posts: 68
Joined: Wed Jan 18, 2023 3:49 am
Contact:

on_research_started has a poor description

Post by PennyJim »

I have a problem with these events and their description:

Code: Select all

on_research_canceled	Called when research is cancelled.
on_research_started	Called when a technology research starts.
I would prefer if these specified that they apply to research in the queue as well. I had initially assumed that it meant they get called when the research reaches the start of the queue and actually started started.

I propose

Code: Select all

on_research_canceled	Called when research is cancelled or removed from queue.
on_research_started	Called when a technology research starts or is queued
User avatar
PennyJim
Long Handed Inserter
Long Handed Inserter
Posts: 68
Joined: Wed Jan 18, 2023 3:49 am
Contact:

LuaForce.add_research() is incorrect

Post by PennyJim »

Okay I just actually tested it, and it's instead LuaForce.add_research that's the problem.

It says it raises the on_research_started event instantly if successful, but it instead runs when the research starts getting researched.
Like I had initially thought based on the description of the event

I have added my request of what I thought on_research_started was: viewtopic.php?f=28&t=105750&p=605259#p605259
Post Reply

Return to “Documentation Improvement Requests”