@caspertech/node-metaverse 0.5.40 → 0.5.51

package/examples/Groups/Group.ts

@@ -1,96 +1,102 @@
-import { ExampleBot } from '../ExampleBot';
-import { UUID } from '../../lib/classes/UUID';
-import { GroupNoticeEvent } from '../../lib/events/GroupNoticeEvent';
-
-class Group extends ExampleBot
-{
-    async onConnected()
-    {
-        this.bot.clientEvents.onGroupNotice.subscribe(this.onGroupNotice.bind(this));
-
-        // Group invite example
-        // Just omit the role parameter for "everyone" role
-        //
-        // bot.clientCommands.group.sendGroupInvite("c6424e05-6e2c-fb03-220b-ca7904d11e04", "d1cd5b71-6209-4595-9bf0-771bf689ce00");
-
-        // Advanced group invite example
-        //
-
-        const userToInvite = new UUID('d1cd5b71-6209-4595-9bf0-771bf689ce00');
-        const groupID = new UUID('4b35083d-b51a-a148-c400-6f1038a5589e');
-
-        // Retrieve group roles
-        const roles = await this.bot.clientCommands.group.getGroupRoles(groupID);
-
-        for (const role of roles)
-        {
-            if (role.Name === 'Officers')
-            {
-                // IMPORTANT: IN PRODUCTION, IT IS HIGHLY RECOMMENDED TO CACHE THIS LIST.
-                //
-                try
-                {
-                    const members = await this.bot.clientCommands.group.getMemberList(groupID);
-                    let found = true;
-                    for (const member of members)
-                    {
-                        if (member.AgentID.toString() === userToInvite.toString())
-                        {
-                            found = true;
-                        }
-                    }
-                    if (found)
-                    {
-                        console.log('User already in group, skipping invite');
-                    }
-                    else
-                    {
-                        this.bot.clientCommands.group.sendGroupInvite(groupID, userToInvite, role.RoleID).then(() =>
-                        {
-                        });
-                    }
-                }
-                catch (error)
-                {
-                    console.error('Error retrieving member list for group invite');
-                }
-            }
-        }
-
-        // Get group member list
-        try
-        {
-            const memberList = await this.bot.clientCommands.group.getMemberList(groupID);
-            console.log(memberList.length + ' members in member list');
-        }
-        catch (error)
-        {
-            // Probably access denied
-            console.error(error);
-        }
-
-        // Get group ban list
-        try
-        {
-            const banList = await this.bot.clientCommands.group.getBanList(groupID);
-            console.log(banList.length + ' members in ban list');
-        }
-        catch (error)
-        {
-            // Probably access denied
-            console.error(error);
-        }
-    }
-
-    async onGroupNotice(event: GroupNoticeEvent)
-    {
-        // Get group name
-        const groupProfile = await this.bot.clientCommands.group.getGroupProfile(event.groupID);
-
-        console.log('Group notice from ' + event.fromName + ' (' + event.from + '), from group ' + groupProfile.Name + ' (' + event.groupID + ')');
-        console.log('Subject: ' + event.subject);
-        console.log('Message: ' + event.message);
-    }
-}
-
-new Group().run().then(() => {}).catch((err: Error) => { console.error(err) });
+import { ExampleBot } from '../ExampleBot';
+import { UUID } from '../../lib/classes/UUID';
+import { GroupNoticeEvent } from '../../lib/events/GroupNoticeEvent';
+
+class Group extends ExampleBot
+{
+    async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onGroupNotice.subscribe(this.onGroupNotice.bind(this));
+
+        // Group invite example
+        // Just omit the role parameter for "everyone" role
+        //
+        // bot.clientCommands.group.sendGroupInvite("c6424e05-6e2c-fb03-220b-ca7904d11e04", "d1cd5b71-6209-4595-9bf0-771bf689ce00");
+
+        // Advanced group invite example
+        //
+
+        const userToInvite = new UUID('d1cd5b71-6209-4595-9bf0-771bf689ce00');
+        const groupID = new UUID('4b35083d-b51a-a148-c400-6f1038a5589e');
+
+        // Retrieve group roles
+        const roles = await this.bot.clientCommands.group.getGroupRoles(groupID);
+
+        for (const role of roles)
+        {
+            if (role.Name === 'Officers')
+            {
+                // IMPORTANT: IN PRODUCTION, IT IS HIGHLY RECOMMENDED TO CACHE THIS LIST.
+                //
+                try
+                {
+                    const members = await this.bot.clientCommands.group.getMemberList(groupID);
+                    let found = true;
+                    for (const member of members)
+                    {
+                        if (member.AgentID.toString() === userToInvite.toString())
+                        {
+                            found = true;
+                        }
+                    }
+                    if (found)
+                    {
+                        console.log('User already in group, skipping invite');
+                    }
+                    else
+                    {
+                        this.bot.clientCommands.group.sendGroupInvite(groupID, userToInvite, role.RoleID).then(() =>
+                        {
+                        });
+                    }
+                }
+                catch (error)
+                {
+                    console.error('Error retrieving member list for group invite');
+                }
+            }
+        }
+
+        // Get group member list
+        try
+        {
+            const memberList = await this.bot.clientCommands.group.getMemberList(groupID);
+            console.log(memberList.length + ' members in member list');
+        }
+        catch (error)
+        {
+            // Probably access denied
+            console.error(error);
+        }
+
+        // Get group ban list
+        try
+        {
+            const banList = await this.bot.clientCommands.group.getBanList(groupID);
+            console.log(banList.length + ' members in ban list');
+        }
+        catch (error)
+        {
+            // Probably access denied
+            console.error(error);
+        }
+    }
+
+    async onGroupNotice(event: GroupNoticeEvent): Promise<void>
+    {
+        // Get group name
+        const groupProfile = await this.bot.clientCommands.group.getGroupProfile(event.groupID);
+
+        console.log('Group notice from ' + event.fromName + ' (' + event.from + '), from group ' + groupProfile.Name + ' (' + event.groupID + ')');
+        console.log('Subject: ' + event.subject);
+        console.log('Message: ' + event.message);
+    }
+}
+
+new Group().run().then(() =>
+{
+
+}).catch((err: Error) =>
+{
+    console.error(err);
+});

