madmaxoft
e9e9593e6d
APIDump: Updated cWorld:ScheduleTask()'s description.
2014-01-19 23:50:49 +01:00
madmaxoft
cef2967637
APIDump: Updated cPluginManager:GetAllPlugins().
2014-01-17 15:54:33 +01:00
madmaxoft
343136a2ae
Finished exporting cWorld:ScheduleTask() to Lua API.
2014-01-16 19:56:08 +01:00
Alexander Harkness
bf0d58428d
Merge pull request #548 from worktycho/documention
...
Added Documention for a few features I've added
2014-01-16 09:55:37 -08:00
Tycho
daf94e5f48
Documented the SchedualeTask function
2014-01-16 09:53:46 -08:00
madmaxoft
7e2675a998
APIDump: Explicitly listed static cPlayer functions.
2014-01-15 19:26:01 +01:00
madmaxoft
448ac3ef14
APIDump: Added missing bits of documentation.
...
The recent changes didn't document some of the new API functions.
2014-01-13 19:45:15 +01:00
madmaxoft
55e92f056d
APIDump: Documented the plugin messaging hook and function.
2014-01-13 19:21:57 +01:00
madmaxoft
2e0fcbdcb7
Documented the cIniFile:AddValue* functions.
...
Now the documentation really matches the implementation.
2014-01-11 16:50:52 +01:00
madmaxoft
84bf32f857
Fixed cPluginManager:AddHook() binding.
...
Fixes #401 . Old formats are still accepted, for compatibility reasons.
2014-01-05 15:46:45 +01:00
madmaxoft
537d1c4e42
APIDump: Added the SettingUpDecoda article.
...
This implements #383 .
2013-12-27 20:56:01 +01:00
madmaxoft
f0ca18d72a
APIDump: Added the WritingPlugin article to the exported pages.
2013-12-27 14:33:15 +01:00
Alexander Harkness
8c6337ff20
Removed documentation for cChatColour:MakeColor()
2013-12-24 13:25:03 +00:00
madmaxoft
5d4e1725d4
APIDump: Ignoring the multi-inheritance members.
...
We may get to documenting them one day, but for now they are unused anyway, so there's no point in documenting them. They are a by-product of multiple inheritance, re-introduced due to #422 .
2013-12-16 22:13:46 +01:00
STRWarrior
6e30e54eb0
Documented ForceSetSpeed.
2013-12-15 20:27:19 +01:00
STRWarrior
ae061d717b
APIDump: Documented New functions
2013-12-15 15:18:53 +01:00
STRWarrior
a4393dbf6c
Documented cTNTEntity.
2013-12-14 16:40:51 +01:00
STRWarrior
02301bc987
Documented SpawnFallingBlock()
2013-12-07 14:30:17 +01:00
madmaxoft
a02ed3b92e
APIDump: Documented the new cPluginManager:GetCurrentPlugin() function.
2013-12-05 22:06:52 +01:00
STRWarrior
686e0c12e2
cWorld::SpawnExperienceOrb() now returns the entity ID of the spawned orb.
...
Documented etExpOrb.
2013-11-26 15:37:15 +01:00
STRWarrior
a0c6342a29
Documented SpawnExperienceOrb in cWorld
2013-11-25 21:51:52 +01:00
madmaxoft
e683c54b49
APIDump: Moved projectiles' documentation to a separate file.
2013-11-24 10:08:04 +01:00
madmaxoft
38fe16d8b6
APIDump: Removed unwanted functions.
2013-11-23 21:43:38 +01:00
madmaxoft
3ef7f2008f
APIDump: Reformatted the sqlite docs.
2013-11-23 21:32:18 +01:00
madmaxoft
d9dc241e6f
APIDump: The descriptions are read from multiple files.
...
All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
2013-11-23 21:27:02 +01:00
STRWarrior
cc77ffd069
Documented sqlite functions. Used: http://lua.sqlite.org/index.cgi/doc/tip/doc/lsqlite3.wiki#sqlite3_functions
2013-11-23 21:13:55 +01:00
madmaxoft
520088fc7c
APIDump: Added more constant groups.
...
Also fixed the parsing of the Include data in the constant groups, and added linkification to group texts.
2013-11-23 19:40:35 +01:00
madmaxoft
b8aaf13a12
APIDump: Added a few constant groups to the descriptions.
2013-11-22 22:12:46 +01:00
madmaxoft
7a2170f6b3
APIDump: Implemented constant groups.
...
Fix #289 .
2013-11-22 21:46:06 +01:00
madmaxoft
63753c5e84
Added cFile:GetFolderContents().
...
Fix 162.
2013-11-22 20:11:24 +01:00
madmaxoft
4fbfe59ea0
APIDump: Fixed cRoot's furnace query API.
2013-11-22 16:52:09 +01:00
madmaxoft
7fd3fda5d3
APIDump: Documented new cRoot:GetFurnaceRecipe().
2013-11-22 12:37:55 +01:00
madmaxoft
98be3ca0e4
APIDump: Documented cPlayer XP-related functions.
2013-11-21 22:12:52 +01:00
madmaxoft
e9a8b96479
APIDump: Documented cWorld:ForEachBlockEntityInChunk() and cWorld:DoWithBlockEntityAt().
2013-11-20 22:04:16 +01:00
madmaxoft
4844422e06
APIDump: Documented Vector3i.
2013-11-19 06:49:21 +01:00
madmaxoft
9bc79722c7
APIDump: Documented Vector3f.
2013-11-17 23:27:07 +01:00
madmaxoft
d96f622437
APIDump: Documented lxp, the XML parser class.
2013-11-15 22:39:27 +01:00
madmaxoft
2ed8e38419
APIDump: Small fixes and additions.
2013-11-15 13:44:07 +01:00
madmaxoft
26d3dd3466
APIDump: Documented cSignEntity.
2013-11-15 13:34:20 +01:00
madmaxoft
7586e832bf
APIDump: Documented cNoteEntity.
2013-11-15 13:10:36 +01:00
madmaxoft
194aa1decb
APIDump: Documented the cJukeboxEntity.
2013-11-15 12:42:35 +01:00
madmaxoft
4f2645d0e5
APIDump: Documented cChunkDesc:GetBlockEntity().
2013-11-15 11:34:43 +01:00
madmaxoft
90fc51c4d0
cRoot::SaveAllChunks() doesn't wait for the save (deadlocks).
...
Rather, it only queues the save task onto each world's tick thread.
2013-11-15 10:13:32 +01:00
madmaxoft
6e5d7b70a1
APIDump: Removed the BlockEntity constructors' docs.
2013-11-15 10:09:54 +01:00
madmaxoft
9287349cc2
APIDump: Documented Vector3d.
2013-11-11 16:02:10 +01:00
madmaxoft
0762893ee1
APIDump: Documented cServer:IsHardCore()
2013-11-09 21:18:03 +01:00
madmaxoft
148f723632
APIDump: Documented TakeDamageInfo.
2013-11-09 19:25:03 +01:00
madmaxoft
d74b0dbd5b
APIDump: Documented the relevant tolua functions.
2013-11-09 19:16:44 +01:00
madmaxoft
13800a0023
APIDump: Documented ItemCategory.
2013-11-05 22:16:42 +01:00
madmaxoft
d1e51886e5
APIDump: Fixed HOOK_LOGIN short desc.
2013-10-31 23:47:46 +01:00
madmaxoft
2bb1dd5015
APIDump: Documented cWindow.
2013-10-28 13:32:10 +01:00
madmaxoft
1a29c19619
APIDump: Documented HTTPFormData and HTTPRequest.
2013-10-28 13:08:14 +01:00
madmaxoft
4f32079692
APIDump: Documented cWorld.
2013-10-27 09:45:02 +01:00
madmaxoft
4871968bc9
APIDump: Documented cRoot.
2013-10-27 09:39:11 +01:00
madmaxoft
5d58457c9e
APIDump: Documented cProjectileEntity.
2013-10-27 09:29:02 +01:00
madmaxoft
73e7d21387
APIDump: Documented cPickup.
2013-10-26 19:54:51 +02:00
madmaxoft
e7b3ced70b
APIDump: Documented cIniFile.
2013-10-26 10:33:44 +02:00
madmaxoft
c875b88758
APIDump: Documented cMonster.
2013-10-24 17:20:52 +02:00
madmaxoft
7c2ba55442
APIDump: Documented cEnchantments.
...
The constants are self-documenting, no need to describe them further.
2013-10-24 16:32:51 +02:00
madmaxoft
785301c9a0
APIDump: Documented cPickup.
2013-10-24 16:27:48 +02:00
madmaxoft
6cad07c429
APIDump: Documented cItemGrid and cPlayer.
2013-10-24 12:24:40 +02:00
madmaxoft
2cf196a892
APIDump: Added cChatColor constants.
...
They don't really need much documentation, so just ignoring them in the Undocumented output.
2013-10-23 13:34:44 +02:00
madmaxoft
60abe99d5e
APIDump: Documented the cHopperEntity class.
2013-10-23 12:19:43 +02:00
madmaxoft
a91b422594
APIDump: Linkified cEntity returns.
2013-10-23 12:09:34 +02:00
madmaxoft
b571294b6e
APIDump: Added link from cItem to the global ItemToString() et al.
2013-10-20 23:43:09 +02:00
madmaxoft
83d2d375c9
APIDump: Fixed link in cPawn's desc.
2013-10-20 23:36:00 +02:00
madmaxoft
70a734d4f9
APIDump: Various small fixes and additions.
2013-10-20 15:32:33 +02:00
madmaxoft
16afec96de
APIDump: Fixed a few broken links.
2013-10-20 15:08:30 +02:00
madmaxoft
07a117b096
APIDump: Added basic statistics about the docs.
2013-10-20 11:12:33 +02:00
madmaxoft
0258213d24
Merge branch 'htmlescape'.
2013-10-20 09:14:30 +02:00
madmaxoft
3f2813d6ff
APIDump: Added member-variable filtering.
2013-10-19 22:21:38 +02:00
Alexander Harkness
d1ddd2492b
Added a APIDump description for GetHTMLEscapedString.
2013-10-19 21:18:27 +01:00
madmaxoft
be996c1662
APIDump: Added cIniFile additional info.
2013-10-18 23:22:26 +02:00
madmaxoft
1e67ff3499
APIDump: Added example code to cItem.
2013-10-18 21:49:07 +02:00
madmaxoft
373900964c
APIDump: Documented cItem's variables.
2013-10-18 21:38:44 +02:00
madmaxoft
07ba48840d
APIDump: Added support for member variables.
2013-10-18 21:29:38 +02:00
madmaxoft
778d786349
APIDump: Split long code into functions.
2013-10-18 20:32:36 +02:00
madmaxoft
41270dc02e
APIDump: Ignore internal APIDump stuff.
2013-10-18 20:22:24 +02:00
madmaxoft
9776b89fb7
APIDump: Documented HOOK_PLAYER_RIGHT_CLICKING_ENTITY.
2013-10-18 10:04:44 +02:00
madmaxoft
5a31d191eb
APIDump: Documented HOOK_PLAYER_SHOOTING.
2013-10-18 09:57:35 +02:00
madmaxoft
8020cbd3d7
APIDump: Documented HOOK_PLAYER_SPAWNED.
2013-10-18 09:47:21 +02:00
madmaxoft
1f6498de22
APIDump: Documented HOOK_PLAYER_TOSSING_ITEM.
2013-10-18 09:40:18 +02:00
madmaxoft
fd7c1754d0
APIDump: Documented HOOK_PLAYER_USED_BLOCK.
2013-10-17 17:14:57 +02:00
madmaxoft
dfd4c78c87
APIDump: Documented HOOK_PLAYER_USED_ITEM.
2013-10-17 17:10:46 +02:00
madmaxoft
91f7662a51
APIDump: Documented HOOK_PLAYER_USING_BLOCK.
2013-10-17 16:38:46 +02:00
madmaxoft
96072c9e0c
APIDump: Documented HOOK_PLAYER_USING_ITEM.
2013-10-17 16:31:35 +02:00
madmaxoft
ed935d82bb
APIDump: Documented HOOK_UPDATED_SIGN.
2013-10-17 16:18:16 +02:00
madmaxoft
d3f5a979b4
APIDump: Documented HOOK_TICK.
2013-10-17 16:07:18 +02:00
madmaxoft
36f6ffaadf
APIDump: Documented HOOK_TAKE_DAMAGE.
2013-10-17 15:20:44 +02:00
madmaxoft
424807e331
APIDump: Documented HOOK_UPDATING_SIGN.
2013-10-17 13:54:53 +02:00
madmaxoft
d688ac8e50
APIDump: Documented HOOK_WEATHER_CHANGED.
2013-10-16 15:47:27 +02:00
madmaxoft
0aa20762bc
APIDump: Documented HOOK_WEATHER_CHANGING.
2013-10-16 15:44:04 +02:00
madmaxoft
f8e3cbe44f
APIDump: Documented HOOK_WORLD_TICK.
2013-10-16 15:33:56 +02:00
Alexander Harkness
17aff20666
Added HOOK_PLAYER_RIGHT_CLICK
2013-10-15 19:57:00 +01:00
madmaxoft
9c7ca813d2
APIDump: Documented HOOK_SPAWNING_MONSTER.
2013-10-15 18:12:37 +02:00
madmaxoft
ba6c2b9ef4
APIDump: Documented HOOK_SPAWNING_ENTITY.
2013-10-15 18:06:06 +02:00
madmaxoft
44ec010e15
APIDump: Documented HOOK_SPAWNED_MONSTER.
2013-10-15 17:58:39 +02:00
madmaxoft
167d8d346e
APIDump: Documented HOOK_SPAWNED_ENTITY.
2013-10-15 17:55:01 +02:00
madmaxoft
edd1a670ed
APIDump: Documented HOOK_PRE_CRAFTING.
2013-10-15 17:43:41 +02:00
madmaxoft
b079676290
APIDump: Documented HOOK_POST_CRAFTING.
2013-10-15 17:35:34 +02:00
