@caspertech/node-metaverse 0.5.40 → 0.6.0-beta.1

package/examples/InstantMessages/InstantMessages.ts

@@ -1,35 +0,0 @@
-
-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) });

package/examples/Inventory/Inventory.ts

@@ -1,150 +0,0 @@
-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) });

package/examples/MFA/MFA.ts

@@ -1,55 +0,0 @@
-import { Logger } from '../../lib/classes/Logger';
-import { LoginError } from '../../lib/classes/LoginError';
-import { ExampleBot } from '../ExampleBot';
-import * as readline from 'readline';
-import * as fs from 'fs';
-
-class MFA extends ExampleBot
-{
-    public async login(): Promise<void>
-    {
-        try
-        {
-            await super.login();
-        }
-        catch (e: unknown)
-        {
-            if (e instanceof LoginError)
-            {
-                if (e.reason === 'mfa_challenge')
-                {
-                    const rl = readline.createInterface({
-                        input: process.stdin,
-                        output: process.stdout
-                    });
-                    rl.question('Please enter authenticator code for ' + String(this.firstName) + ' ' + String(this.lastName) + '\n# ', (code) =>
-                    {
-                        this.bot.loginParameters.token = code;
-                        void this.login();
-                    });
-                    return;
-                }
-            }
-            Logger.Error(e);
-        }
-    }
-
-    public async onConnected(): Promise<void>
-    {
-        if (this.loginResponse && this.loginResponse.mfaHash)
-        {
-            // Store MFA hash in our login credentials for next time
-            this.loginParameters.mfa_hash = this.loginResponse.mfaHash;
-            delete this.loginParameters.token;
-            await fs.promises.writeFile(this.loginParamsJsonFile, JSON.stringify(this.loginParameters, null, 4));
-        }
-    }
-}
-
-new MFA().run().then(() =>
-{
-
-}).catch((err) =>
-{
-    console.error(err);
-});

package/examples/Money/Money.ts

@@ -1,57 +0,0 @@
-import { ExampleBot } from '../ExampleBot';
-import { BalanceUpdatedEvent } from '../../lib/events/BalanceUpdatedEvent';
-import { AvatarQueryResult } from '../../lib/classes/public/AvatarQueryResult';
-import { MoneyTransactionType } from '../../lib/enums/MoneyTransactionType';
-
-class Money extends ExampleBot
-{
-    private balance = 0;
-
-    async onConnected()
-    {
-        this.bot.clientEvents.onBalanceUpdated.subscribe(this.onBalanceUpdated.bind(this));
-        try
-        {
-            this.balance = await this.bot.clientCommands.grid.getBalance();
-            console.log('Balance is L$' + this.balance);
-            await this.bot.clientCommands.grid.payAvatar('d1cd5b71-6209-4595-9bf0-771bf689ce00', 1, 'This is a gift for being so awesome!');
-            console.log('Payment success');
-        }
-        catch (error)
-        {
-            console.log('Payment failed');
-        }
-    }
-
-    async onBalanceUpdated(evt: BalanceUpdatedEvent)
-    {
-        this.balance = evt.balance;
-        if (evt.transaction.from.equals(this.bot.agentID()))
-        {
-            if (evt.transaction.toGroup)
-            {
-                console.log('You paid a group L$' + evt.transaction.amount);
-            }
-            else
-            {
-                const result = await this.bot.clientCommands.grid.avatarKey2Name(evt.transaction.to) as AvatarQueryResult;
-                console.log('You paid L$' + evt.transaction.amount + ' to ' + result.getName()+ ' "' + evt.transaction.description + '" (' + MoneyTransactionType[evt.transaction.type] + ')');
-            }
-        }
-        else
-        {
-            if (evt.transaction.fromGroup)
-            {
-                console.log('A group paid you L$' + evt.transaction.amount);
-            }
-            else
-            {
-                const result = await this.bot.clientCommands.grid.avatarKey2Name(evt.transaction.from) as AvatarQueryResult;
-                console.log(result.getName() + ' paid you L$' + evt.transaction.amount + ' "' + evt.transaction.description + '" (' + MoneyTransactionType[evt.transaction.type] + ')');
-            }
-        }
-        console.log('Balance updated (New balance L$' + evt.balance + ')');
-    }
-}
-
-new Money().run().then(() => {}).catch((err) => { console.error(err) });

