@caspertech/node-metaverse 0.7.24 → 0.7.26

package/examples/ExampleBot.ts

@@ -1,178 +1,178 @@
-import { Vector3 } from '../lib';
-import { LoginResponse } from '../lib/classes/LoginResponse';
-import { Bot } from '../lib/Bot';
-import { LoginParameters } from '../lib/classes/LoginParameters';
-import { BotOptionFlags } from '../lib/enums/BotOptionFlags';
-
-import * as path from 'path';
-
-import Signals = NodeJS.Signals;
-import Timeout = NodeJS.Timeout;
-
-export class ExampleBot
-{
-    protected masterAvatar = 'd1cd5b71-6209-4595-9bf0-771bf689ce00';
-    protected isConnected = false;
-    protected isConnecting = false;
-    protected loginParamsJsonFile: string;
-    protected loginResponse?: LoginResponse;
-    protected bot: Bot;
-    private reconnectTimer?: Timeout;
-    protected loginParameters: LoginParameters;
-
-    protected stayRegion?: string;
-    protected stayPosition?: Vector3;
-    protected firstName?: string;
-    protected lastName?: string;
-
-    constructor()
-    {
-        this.loginParamsJsonFile = path.join(__dirname, '..', '..', 'examples', 'loginParameters.json');
-        this.loginParameters = require(this.loginParamsJsonFile);
-        this.firstName = this.loginParameters.firstName;
-        this.lastName = this.loginParameters.lastName;
-
-        // If you don't intend to use the object store (i.e you have no interest in inworld objects, textures, etc,
-        // using nmv.BotOptionFlags.LiteObjectStore will drastically reduce the footprint and CPU usage.
-        //
-        // The full object store has a full searchable rtree index, the lite does not.
-        //
-        // For the minimum footprint, use :
-        //
-        // const options = nmv.BotOptionFlags.LiteObjectStore | nmv.BotOptionFlags.StoreMyAttachmentsOnly;
-
-        const options = BotOptionFlags.None;
-
-        this.bot = new Bot(this.loginParameters, options);
-    }
-
-    public async run(): Promise<void>
-    {
-        const exitHandler = async(options: { exit?: boolean }, err: Error | number | Signals) =>
-        {
-            if (err && err instanceof Error)
-            {
-                console.log(err.stack);
-            }
-            if (this.isConnected)
-            {
-                console.log('Disconnecting');
-                try
-                {
-                    await this.bot.close();
-                }
-                catch (error)
-                {
-                    console.error('Error when closing client:');
-                    console.error(error);
-                }
-                process.exit();
-                return;
-            }
-            if (options.exit)
-            {
-                process.exit();
-            }
-        }
-
-
-
-        // Do something when app is closing
-        process.on('exit', exitHandler.bind(this, {}));
-
-        // Catches ctrl+c event
-        process.on('SIGINT', exitHandler.bind(this, { exit: true }));
-
-        // Catches "kill pid"
-        process.on('SIGUSR1', exitHandler.bind(this, { exit: true }));
-        process.on('SIGUSR2', exitHandler.bind(this, { exit: true }));
-
-        // Catches uncaught exceptions
-        process.on('uncaughtException', exitHandler.bind(this, { exit: true }));
-
-        // This will tell the bot to keep trying to teleport back to the 'stay' location.
-        // You can specify a region and position, such as:
-        // bot.stayPut(true, 'Izanagi', new nmv.Vector3([128, 128, 21]));
-        // Note that the 'stay' location will be updated if you request or accept a lure (a teleport).
-        // If no region is specified, it will be set to the region you log in to.
-        this.bot.stayPut(true, this.stayRegion, this.stayPosition);
-
-        await this.login();
-    }
-
-    protected async onConnected(): Promise<void>
-    {
-
-    }
-
-    protected async login(): Promise<void>
-    {
-        if (this.isConnecting)
-        {
-            return;
-        }
-        this.isConnecting = true;
-        try
-        {
-            if (this.reconnectTimer !== undefined)
-            {
-                clearInterval(this.reconnectTimer);
-            }
-            this.reconnectTimer = setInterval(this.reconnectCheck.bind(this), 60000);
-
-            console.log('Logging in..');
-            this.loginResponse = await this.bot.login();
-
-            console.log('Login complete');
-
-            // Establish circuit with region
-            await this.bot.connectToSim();
-
-            console.log('Waiting for event queue');
-            await this.bot.waitForEventQueue();
-
-            this.isConnected = true;
-        }
-        finally
-        {
-            this.isConnecting = false;
-        }
-        return this.connected();
-    }
-
-    private async reconnectCheck(): Promise<void>
-    {
-        if (!this.isConnected)
-        {
-            await this.login();
-        }
-    }
-
-    private async connected(): Promise<void>
-    {
-        this.bot.clientEvents.onDisconnected.subscribe((event) =>
-        {
-            if (event.requested)
-            {
-                if (this.reconnectTimer !== undefined)
-                {
-                    clearInterval(this.reconnectTimer);
-                }
-            }
-            this.isConnected = false;
-            console.log('Disconnected from simulator: ' + event.message);
-        });
-        await this.onConnected();
-    }
-
-    // @ts-ignore
-    private async close(): Promise<void>
-    {
-        if (this.reconnectTimer !== undefined)
-        {
-            clearInterval(this.reconnectTimer);
-            this.reconnectTimer = undefined;
-        }
-        return this.bot.close();
-    }
-}
+import { Vector3 } from '../lib';
+import { LoginResponse } from '../lib/classes/LoginResponse';
+import { Bot } from '../lib/Bot';
+import { LoginParameters } from '../lib/classes/LoginParameters';
+import { BotOptionFlags } from '../lib/enums/BotOptionFlags';
+
+import * as path from 'path';
+
+import Signals = NodeJS.Signals;
+import Timeout = NodeJS.Timeout;
+
+export class ExampleBot
+{
+    protected masterAvatar = 'd1cd5b71-6209-4595-9bf0-771bf689ce00';
+    protected isConnected = false;
+    protected isConnecting = false;
+    protected loginParamsJsonFile: string;
+    protected loginResponse?: LoginResponse;
+    protected bot: Bot;
+    private reconnectTimer?: Timeout;
+    protected loginParameters: LoginParameters;
+
+    protected stayRegion?: string;
+    protected stayPosition?: Vector3;
+    protected firstName?: string;
+    protected lastName?: string;
+
+    constructor()
+    {
+        this.loginParamsJsonFile = path.join(__dirname, '..', '..', 'examples', 'loginParameters.json');
+        this.loginParameters = require(this.loginParamsJsonFile);
+        this.firstName = this.loginParameters.firstName;
+        this.lastName = this.loginParameters.lastName;
+
+        // If you don't intend to use the object store (i.e you have no interest in inworld objects, textures, etc,
+        // using nmv.BotOptionFlags.LiteObjectStore will drastically reduce the footprint and CPU usage.
+        //
+        // The full object store has a full searchable rtree index, the lite does not.
+        //
+        // For the minimum footprint, use :
+        //
+        // const options = nmv.BotOptionFlags.LiteObjectStore | nmv.BotOptionFlags.StoreMyAttachmentsOnly;
+
+        const options = BotOptionFlags.None;
+
+        this.bot = new Bot(this.loginParameters, options);
+    }
+
+    public async run(): Promise<void>
+    {
+        const exitHandler = async(options: { exit?: boolean }, err: Error | number | Signals) =>
+        {
+            if (err && err instanceof Error)
+            {
+                console.log(err.stack);
+            }
+            if (this.isConnected)
+            {
+                console.log('Disconnecting');
+                try
+                {
+                    await this.bot.close();
+                }
+                catch (error)
+                {
+                    console.error('Error when closing client:');
+                    console.error(error);
+                }
+                process.exit();
+                return;
+            }
+            if (options.exit)
+            {
+                process.exit();
+            }
+        }
+
+
+
+        // Do something when app is closing
+        process.on('exit', exitHandler.bind(this, {}));
+
+        // Catches ctrl+c event
+        process.on('SIGINT', exitHandler.bind(this, { exit: true }));
+
+        // Catches "kill pid"
+        process.on('SIGUSR1', exitHandler.bind(this, { exit: true }));
+        process.on('SIGUSR2', exitHandler.bind(this, { exit: true }));
+
+        // Catches uncaught exceptions
+        process.on('uncaughtException', exitHandler.bind(this, { exit: true }));
+
+        // This will tell the bot to keep trying to teleport back to the 'stay' location.
+        // You can specify a region and position, such as:
+        // bot.stayPut(true, 'Izanagi', new nmv.Vector3([128, 128, 21]));
+        // Note that the 'stay' location will be updated if you request or accept a lure (a teleport).
+        // If no region is specified, it will be set to the region you log in to.
+        this.bot.stayPut(true, this.stayRegion, this.stayPosition);
+
+        await this.login();
+    }
+
+    protected async onConnected(): Promise<void>
+    {
+
+    }
+
+    protected async login(): Promise<void>
+    {
+        if (this.isConnecting)
+        {
+            return;
+        }
+        this.isConnecting = true;
+        try
+        {
+            if (this.reconnectTimer !== undefined)
+            {
+                clearInterval(this.reconnectTimer);
+            }
+            this.reconnectTimer = setInterval(this.reconnectCheck.bind(this), 60000);
+
+            console.log('Logging in..');
+            this.loginResponse = await this.bot.login();
+
+            console.log('Login complete');
+
+            // Establish circuit with region
+            await this.bot.connectToSim();
+
+            console.log('Waiting for event queue');
+            await this.bot.waitForEventQueue();
+
+            this.isConnected = true;
+        }
+        finally
+        {
+            this.isConnecting = false;
+        }
+        return this.connected();
+    }
+
+    private async reconnectCheck(): Promise<void>
+    {
+        if (!this.isConnected)
+        {
+            await this.login();
+        }
+    }
+
+    private async connected(): Promise<void>
+    {
+        this.bot.clientEvents.onDisconnected.subscribe((event) =>
+        {
+            if (event.requested)
+            {
+                if (this.reconnectTimer !== undefined)
+                {
+                    clearInterval(this.reconnectTimer);
+                }
+            }
+            this.isConnected = false;
+            console.log('Disconnected from simulator: ' + event.message);
+        });
+        await this.onConnected();
+    }
+
+    // @ts-ignore
+    private async close(): Promise<void>
+    {
+        if (this.reconnectTimer !== undefined)
+        {
+            clearInterval(this.reconnectTimer);
+            this.reconnectTimer = undefined;
+        }
+        return this.bot.close();
+    }
+}

package/examples/Friends/Friends.ts

@@ -1,67 +1,67 @@
-import { ExampleBot } from '../ExampleBot';
-import { FriendRequestEvent } from '../../lib/events/FriendRequestEvent';
-import { FriendResponseEvent } from '../../lib/events/FriendResponseEvent';
-
-class Friends extends ExampleBot
-{
-    async onConnected(): Promise<void>
-    {
-        this.bot.clientEvents.onFriendRequest.subscribe(this.onFriendRequest.bind(this));
-        this.bot.clientEvents.onFriendResponse.subscribe(this.onFriendResponse.bind(this));
-
-        this.bot.clientCommands.friends.sendFriendRequest(this.masterAvatar, 'Be friends with me?').then(() =>
-        {
-
-        });
-
-        try
-        {
-            // Get map location of the master avatar. Will fail if you don't have map rights
-            const regionLocation = await this.bot.clientCommands.friends.getFriendMapLocation(this.masterAvatar);
-            console.log('Master is in ' + regionLocation.regionName + ' at <' + regionLocation.localX + ', ' + regionLocation.localY + '> and there are ' + regionLocation.avatars.length + ' other avatars there too! You stalker!');
-        }
-        catch (error)
-        {
-            console.log('Map location request failed. The bot probably does not have map rights on the master avatar, or they are offline.');
-        }
-    }
-
-    async onFriendRequest(event: FriendRequestEvent): Promise<void>
-    {
-        if (event.from.toString() === this.masterAvatar)
-        {
-            console.log('Accepting friend request from ' + event.fromName);
-            this.bot.clientCommands.friends.acceptFriendRequest(event).then(() =>
-            {
-            });
-        }
-        else
-        {
-            console.log('Rejecting friend request from ' + event.fromName);
-            this.bot.clientCommands.friends.rejectFriendRequest(event).then(() =>
-            {
-            });
-        }
-    }
-
-    async onFriendResponse(response: FriendResponseEvent): Promise<void>
-    {
-        if (response.accepted)
-        {
-            console.log(response.fromName + ' accepted your friend request');
-        }
-        else
-        {
-            console.log(response.fromName + ' declined your friend request');
-        }
-    }
-
-}
-
-new Friends().run().then(() =>
-{
-
-}).catch((err) =>
-{
-    console.error(err);
-});
+import { ExampleBot } from '../ExampleBot';
+import { FriendRequestEvent } from '../../lib/events/FriendRequestEvent';
+import { FriendResponseEvent } from '../../lib/events/FriendResponseEvent';
+
+class Friends extends ExampleBot
+{
+    async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onFriendRequest.subscribe(this.onFriendRequest.bind(this));
+        this.bot.clientEvents.onFriendResponse.subscribe(this.onFriendResponse.bind(this));
+
+        this.bot.clientCommands.friends.sendFriendRequest(this.masterAvatar, 'Be friends with me?').then(() =>
+        {
+
+        });
+
+        try
+        {
+            // Get map location of the master avatar. Will fail if you don't have map rights
+            const regionLocation = await this.bot.clientCommands.friends.getFriendMapLocation(this.masterAvatar);
+            console.log('Master is in ' + regionLocation.regionName + ' at <' + regionLocation.localX + ', ' + regionLocation.localY + '> and there are ' + regionLocation.avatars.length + ' other avatars there too! You stalker!');
+        }
+        catch (error)
+        {
+            console.log('Map location request failed. The bot probably does not have map rights on the master avatar, or they are offline.');
+        }
+    }
+
+    async onFriendRequest(event: FriendRequestEvent): Promise<void>
+    {
+        if (event.from.toString() === this.masterAvatar)
+        {
+            console.log('Accepting friend request from ' + event.fromName);
+            this.bot.clientCommands.friends.acceptFriendRequest(event).then(() =>
+            {
+            });
+        }
+        else
+        {
+            console.log('Rejecting friend request from ' + event.fromName);
+            this.bot.clientCommands.friends.rejectFriendRequest(event).then(() =>
+            {
+            });
+        }
+    }
+
+    async onFriendResponse(response: FriendResponseEvent): Promise<void>
+    {
+        if (response.accepted)
+        {
+            console.log(response.fromName + ' accepted your friend request');
+        }
+        else
+        {
+            console.log(response.fromName + ' declined your friend request');
+        }
+    }
+
+}
+
+new Friends().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});

