stujones11/minetest-npcf
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
stujones11 2013-09-29 15:22:58 +01:00
parent 472aac9fdc
commit f40284e222
2 changed files with 23 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.txt
View File

@ -3,7 +3,7 @@ Mintest Modpack - NPC Framework [minetest-npcf]
Version: 0.1.0
License of Source Code: LGPL
---------------------------
----------------------------
(c) Copyright Stuart Jones, 2013
License of Textures: WTFPL

47
npcf/README.md
View File

@ -62,7 +62,7 @@ Reload all currently unloaded NPCs. (requires server priv)
### getpos npc_name
Display the integer position of the named NPC.
Display the position of the named NPC.
### reload npc_name
@ -103,27 +103,6 @@ Use the global npcf api to create your own NPC.
This is a minimal example, see the NPCs included for more elaborate usage examples.
### npcf
The global NPC framework namespace. Other global variables include.
NPCF_ANIM_STAND = 1
NPCF_ANIM_SIT = 2
NPCF_ANIM_LAY = 3
NPCF_ANIM_WALK = 4
NPCF_ANIM_WALK_MINE = 5
NPCF_ANIM_MINE = 6
NPCF_ANIM_RUN = 7
NPCF_SHOW_IN_CREATIVE = true
NPCF_SHOW_NAMETAGS = true
NPCF_BUILDER_REQ_MATERIALS = false
NPCF_DECO_FREE_ROAMING = true
NPCF_GUARD_ATTACK_PLAYERS = true
NPCF_DUPLICATE_REMOVAL_TIME = 10
All of the above can be overridden by including a npcf.conf file in the npcf directory.
See: npcf.conf.example
Properties
----------
Additional properties included by the framework. (defaults)
@ -169,9 +148,27 @@ may not be available or nil at the time of registration.
### on_receive_fields = function(self, fields, sender)
Called when a button is pressed in the NPC's formspec.
Methods
-------
Global functions provided by npcf
npcf
----
The global NPC framework namespace. Other global variables include.
NPCF_ANIM_STAND = 1
NPCF_ANIM_SIT = 2
NPCF_ANIM_LAY = 3
NPCF_ANIM_WALK = 4
NPCF_ANIM_WALK_MINE = 5
NPCF_ANIM_MINE = 6
NPCF_ANIM_RUN = 7
NPCF_SHOW_IN_CREATIVE = true
NPCF_SHOW_NAMETAGS = true
NPCF_BUILDER_REQ_MATERIALS = false
NPCF_DECO_FREE_ROAMING = true
NPCF_GUARD_ATTACK_PLAYERS = true
NPCF_DUPLICATE_REMOVAL_TIME = 10
All of the above can be overridden by including a npcf.conf file in the npcf directory.
See: npcf.conf.example
### npcf:register_npc(name, def)