Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api docs #1792

Merged
merged 11 commits into from
Mar 22, 2015
Merged

Api docs #1792

merged 11 commits into from
Mar 22, 2015

Conversation

NiLSPACE
Copy link
Member

@NiLSPACE NiLSPACE commented Mar 6, 2015

Started documenting undocumented functions in APIDump

@@ -197,6 +197,7 @@ g_APIDesc =
baMetas = { Notes = "Operations should work on block metas" },
baLight = { Notes = "Operations should work on block (emissive) light" },
baSkyLight = { Notes = "Operations should work on skylight" },
msDifference = { Notes = "Block becomes air if Src and Dst are the same." },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens to all the other blocks, are they kept or set to a different value or ...?

SetSignLines = { Params = "X, Y, Z, Line1, Line2, Line3, Line4, [{{cPlayer|Player}}]", Return = "", Notes = "Sets the sign text at the specified coords. The sign-updating hooks are called for the change. The Player parameter is used to indicate the player from whom the change has come, it may be nil." },
SetTicksUntilWeatherChange = { Params = "NumTicks", Return = "", Notes = "Sets the number of ticks after which the weather will be changed." },
SetTimeOfDay = { Params = "TimeOfDayTicks", Return = "", Notes = "Sets the time of day, expressed as number of ticks past sunrise, in the range 0 .. 24000." },
SetTNTShrapnelLevel = { Params = "eShrapnelLevel", Return = "", Notes = "Sets the Shrampel level of the world." },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be possible to link to the eShrapnelLevel values from the parameter list.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I searched on how to do that, but I couldn't find it.

@madmaxoft
Copy link
Member

I've rebased this PR onto current master and added the eShrapnelLevel linkification.

@NiLSPACE
Copy link
Member Author

Great :) so is this mergeable?

madmaxoft added a commit that referenced this pull request Mar 22, 2015
@madmaxoft madmaxoft merged commit ffcadd5 into master Mar 22, 2015
@madmaxoft madmaxoft deleted the APIDocs branch March 22, 2015 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants