Simple greeter bot - Revision history

Edwin: Fix code to work with newer SDK

2021-07-30T22:12:26Z

Fix code to work with newer SDK

← Older revision		Revision as of 22:12, 30 July 2021
Line 27:		Line 27:
	}		}

	sdk = vp_create();		sdk = vp_create(NULL);

	if(err = vp_connect_universe(sdk, "universe.virtualparadise.org", 57000))		if(err = vp_connect_universe(sdk, "universe.virtualparadise.org", 57000))

Edwin at 12:38, 9 February 2019

2019-02-09T12:38:13Z

← Older revision		Revision as of 12:38, 9 February 2019
Line 113:		Line 113:

	==VB .Net==		==VB .Net==
			Requirements for building and running the code below:
			* VB console application project (at least .NET Framework 4.6.1 or .NET Core 2.0)
			* Reference to the [https://www.nuget.org/packages/vpnet VpNet NuGet package] (version 1.0.9.2960-alpha or later)
			* <code>vpsdk.dll</code> present in the output folder, this can be downloaded from the [https://dev.virtualparadise.org/downloads.php developer downloads page]
	<syntaxhighlight lang="vbnet">		<syntaxhighlight lang="vbnet">
	Imports VpNet		Imports VpNet

Edwin: /* VB .Net */

2019-02-09T12:36:09Z

VB .Net

← Older revision		Revision as of 12:36, 9 February 2019
Line 116:		Line 116:
	Imports VpNet		Imports VpNet

	Module ~~ExampleBot~~		Module Program
	~~Public VPInstance As Instance~~		Sub Main(args As String())
			MainAsync().GetAwaiter().GetResult()
	Sub Main()		End Sub
	~~Try~~
	~~'Initialize the Virtual Paradise~~ .~~Net SDK~~
	~~VPInstance = New Instance~~()

	~~'Register the events you wish to capture~~ (~~Such as avatar entry~~)
	~~'This must be done AFTER the initialization, but before connection~~
	~~AddHandler VPInstance.OnAvatarEnter, AddressOf EventAvatarEnter~~
	~~AddHandler VPInstance.OnAvatarLeave, AddressOf EventAvatarLeave~~

	~~'Connect to the universe using the default server settings~~		Async Function MainAsync() As Task
	~~VPInstance.Connect~~()		Dim instance = New Instance

	'~~Login~~ to ~~the universe using your username, password~~,		' Register the events you wish to capture (such as avatar entry)
	~~'and the desired bot name~~		AddHandler instance.OnAvatarEnter, AddressOf Instance_OnAvatarEnter
	~~VPInstance~~.~~Login("Username"~~, ~~"Password", "MyBotName")~~		AddHandler instance.OnAvatarLeave, AddressOf Instance_OnAvatarLeave

	~~'Enter the world~~		Await instance.ConnectAsync()
	~~VPInstance~~.~~Enter~~("MyWorld")		Await instance.LoginAsync("Username", "Password", "MyBotName")
			Await instance.EnterAsync("MyWorld")

	'~~Set~~ the ~~bot's~~ position in the world		' Announce the position in the world, this allows the bot to receive avatar and chat events
	~~VPInstance~~.UpdateAvatar(0.0F, 0.0F, 0.0F)		instance.UpdateAvatar(0.0F, 0.0F, 0.0F)

	'~~Write success message to the console~~		' Wait forever
	~~Console.WriteLine("Login success!")~~		While True
			Await Task.Delay(System.TimeSpan.FromMilliseconds(Integer.MaxValue))
	~~'In order to process any pending network events and data~~		End While
	~~'we must repeatedly call the~~ Wait~~() function~~		End Function
	~~'Here we use a wait of 50 Miliseconds~~
	While True
	~~VPInstance~~.~~Wait~~(~~50)~~
	~~End While~~

	~~'This allows us to cleanly catch and handle~~
	~~'any errors the SDK throws~~. ~~In normal usage,~~
	~~'you should handle specific errors, and not~~
	~~'use a catch-all like the one below.~~
	~~Catch ex As VpException~~
	~~Console~~.~~WriteLine~~(~~"{0}", ex~~.~~Message~~)
	End ~~Try~~

	~~'This pauses the console on crash, so that~~
	~~'you can review the error thrown by the SDK~~
	~~Console.Read()~~
	End ~~Sub~~

	Private Sub ~~EventAvatarEnter~~(sender As Instance, args As AvatarEnterEventArgsT(Of Avatar(Of Vector3), Vector3))		Private Sub Instance_OnAvatarEnter(sender As Instance, args As AvatarEnterEventArgsT(Of Avatar(Of Vector3), Vector3))
	~~'A user has entered the world (or the bot's range)~~		sender.Say($"Hello {args.Avatar.Name}")
	~~'We print the user's name followed by a brief message~~
	~~VPInstance~~.Say(args.Avatar.Name ~~& " Entered~~")
	End Sub		End Sub

	Private Sub ~~EventAvatarLeave~~(sender As Instance, ~~ByVal~~ args As AvatarLeaveEventArgsT(Of Avatar(Of Vector3), Vector3))		Private Sub Instance_OnAvatarLeave(sender As Instance, args As AvatarLeaveEventArgsT(Of Avatar(Of Vector3), Vector3))
	~~'A user has left the world (or the bot's range)~~		sender.Say($"Goodbye {args.Avatar.Name}")
	~~'We print the user's name followed by a brief message~~
	~~VPInstance~~.Say(args.Avatar.Name ~~& " Left~~")
	End Sub		End Sub
	End Module		End Module

Edwin: /* C# */

2019-02-09T11:37:55Z

← Older revision		Revision as of 11:37, 9 February 2019
Line 65:		Line 65:
	Requirements for building and running the code below:		Requirements for building and running the code below:
	* C# console application project (at least .NET Framework 4.6.1 or .NET Core 2.0)		* C# console application project (at least .NET Framework 4.6.1 or .NET Core 2.0)
	* Reference to the VpNet NuGet package (version 1.0.9.2960-alpha or later)		* Reference to the [https://www.nuget.org/packages/vpnet VpNet NuGet package] (version 1.0.9.2960-alpha or later)
	* <code>vpsdk.dll</code> present in the output folder, this can be downloaded from the [https://dev.virtualparadise.org/downloads.php developer downloads page]		* <code>vpsdk.dll</code> present in the output folder, this can be downloaded from the [https://dev.virtualparadise.org/downloads.php developer downloads page]
	* Language version for your project set to at least C# 7.1 (In Visual Studio: Project Properties ▶ Build ▶ Advanced... ▶ Language Version)		* Language version for your project set to at least C# 7.1 (In Visual Studio: Project Properties ▶ Build ▶ Advanced... ▶ Language Version)

Edwin: /* C# */

2019-02-09T11:35:02Z

← Older revision		Revision as of 11:35, 9 February 2019
Line 63:		Line 63:
	</syntaxhighlight>		</syntaxhighlight>
	==C#==		==C#==
	~~In order to use~~ the ~~Virtual Paradise .Net SDK you must~~:		Requirements for building and running the code below:
	*~~Have Visual Studio or Visual~~ C# ~~Express installed and [[developer environments#CSharp\|configured]]~~		* C# console application project (at least .NET Framework 4.6.1 or .NET Core 2.0)
	*~~Download~~ the .~~Net SDK~~ from the [~~http~~://~~vpnet~~.~~codeplex~~.~~com~~/ ~~VPNet SDK Download~~] ~~page~~		* Reference to the VpNet NuGet package (version 1.0.9.2960-alpha or later)
	*~~The latest~~ version ~~of the native VP x86 SDK, that is supported, is included in the VPNET distribution~~		* <code>vpsdk.dll</code> present in the output folder, this can be downloaded from the [https://dev.virtualparadise.org/downloads.php developer downloads page]
			* Language version for your project set to at least C# 7.1 (In Visual Studio: Project Properties ▶ Build ▶ Advanced... ▶ Language Version)

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
	using System;		using System.Threading.Tasks;
	~~using VpNet~~.~~Core;~~		using VpNet;
	~~using VpNet~~.~~Core.EventData~~;
	using VpNet~~.Core.Structs~~;

	~~class ExampleBot~~		namespace GreeterBot
	{		{
	~~//Virtual Paradise SDK Instance~~		class Program
	~~public static Instance VPInstance;~~

	~~static void Main(string[] args)~~
	{		{
	~~try~~		static async Task Main(string[] args)
	{		{
	~~//Initialize the Virtual Paradise .Net SDK~~		var instance = new Instance();
	~~VPInstance~~ = new Instance~~();~~

	~~//Register the events you wish to capture (Such as avatar entry)~~
	~~//This must be done AFTER the initialization, but before connection~~
	~~VPInstance.EventAvatarAdd += EventAvatarAdd;~~
	~~VPInstance.EventAvatarDelete += EventAvatarDelete;~~

	~~//Connect to the universe using the default server settings~~
	~~VPInstance.Connect~~();

	//~~Login~~ to ~~the universe using your username, password,~~		// Register the events you wish to capture (such as avatar entry)
	~~//and the desired bot name~~		instance.OnAvatarEnter += Instance_OnAvatarEnter;
	~~VPInstance~~.~~Login("Username", "Password", "MyBotName")~~;		instance.OnAvatarLeave += Instance_OnAvatarLeave;

	~~//Enter the world~~		await instance.ConnectAsync();
	~~VPInstance~~.~~Enter~~("MyWorld");		await instance.LoginAsync("Username", "Password", "MyBotName");
			await instance.EnterAsync("MyWorld");

	//~~Set~~ the ~~bot's~~ position in the world		// Announce the position in the world, this allows the bot to receive avatar and chat events
	~~VPInstance~~.UpdateAvatar(0.0f, 0.0f, 0.0f);		instance.UpdateAvatar(0.0f, 0.0f, 0.0f);

	//~~In order to process any pending network events and data~~		// Wait forever
	~~//we must repeatedly call the~~ Wait~~() function~~
	~~//Here we use a wait of 50 Miliseconds~~
	while (true)		while (true)
	{		{
	~~VPInstance~~.~~Wait~~(50);		await Task.Delay(System.TimeSpan.FromMilliseconds(int.MaxValue));
	}		}
	}		}

	~~//This allows us to cleanly catch and handle~~		private static void Instance_OnAvatarEnter(Instance sender, AvatarEnterEventArgsT<Avatar<Vector3>, Vector3> args)
	~~//any errors the SDK throws. In normal usage~~,
	~~//you should handle specific errors~~, ~~and not~~
	~~//use a catch-all like the one below.~~
	~~catch (VpException ex~~)
	{		{
	~~Console~~.~~WriteLine~~("{0}"~~, ex.Message~~);		sender.Say($"Hello {args.Avatar.Name}");
	}		}

	~~//This pauses the console on crash, so that~~		private static void Instance_OnAvatarLeave(Instance sender, AvatarLeaveEventArgsT<Avatar<Vector3>, Vector3> args)
	~~//you can review the error thrown by the SDK~~		{
	~~Console.Read();~~		sender.Say($"Goodbye {args.Avatar.Name}");
	}		}
	static void ~~EventAvatarAdd~~(Instance ~~Sender~~, Avatar ~~AvatarData~~)
	{
	~~//A user has entered the world (or the bot's range)~~
	~~//We print the user's name followed by a brief message~~
	~~VPInstance~~.Say(~~AvatarData.Name + " Entered~~");
	}

	~~static void EventAvatarDelete(Instance Sender, Avatar AvatarData)~~
	{
	~~//A user has left the world (or the bot's range)~~
	~~//We print the user's name followed by a brief message~~
	~~VPInstance~~.~~Say(AvatarData~~.Name ~~+ " Left~~");
	}		}
	}		}

Edwin: Fix VB.Net sample

2017-05-24T22:13:56Z

Fix VB.Net sample

← Older revision		Revision as of 22:13, 24 May 2017
Line 144:		Line 144:
	==VB .Net==		==VB .Net==
	<syntaxhighlight lang="vbnet">		<syntaxhighlight lang="vbnet">
	Imports VpNet~~.Core~~		Imports VpNet
	~~Imports VpNet.Core.EventData~~
	~~Imports VpNet.Core.Structs~~

	Module ExampleBot		Module ExampleBot
	~~'Virtual Paradise SDK Instance~~
	Public VPInstance As Instance		Public VPInstance As Instance

	Sub Main(~~ByVal args As String()~~)		Sub Main()
	Try		Try
	'Initialize the Virtual Paradise .Net SDK		'Initialize the Virtual Paradise .Net SDK
Line 159:		Line 156:
	'Register the events you wish to capture (Such as avatar entry)		'Register the events you wish to capture (Such as avatar entry)
	'This must be done AFTER the initialization, but before connection		'This must be done AFTER the initialization, but before connection
	AddHandler VPInstance.~~EventAvatarAdd~~, AddressOf ~~EventAvatarAdd~~		AddHandler VPInstance.OnAvatarEnter, AddressOf EventAvatarEnter
	AddHandler VPInstance.~~EventAvatarDelete~~, AddressOf ~~EventAvatarDelete~~		AddHandler VPInstance.OnAvatarLeave, AddressOf EventAvatarLeave

	'Connect to the universe using the default server settings		'Connect to the universe using the default server settings
Line 197:		Line 194:
	Console.Read()		Console.Read()
	End Sub		End Sub
	Private Sub ~~EventAvatarAdd~~(~~ByVal Sender~~ As Instance, ~~ByVal AvatarData~~ As Avatar)
			Private Sub EventAvatarEnter(sender As Instance, args As AvatarEnterEventArgsT(Of Avatar(Of Vector3), Vector3))
	'A user has entered the world (or the bot's range)		'A user has entered the world (or the bot's range)
	'We print the user's name followed by a brief message		'We print the user's name followed by a brief message
	VPInstance.Say(~~AvatarData~~.Name & " Entered")		VPInstance.Say(args.Avatar.Name & " Entered")
	End Sub		End Sub

	Private Sub ~~EventAvatarDelete~~(~~ByVal Sender~~ As Instance, ByVal ~~AvatarData~~ As Avatar)		Private Sub EventAvatarLeave(sender As Instance, ByVal args As AvatarLeaveEventArgsT(Of Avatar(Of Vector3), Vector3))
	'A user has left the world (or the bot's range)		'A user has left the world (or the bot's range)
	'We print the user's name followed by a brief message		'We print the user's name followed by a brief message
	VPInstance.Say(~~AvatarData~~.Name & " Left")		VPInstance.Say(args.Avatar.Name & " Left")
	End Sub		End Sub

	End Module		End Module
	</syntaxhighlight>		</syntaxhighlight>
	[[Category: Bots]]		[[Category: Bots]]
	[[Category: SDK]]		[[Category: SDK]]

Edwin: new syntax highlighting tags

2015-02-06T17:41:53Z

new syntax highlighting tags

← Older revision		Revision as of 17:41, 6 February 2015
Line 4:		Line 4:
	*Have Visual Studio, Visual C++ Express or another compatible C/C++ IDE+Compiler installed and [[developer environments#C\|configured]]		*Have Visual Studio, Visual C++ Express or another compatible C/C++ IDE+Compiler installed and [[developer environments#C\|configured]]
	*Download the x86 SDK from the [http://dev.virtualparadise.org/downloads.php Developer Downloads] page		*Download the x86 SDK from the [http://dev.virtualparadise.org/downloads.php Developer Downloads] page
	<C>		<syntaxhighlight lang="cpp">
	#include <VPSDK/VP.h>		#include <VPSDK/VP.h>
	#include <stdio.h>		#include <stdio.h>
Line 61:		Line 61:
	vp_say(sdk, (char*)&message);		vp_say(sdk, (char*)&message);
	}		}
	</C>		</syntaxhighlight>
	==C#==		==C#==
	In order to use the Virtual Paradise .Net SDK you must:		In order to use the Virtual Paradise .Net SDK you must:
Line 68:		Line 68:
	*The latest version of the native VP x86 SDK, that is supported, is included in the VPNET distribution		*The latest version of the native VP x86 SDK, that is supported, is included in the VPNET distribution

	<~~CSharp~~>		<syntaxhighlight lang="csharp">
	using System;		using System;
	using VpNet.Core;		using VpNet.Core;
Line 140:		Line 140:
	}		}
	}		}
	</~~CSharp~~>		</syntaxhighlight>

	==VB .Net==		==VB .Net==
	<~~VBNet~~>		<syntaxhighlight lang="vbnet">
	Imports VpNet.Core		Imports VpNet.Core
	Imports VpNet.Core.EventData		Imports VpNet.Core.EventData