package/examples/Grid/Name2Key.ts

@@ -1,50 +1,50 @@
-import { ExampleBot } from '../ExampleBot';
-
-class Name2Key extends ExampleBot
-{
-    async onConnected(): Promise<void>
-    {
-        const test1 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp');
-        if (test1.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test1.avatarName === 'CasperHelp Resident')
-        {
-            console.log('Test 1 passed');
-        }
-        const test2 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp resident');
-        if (test2.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test2.avatarName === 'CasperHelp Resident')
-        {
-            console.log('Test 2 passed');
-        }
-
-        const test3 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp.resident');
-        if (test3.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test3.avatarName === 'CasperHelp Resident')
-        {
-            console.log('Test 3 passed');
-        }
-
-        const test4 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp', false);
-        if (test4.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test4.avatarName === 'CasperHelp Resident')
-        {
-            console.log('Test 4 passed');
-        }
-
-        const test5 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp resident', false);
-        if (test5.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test5.avatarName === 'CasperHelp Resident')
-        {
-            console.log('Test 5 passed');
-        }
-
-        const test6 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp.resident', false);
-        if (test6.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test6.avatarName === 'CasperHelp Resident')
-        {
-            console.log('Test 6 passed');
-        }
-    }
-}
-
-new Name2Key().run().then(() =>
-{
-
-}).catch((err) =>
-{
-    console.error(err);
-});
+import { ExampleBot } from '../ExampleBot';
+
+class Name2Key extends ExampleBot
+{
+    async onConnected(): Promise<void>
+    {
+        const test1 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp');
+        if (test1.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test1.avatarName === 'CasperHelp Resident')
+        {
+            console.log('Test 1 passed');
+        }
+        const test2 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp resident');
+        if (test2.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test2.avatarName === 'CasperHelp Resident')
+        {
+            console.log('Test 2 passed');
+        }
+
+        const test3 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp.resident');
+        if (test3.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test3.avatarName === 'CasperHelp Resident')
+        {
+            console.log('Test 3 passed');
+        }
+
+        const test4 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp', false);
+        if (test4.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test4.avatarName === 'CasperHelp Resident')
+        {
+            console.log('Test 4 passed');
+        }
+
+        const test5 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp resident', false);
+        if (test5.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test5.avatarName === 'CasperHelp Resident')
+        {
+            console.log('Test 5 passed');
+        }
+
+        const test6 = await this.bot.clientCommands.grid.avatarName2KeyAndName('casperhelp.resident', false);
+        if (test6.avatarKey.toString() === '828f7198-42e5-41b4-bd60-926a33ea067b' && test6.avatarName === 'CasperHelp Resident')
+        {
+            console.log('Test 6 passed');
+        }
+    }
+}
+
+new Name2Key().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});