package/examples/InstantMessages/InstantMessages.ts

@@ -1,35 +1,41 @@
-
-import { ExampleBot } from '../ExampleBot';
-import { InstantMessageEvent } from '../../lib/events/InstantMessageEvent';
-import { ChatSourceType } from '../../lib/enums/ChatSourceType';
-import { InstantMessageEventFlags } from '../../lib/enums/InstantMessageEventFlags';
-
-class InstantMessages extends ExampleBot
-{
-    constructor()
-    {
-        super();
-    }
-
-    async onConnected()
-    {
-        this.bot.clientEvents.onInstantMessage.subscribe(this.onInstantMessage.bind(this));
-    }
-
-    async onInstantMessage(event: InstantMessageEvent)
-    {
-        if (event.source === ChatSourceType.Agent)
-        {
-            if (!(event.flags & InstantMessageEventFlags.startTyping || event.flags & InstantMessageEventFlags.finishTyping))
-            {
-                // typeInstantMessage will emulate a human-ish typing speed
-                await this.bot.clientCommands.comms.typeInstantMessage(event.from, 'Thanks for the message! This account is a scripted agent (bot), so cannot reply to your query. Sorry!');
-
-                // sendInstantMessage will send it instantly
-                await this.bot.clientCommands.comms.sendInstantMessage(event.from, 'Of course I still love you!');
-            }
-        }
-    }
-}
-
-new InstantMessages().run().then(() => {}).catch((err: Error) => { console.error(err) });
+
+import { ExampleBot } from '../ExampleBot';
+import { InstantMessageEvent } from '../../lib/events/InstantMessageEvent';
+import { ChatSourceType } from '../../lib/enums/ChatSourceType';
+import { InstantMessageEventFlags } from '../../lib/enums/InstantMessageEventFlags';
+
+class InstantMessages extends ExampleBot
+{
+    constructor()
+    {
+        super();
+    }
+
+    async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onInstantMessage.subscribe(this.onInstantMessage.bind(this));
+    }
+
+    async onInstantMessage(event: InstantMessageEvent): Promise<void>
+    {
+        if (event.source === ChatSourceType.Agent)
+        {
+            if (!(event.flags & InstantMessageEventFlags.startTyping || event.flags & InstantMessageEventFlags.finishTyping))
+            {
+                // typeInstantMessage will emulate a human-ish typing speed
+                await this.bot.clientCommands.comms.typeInstantMessage(event.from, 'Thanks for the message! This account is a scripted agent (bot), so cannot reply to your query. Sorry!');
+
+                // sendInstantMessage will send it instantly
+                await this.bot.clientCommands.comms.sendInstantMessage(event.from, 'Of course I still love you!');
+            }
+        }
+    }
+}
+
+new InstantMessages().run().then(() =>
+{
+
+}).catch((err: Error) =>
+{
+    console.error(err);
+});