package/examples/Region/Agents.ts

@@ -1,81 +0,0 @@
-import { ExampleBot } from '../ExampleBot';
-import { Avatar } from '../../lib/classes/public/Avatar';
-import { Subscription } from 'rxjs';
-
-class Region extends ExampleBot
-{
-    private subscriptions: { [key: string]: {
-        onMovedSubscription: Subscription;
-        onTitleSubscription: Subscription;
-        onLeftRegionSubscription: Subscription;
-        onVisibleSubscription: Subscription;
-    } } = {};
-
-    public async onConnected(): Promise<void>
-    {
-        this.bot.clientEvents.onAvatarEnteredRegion.subscribe(this.onAvatarEntered.bind(this));
-
-        const avs = this.bot.clientCommands.region.getAvatarsInRegion();
-        for (const av of avs)
-        {
-            this.onAvatarEntered(av);
-        }
-    }
-
-    private onAvatarEntered(av: Avatar): void
-    {
-        console.log(av.getName() + ' entered the region (' + ((av.isVisible) ? 'visible' : 'invisible') + ')');
-        const avatarKey = av.getKey().toString();
-        this.unsubscribe(avatarKey);
-        this.subscriptions[avatarKey] = {
-            onLeftRegionSubscription: av.onLeftRegion.subscribe(this.onAvatarLeft.bind(this)),
-            onMovedSubscription: av.onMoved.subscribe(this.onAvatarMoved.bind(this)),
-            onTitleSubscription: av.onTitleChanged.subscribe(this.onTitleChanged.bind(this)),
-            onVisibleSubscription: av.onVisibleChanged.subscribe(this.onAvatarVisible.bind(this))
-        }
-    }
-
-    private unsubscribe(key: string): void
-    {
-        const sub = this.subscriptions[key];
-        if (sub === undefined)
-        {
-            return;
-        }
-        delete this.subscriptions[key];
-
-        sub.onVisibleSubscription.unsubscribe();
-        sub.onMovedSubscription.unsubscribe();
-        sub.onTitleSubscription.unsubscribe();
-        sub.onLeftRegionSubscription.unsubscribe();
-    }
-
-    private onAvatarLeft(av: Avatar): void
-    {
-        console.log(av.getName() + ' left the region');
-        this.unsubscribe(av.getKey().toString());
-    }
-
-    private onAvatarMoved(av: Avatar): void
-    {
-        console.log(av.getName() + ' moved, position: ' + av.position.toString());
-    }
-
-    private onTitleChanged(av: Avatar): void
-    {
-        console.log(av.getName() + ' changed their title to: ' + av.getTitle());
-    }
-
-    private onAvatarVisible(av: Avatar): void
-    {
-        console.log(av.getName() + ' is now ' + (av.isVisible ? 'visible' : 'invisible'));
-    }
-}
-
-new Region().run().then(() =>
-{
-
-}).catch((err) =>
-{
-    console.error(err);
-});

package/examples/Region/Estate.ts

@@ -1,28 +0,0 @@
-import { ExampleBot } from '../ExampleBot';
-
-class Estate extends ExampleBot
-{
-    wait(ms: number): Promise<void>
-    {
-        return new Promise<void>((resolve) =>
-        {
-            setTimeout(() =>
-            {
-                resolve();
-            }, ms)
-        });
-    }
-    async onConnected(): Promise<void>
-    {
-        console.log('Sending a message');
-        await this.bot.clientCommands.region.simulatorMessage('In about 10 seconds, the region will begin to restart. This is only a test, and the restart will be cancelled.');
-        await this.wait(10000);
-        console.log('Restarting');
-        await this.bot.clientCommands.region.restartRegion(120);
-        await this.wait(10000);
-        console.log('Canceling restart');
-        await this.bot.clientCommands.region.cancelRestart();
-    }
-}
-
-new Estate().run().then(() => {}).catch((err) => { console.error(err) });

package/examples/Region/Parcels.ts