Line 210:		Line 210:

	End Module		End Module
	</~~VBNet~~>		</syntaxhighlight>
	[[Category: Bots]]		[[Category: Bots]]
	[[Category: SDK]]		[[Category: SDK]]

Edwin at 09:38, 10 April 2014

2014-04-10T09:38:16Z

← Older revision		Revision as of 09:38, 10 April 2014
Line 5:		Line 5:
	*Download the x86 SDK from the [http://dev.virtualparadise.org/downloads.php Developer Downloads] page		*Download the x86 SDK from the [http://dev.virtualparadise.org/downloads.php Developer Downloads] page
	<C>		<C>
	#include <~~vpsdk~~/VP.h>		#include <VPSDK/VP.h>
	#include <stdio.h>		#include <stdio.h>
	#include <stdlib.h>		#include <stdlib.h>
Line 12:		Line 12:
	#define Password "password"		#define Password "password"
	#define Botname "greeterbot"		#define Botname "greeterbot"
	#define Worldname "~~VP-Gate~~"		#define Worldname "testworld"

	void event_avatar_add(VPInstance sdk);		void event_avatar_add(VPInstance sdk);
Line 19:		Line 19:
	{		{
	int err;		int err;
			VPInstance sdk;

	if(err = vp_init(VPSDK_VERSION))		if(err = vp_init(VPSDK_VERSION))
	{		{
Line 25:		Line 27:
	}		}

	~~VPInstance sdk;~~
	sdk = vp_create();		sdk = vp_create();

Line 56:		Line 57:
	void event_avatar_add(VPInstance sdk)		void event_avatar_add(VPInstance sdk)
	{		{
	char message[~~100~~];		char message[300];
	sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));		sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
	vp_say(sdk, (char*)&message);		vp_say(sdk, (char*)&message);

Cube3: /* C# */

2012-12-17T13:36:22Z

← Older revision		Revision as of 13:36, 17 December 2012
Line 65:		Line 65:
	*Have Visual Studio or Visual C# Express installed and [[developer environments#CSharp\|configured]]		*Have Visual Studio or Visual C# Express installed and [[developer environments#CSharp\|configured]]
	*Download the .Net SDK from the [http://vpnet.codeplex.com/ VPNet SDK Download] page		*Download the .Net SDK from the [http://vpnet.codeplex.com/ VPNet SDK Download] page
	*The latest version of the native VP x86 SDK is included in the VPNET distribution		*The latest version of the native VP x86 SDK, that is supported, is included in the VPNET distribution

	<CSharp>		<CSharp>

Cube3: /* C# */

2012-12-17T13:35:45Z

← Older revision		Revision as of 13:35, 17 December 2012
Line 64:		Line 64:
	In order to use the Virtual Paradise .Net SDK you must:		In order to use the Virtual Paradise .Net SDK you must:
	*Have Visual Studio or Visual C# Express installed and [[developer environments#CSharp\|configured]]		*Have Visual Studio or Visual C# Express installed and [[developer environments#CSharp\|configured]]
	*Download the x86 SDK from the [http://dev.virtualparadise.org/downloads.php Developer Downloads] page
	*Download the .Net SDK from the [http://vpnet.codeplex.com/ VPNet SDK Download] page		*Download the .Net SDK from the [http://vpnet.codeplex.com/ VPNet SDK Download] page
			*The latest version of the native VP x86 SDK is included in the VPNET distribution

	<CSharp>		<CSharp>
	using System;		using System;
Line 139:		Line 140:
	}		}
	</CSharp>		</CSharp>

	==VB .Net==		==VB .Net==
	<VBNet>		<VBNet>