Convert to .MD docs
This commit is contained in:
parent
4170d56e62
commit
2ce1e8afbc
|
@ -3,20 +3,26 @@ Advanced_NPC Alpha-2 (DEV)
|
||||||
==========================
|
==========================
|
||||||
|
|
||||||
IMPORTANT: In this documentation is only the explanation of the particular operation of each predefined
|
IMPORTANT: In this documentation is only the explanation of the particular operation of each predefined
|
||||||
action and task. Read reference documentation for details about API operation at `API.txt`.
|
action and task. Read reference documentation for details about API operation at `api.md`.
|
||||||
|
|
||||||
Action (`add_action`)
|
Action (`add_action`)
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
* `SET_INTERVAL` : Set the interval at which the `action` are executed.
|
Definition tables
|
||||||
args = {
|
-----------------
|
||||||
|
|
||||||
|
#### `SET_INTERVAL`
|
||||||
|
Set the interval at which the `action` are executed.
|
||||||
|
|
||||||
|
{
|
||||||
interval = 1, -- A decimal number, in seconds (default is 1 second)
|
interval = 1, -- A decimal number, in seconds (default is 1 second)
|
||||||
freeze = false, -- if true, mobs_redo API will not execute until interval is set
|
freeze = false, -- if true, mobs_redo API will not execute until interval is set
|
||||||
}
|
}
|
||||||
|
|
||||||
* `FREEZE` : This action allows to stop/execute mobs_redo API.
|
#### `FREEZE`
|
||||||
This is good for stopping the NPC from fighting, wandering, etc.
|
This action allows to stop/execute mobs_redo API.
|
||||||
Arguments table definition
|
This is good for stopping the NPC from fighting, wandering, etc.
|
||||||
|
|
||||||
{
|
{
|
||||||
freeze = false, -- Boolean, if true, mobs_redo API will not execute.
|
freeze = false, -- Boolean, if true, mobs_redo API will not execute.
|
||||||
}
|
}
|
||||||
|
@ -24,8 +30,9 @@ Action (`add_action`)
|
||||||
Tasks (`add_task`)
|
Tasks (`add_task`)
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
* `USE_BED` : Sequence of actions that allows the NPC to use a bed.
|
#### `USE_BED`
|
||||||
Arguments table definition
|
Sequence of actions that allows the NPC to use a bed.
|
||||||
|
|
||||||
{
|
{
|
||||||
pos = {x=0,y=0,z=0}, -- Position of bed to be used.
|
pos = {x=0,y=0,z=0}, -- Position of bed to be used.
|
||||||
action = action, --[[
|
action = action, --[[
|
|
@ -3,7 +3,7 @@ Advanced_NPC API Reference Alpha-2 (DEV)
|
||||||
* More information at <https://github.com/hkzorman/advanced_npc/wiki>
|
* More information at <https://github.com/hkzorman/advanced_npc/wiki>
|
||||||
|
|
||||||
IMPORTANT: This WIP & unfinished file contains the definitions of current advanced_npc functions
|
IMPORTANT: This WIP & unfinished file contains the definitions of current advanced_npc functions
|
||||||
(Some documentation is lacking, so please bear in mind that this WIP file is just to enhance it.)
|
(Some documentation is lacking, so please bear in mind that this WIP file is just to enhance it)
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
------------
|
------------
|
||||||
|
@ -42,8 +42,8 @@ Or after add in the world
|
||||||
|
|
||||||
NPC Steps
|
NPC Steps
|
||||||
---------
|
---------
|
||||||
The API works with NPC steps, then then `on_step` callback need
|
The API works with NPC steps, then `on_step` callback need run the
|
||||||
run the `npc.on_step(luaentity)`. This function process the NPC actions
|
`npc.on_step(luaentity)`. This function process the NPC actions
|
||||||
and return the freeze state, which is used for stop mobs_redo behavior.
|
and return the freeze state, which is used for stop mobs_redo behavior.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
@ -163,12 +163,14 @@ Definition tables
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
Syntax example 1:
|
Syntax example 1:
|
||||||
|
|
||||||
npc.dialogue.register_dialogue({
|
npc.dialogue.register_dialogue({
|
||||||
text = "Hello.", -- "Hello." will be said by the NPC upon rightclick and displayed in the messages section.
|
text = "Hello.", -- "Hello." will be said by the NPC upon rightclick and displayed in the messages section.
|
||||||
tags = {"unisex", "phase1"} -- The flags that define the conditions of who and what can say the text.
|
tags = {"unisex", "phase1"} -- The flags that define the conditions of who and what can say the text.
|
||||||
})
|
})
|
||||||
|
|
||||||
Syntax example 2:
|
Syntax example 2:
|
||||||
|
|
||||||
npc.dialogue.register_dialogue({
|
npc.dialogue.register_dialogue({
|
||||||
text = "Hello again."
|
text = "Hello again."
|
||||||
-- The tags object is excluded, meaning that any NPC can say "Hello again." upon rightclick under no condition.
|
-- The tags object is excluded, meaning that any NPC can say "Hello again." upon rightclick under no condition.
|
Loading…
Reference in New Issue
Block a user