@@ -1,25 +0,0 @@
-import { ExampleBot } from '../ExampleBot';
-import { LandStatReportType } from '../../lib/enums/LandStatReportType';
-import { LandStatFlags } from '../../lib/enums/LandStatFlags';
-
-class Parcels extends ExampleBot
-{
-    async onConnected()
-    {
-        const parcelInMiddle = await this.bot.clientCommands.region.getParcelAt(128, 128);
-        console.log('Parcel at 128x128 is ' + parcelInMiddle.Name);
-
-        const parcels = await this.bot.clientCommands.region.getParcels();
-        console.log('Parcels on region:');
-        console.log('========================');
-        for (const p of parcels)
-        {
-            console.log(p.Name);
-        }
-        console.log('========================');
-        const stats = await this.bot.clientCommands.parcel.getLandStats(parcels[0].ParcelID, LandStatReportType.Scripts, LandStatFlags.FilterByOwner);
-        console.log(JSON.stringify(stats, null, 4));
-    }
-}
-
-new Parcels().run().then(() => {}).catch((err) => { console.error(err) });

package/examples/Region/Region.ts

@@ -1,17 +0,0 @@
-import { ExampleBot } from '../ExampleBot';
-import { SimStatsEvent } from '../../lib/events/SimStatsEvent';
-
-class Region extends ExampleBot
-{
-    async onConnected()
-    {
-        this.bot.clientEvents.onSimStats.subscribe(this.onSimStats.bind(this));
-    }
-
-    onSimStats(stats: SimStatsEvent)
-    {
-        console.log(JSON.stringify(stats, null, 4));
-    }
-}
-
-new Region().run().then(() => {}).catch((err) => { console.error(err) });

package/examples/Teleports/Teleports.ts

@@ -1,60 +0,0 @@
-import { LureEvent, Vector3 } from '../../lib';
-import { ExampleBot } from '../ExampleBot';
-
-class Teleports extends ExampleBot
-{
-    // We can make the bot always try to get to a certain region regardless of where it logged in
-    protected stayRegion = 'Izanagi';
-
-    // And we can optionally specify a position
-    protected stayPosition = new Vector3([122, 156, 189]);
-
-    async onConnected(): Promise<void>
-    {
-        // "OnLure" event fires when someone tries to teleport us
-        this.bot.clientEvents.onLure.subscribe(this.onLure.bind(this));
-
-        // Alternatively we can TP someone else to us
-        await this.bot.clientCommands.comms.sendTeleport(this.masterAvatar);
-    }
-
-    async onLure(lureEvent: LureEvent): Promise<void>
-    {
-        try
-        {
-            const regionInfo = await this.bot.clientCommands.grid.getRegionMapInfo(lureEvent.gridX / 256, lureEvent.gridY / 256);
-            if (lureEvent.from.toString() === this.masterAvatar)
-            {
-                console.log('Accepting teleport lure to ' + regionInfo.block.name + ' (' + regionInfo.avatars.length + ' avatar' + ((regionInfo.avatars.length === 1) ? '' : 's') + '' +
-                    ' present) from ' + lureEvent.fromName + ' with message: ' + lureEvent.lureMessage);
-                try
-                {
-                    await this.bot.clientCommands.teleport.acceptTeleport(lureEvent);
-                }
-                catch (error)
-                {
-                    console.error('Teleport error:');
-                    console.error(error);
-                }
-            }
-            else
-            {
-                console.log('Ignoring teleport lure to ' + regionInfo.block.name + ' (' + regionInfo.avatars.length + ' avatar' + ((regionInfo.avatars.length === 1) ? '' : 's') + ' ' +
-                    'present) from ' + lureEvent.fromName + ' with message: ' + lureEvent.lureMessage);
-            }
-        }
-        catch (error)
-        {
-            console.error('Failed to get region map info:');
-            console.error(error);
-        }
-    }
-}
-
-new Teleports().run().then(() =>
-{
-
-}).catch((err) =>
-{
-    console.error(err)
-});

package/examples/loginParameters.example.json

@@ -1,7 +0,0 @@
-{
-  "firstName": "Username",
-  "lastName": "Resident",
-  "password": "YourPassword",
-  "start": "last", //first, last, or login uri like uri:<existing region name>&<x>&<y>&<z>
-  "url": "https://login.agni.lindenlab.com/cgi-bin/login.cgi"
-}