Devtest: Add branding iron

[minetest.git] / games / devtest / mods / testtools / README.md

diff --git a/games/devtest/mods/testtools/README.md b/games/devtest/mods/testtools/README.md
index 3de2969a740bcf60229c9099c9e92f074146826c..03d826da7f875264b0d5331a5aca1fe25bda46cd 100644 (file)
--- a/games/devtest/mods/testtools/README.md
+++ b/games/devtest/mods/testtools/README.md
@@ -120,6 +120,17 @@ Usage:
 * Punch entity to increase visual size
 * Sneak+punch entity to decrease visual size
 
+## Branding Iron
+Give an object a temporary name.
+
+Usage:
+* Punch object: Brand the object
+* Punch air: Brand yourself
+* The name is valid until the object unloads.
+* Devices that accept the returned name also accept "player:<playername>" for players.
+
+Use `testtools.get_branded_object(name)` to get an ObjRef.
+
 ## Note Meta Privatizer
 Sets the 'formspec' and 'infotext' metadata fields of a node
 to private. This means that clients can no longer access these