package/examples/Inventory/Inventory.ts

@@ -1,150 +1,156 @@
-import { ExampleBot } from '../ExampleBot';
-import { InventoryFolder } from '../../lib/classes/InventoryFolder';
-import { FolderType } from '../../lib/enums/FolderType';
-import { InventoryItem } from '../../lib/classes/InventoryItem';
-import { LLLindenText } from '../../lib/classes/LLLindenText';
-import { AssetType } from '../../lib/enums/AssetType';
-import { InventoryType } from '../../lib/enums/InventoryType';
-import { PermissionMask } from '../../lib/enums/PermissionMask';
-import { InventoryResponseEvent } from '../../lib/events/InventoryResponseEvent';
-import { InventoryOfferedEvent } from '../../lib/events/InventoryOfferedEvent';
-
-class Inventory extends ExampleBot
-{
-    async onConnected(): Promise<void>
-    {
-        this.bot.clientEvents.onInventoryOffered.subscribe(this.onInventoryOffered.bind(this));
-        this.bot.clientEvents.onInventoryResponse.subscribe(this.onInventoryResponse.bind(this));
-
-        // Get the root inventory folder
-        const rootFolder = this.bot.clientCommands.inventory.getInventoryRoot();
-
-        // Populate the root folder
-        await rootFolder.populate(false);
-
-        const exampleFolderName = 'node-metaverse example';
-        const exampleNotecardName = 'Example Notecard';
-        const exampleScriptName = 'Example script';
-
-        let exampleFolder: InventoryFolder | undefined = undefined;
-        for (const childFolder of rootFolder.folders)
-        {
-            if (childFolder.name === exampleFolderName)
-            {
-                exampleFolder = childFolder;
-                await exampleFolder.populate(false);
-                break;
-            }
-        }
-
-        // Our folder doesnt' seem to exist, so create it
-        if (exampleFolder === undefined)
-        {
-            exampleFolder = await rootFolder.createFolder(exampleFolderName, FolderType.None);
-        }
-
-        // See if we've already made our test notecard to avoid clutter..
-        let exampleNotecard: InventoryItem | undefined = undefined;
-        for (const childItem of exampleFolder.items)
-        {
-            if (childItem.name === exampleNotecardName)
-            {
-                exampleNotecard = childItem;
-                break;
-            }
-        }
-
-        // Create the notecard
-        if (exampleNotecard === undefined)
-        {
-            const notecard = new LLLindenText();
-            notecard.body = 'This is a notecard I made all by myself at ' + new Date().toString();
-            exampleNotecard = await exampleFolder.uploadAsset(AssetType.Notecard, InventoryType.Notecard, notecard.toAsset(), exampleNotecardName, 'This is an example notecard');
-        }
-
-        // Set notecard to transfer only
-
-        exampleNotecard.permissions.nextOwnerMask = PermissionMask.Transfer | PermissionMask.Modify;
-        await exampleNotecard.update();
-
-        let exampleScript = exampleFolder.items.find(f => f.name === exampleScriptName);
-        if (exampleScript === undefined)
-        {
-            exampleScript = await exampleFolder.uploadAsset(
-                AssetType.LSLText,
-                InventoryType.LSL,
-                Buffer.from(
-                    'default { touch_start(integer total_number) {  llSay(0, "Hello, world!"); } } '
-                    , 'utf-8'
-                ),
-                'Script',
-                ''
-            );
-        }
-
-        // Give the notecard to our owner
-        await this.bot.clientCommands.comms.giveInventory(this.masterAvatar, exampleNotecard);
-
-        // Enumerate library
-        const folders = this.bot.clientCommands.inventory.getLibraryRoot().getChildFolders();
-        for (const folder of folders)
-        {
-            await this.iterateFolder(folder, '[ROOT]');
-        }
-        console.log('Done iterating through library');
-    }
-
-    async onInventoryResponse(response: InventoryResponseEvent): Promise<void>
-    {
-        if (response.accepted)
-        {
-            console.log(response.fromName + ' accepted your inventory offer');
-        }
-        else
-        {
-            console.log(response.fromName + ' declined your inventory offer');
-        }
-    }
-
-    async iterateFolder(folder: InventoryFolder, prefix: string): Promise<void>
-    {
-        console.log(prefix + ' [' + folder.name + ']');
-        await folder.populate(false);
-
-        for (const subFolder of folder.folders)
-        {
-            await this.iterateFolder(subFolder, prefix + ' [' + folder.name + ']');
-        }
-
-        for (const item of folder.items)
-        {
-            console.log(prefix + ' [' + folder.name + ']' + ': ' + item.name);
-
-            if (item.name === 'anim SMOOTH')
-            {
-                // Send this to our master av
-
-            }
-        }
-    }
-
-    async onInventoryOffered(event: InventoryOfferedEvent): Promise<void>
-    {
-        if (event.from.toString() === this.masterAvatar)
-        {
-            console.log('Accepting inventory offer from ' + event.fromName);
-            this.bot.clientCommands.inventory.acceptInventoryOffer(event).then(() =>
-            {
-            });
-        }
-        else
-        {
-            console.log('Rejecting inventory offer from ' + event.fromName);
-            this.bot.clientCommands.inventory.rejectInventoryOffer(event).then(() =>
-            {
-            });
-        }
-    }
-}
-
-new Inventory().run().then(() => {}).catch((err) => { console.error(err) });
+import { ExampleBot } from '../ExampleBot';
+import { InventoryFolder } from '../../lib/classes/InventoryFolder';
+import { FolderType } from '../../lib/enums/FolderType';
+import { InventoryItem } from '../../lib/classes/InventoryItem';
+import { LLLindenText } from '../../lib/classes/LLLindenText';
+import { AssetType } from '../../lib/enums/AssetType';
+import { InventoryType } from '../../lib/enums/InventoryType';
+import { PermissionMask } from '../../lib/enums/PermissionMask';
+import { InventoryResponseEvent } from '../../lib/events/InventoryResponseEvent';
+import { InventoryOfferedEvent } from '../../lib/events/InventoryOfferedEvent';
+
+class Inventory extends ExampleBot
+{
+    async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onInventoryOffered.subscribe(this.onInventoryOffered.bind(this));
+        this.bot.clientEvents.onInventoryResponse.subscribe(this.onInventoryResponse.bind(this));
+
+        // Get the root inventory folder
+        const rootFolder = this.bot.clientCommands.inventory.getInventoryRoot();
+
+        // Populate the root folder
+        await rootFolder.populate(false);
+
+        const exampleFolderName = 'node-metaverse example';
+        const exampleNotecardName = 'Example Notecard';
+        const exampleScriptName = 'Example script';
+
+        let exampleFolder: InventoryFolder | undefined = undefined;
+        for (const childFolder of rootFolder.folders)
+        {
+            if (childFolder.name === exampleFolderName)
+            {
+                exampleFolder = childFolder;
+                await exampleFolder.populate(false);
+                break;
+            }
+        }
+
+        // Our folder doesnt' seem to exist, so create it
+        if (exampleFolder === undefined)
+        {
+            exampleFolder = await rootFolder.createFolder(exampleFolderName, FolderType.None);
+        }
+
+        // See if we've already made our test notecard to avoid clutter..
+        let exampleNotecard: InventoryItem | undefined = undefined;
+        for (const childItem of exampleFolder.items)
+        {
+            if (childItem.name === exampleNotecardName)
+            {
+                exampleNotecard = childItem;
+                break;
+            }
+        }
+
+        // Create the notecard
+        if (exampleNotecard === undefined)
+        {
+            const notecard = new LLLindenText();
+            notecard.body = 'This is a notecard I made all by myself at ' + new Date().toString();
+            exampleNotecard = await exampleFolder.uploadAsset(AssetType.Notecard, InventoryType.Notecard, notecard.toAsset(), exampleNotecardName, 'This is an example notecard');
+        }
+
+        // Set notecard to transfer only
+
+        exampleNotecard.permissions.nextOwnerMask = PermissionMask.Transfer | PermissionMask.Modify;
+        await exampleNotecard.update();
+
+        let exampleScript = exampleFolder.items.find(f => f.name === exampleScriptName);
+        if (exampleScript === undefined)
+        {
+            exampleScript = await exampleFolder.uploadAsset(
+                AssetType.LSLText,
+                InventoryType.LSL,
+                Buffer.from(
+                    'default { touch_start(integer total_number) {  llSay(0, "Hello, world!"); } } '
+                    , 'utf-8'
+                ),
+                'Script',
+                ''
+            );
+        }
+
+        // Give the notecard to our owner
+        await this.bot.clientCommands.comms.giveInventory(this.masterAvatar, exampleNotecard);
+
+        // Enumerate library
+        const folders = this.bot.clientCommands.inventory.getLibraryRoot().getChildFolders();
+        for (const folder of folders)
+        {
+            await this.iterateFolder(folder, '[ROOT]');
+        }
+        console.log('Done iterating through library');
+    }
+
+    async onInventoryResponse(response: InventoryResponseEvent): Promise<void>
+    {
+        if (response.accepted)
+        {
+            console.log(response.fromName + ' accepted your inventory offer');
+        }
+        else
+        {
+            console.log(response.fromName + ' declined your inventory offer');
+        }
+    }
+
+    async iterateFolder(folder: InventoryFolder, prefix: string): Promise<void>
+    {
+        console.log(prefix + ' [' + folder.name + ']');
+        await folder.populate(false);
+
+        for (const subFolder of folder.folders)
+        {
+            await this.iterateFolder(subFolder, prefix + ' [' + folder.name + ']');
+        }
+
+        for (const item of folder.items)
+        {
+            console.log(prefix + ' [' + folder.name + ']' + ': ' + item.name);
+
+            if (item.name === 'anim SMOOTH')
+            {
+                // Send this to our master av
+
+            }
+        }
+    }
+
+    async onInventoryOffered(event: InventoryOfferedEvent): Promise<void>
+    {
+        if (event.from.toString() === this.masterAvatar)
+        {
+            console.log('Accepting inventory offer from ' + event.fromName);
+            this.bot.clientCommands.inventory.acceptInventoryOffer(event).then(() =>
+            {
+            });
+        }
+        else
+        {
+            console.log('Rejecting inventory offer from ' + event.fromName);
+            this.bot.clientCommands.inventory.rejectInventoryOffer(event).then(() =>
+            {
+            });
+        }
+    }
+}
+
+new Inventory().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});