documentation writing and API doc update
This commit is contained in:
@@ -1,34 +1,43 @@
|
||||
# actor
|
||||
#### spawn(script, config, callback)
|
||||
# actor Module
|
||||
|
||||
Create a new actor, using this actor as the master, initializing it with 'script' and with data (as a JSON or Nota file) from 'config'.
|
||||
## all_objects
|
||||
|
||||
#### rm_pawn(pawn)
|
||||
```
|
||||
function all_objects(fn, startobj = world)
|
||||
```
|
||||
|
||||
|
||||
## find_object
|
||||
|
||||
#### timers
|
||||
**array**
|
||||
|
||||
[]
|
||||
|
||||
#### kill()
|
||||
|
||||
Remove this actor and all its padawans from existence.
|
||||
|
||||
#### interval(fn, seconds)
|
||||
```
|
||||
function find_object(fn, startobj = world)
|
||||
```
|
||||
|
||||
|
||||
## tag_add
|
||||
|
||||
#### delay(fn, seconds)
|
||||
|
||||
Call 'fn' after 'seconds' with 'this' set to the actor.
|
||||
|
||||
#### padawans
|
||||
**array**
|
||||
|
||||
[
|
||||
{}
|
||||
]
|
||||
```
|
||||
function tag_add(tag, obj)
|
||||
```
|
||||
|
||||
|
||||
## tag_rm
|
||||
|
||||
```
|
||||
function tag_rm(tag, obj)
|
||||
```
|
||||
|
||||
|
||||
## tag_clear_guid
|
||||
|
||||
```
|
||||
function tag_clear_guid(obj)
|
||||
```
|
||||
|
||||
|
||||
## objects_with_tag
|
||||
|
||||
```
|
||||
function objects_with_tag(tag)
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user