oliverbooth/VpSharp
1
0
Fork 0
mirror of https://github.com/oliverbooth/VpSharp synced 2024-11-09 23:35:41 +00:00
Code Issues Wiki

Compare commits

base: oliverbooth:ff298a8af509e22274a16da0b2fba7efc40e0005
Branches Tags
oliverbooth:main
oliverbooth:release/1.0.0
oliverbooth:feature/building
oliverbooth:fix_uri_send
oliverbooth:v0.1.0-nightly.2
oliverbooth:v0.1.0-nightly.1
..
compare: oliverbooth:05b53da5a4b32638daa77adde08f6405c7555baa
Branches Tags
oliverbooth:release/1.0.0
oliverbooth:feature/building
oliverbooth:fix_uri_send
oliverbooth:main
oliverbooth:v0.1.0-nightly.2
oliverbooth:v0.1.0-nightly.1

No commits in common. "ff298a8af509e22274a16da0b2fba7efc40e0005" and "05b53da5a4b32638daa77adde08f6405c7555baa" have entirely different histories.
ff298a8af5 ... 05b53da5a4

35 changed files with 175 additions and 471 deletions
Show Stats Expand all files Collapse all files

2
VpSharp.Commands/Attributes/ExecutionChecks/RequireUserNameAttribute.cs
View File

@ -54,7 +54,7 @@ public sealed class RequireUserNameAttribute : PreExecutionCheckAttribute
throw new ArgumentNullException(nameof(context));
}
IUser user = await context.Avatar.GetUserAsync().ConfigureAwait(false);
User user = await context.Avatar.GetUserAsync().ConfigureAwait(false);
return Names.Contains(user.Name);
}
}

13
VpSharp.Commands/CommandContext.cs
View File

@ -9,7 +9,7 @@ namespace VpSharp.Commands;
/// </summary>
public sealed class CommandContext
{
internal CommandContext(VirtualParadiseClient client, IAvatar avatar, string commandName, string alias,
internal CommandContext(VirtualParadiseClient client, Avatar avatar, string commandName, string alias,
string rawArguments)
{
Client = client;
@ -36,8 +36,8 @@ public sealed class CommandContext
/// Gets the avatar who executed the command.
/// </summary>
/// <value>The executing avatar.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the client which raised the event.
/// </summary>
@ -65,11 +65,10 @@ public sealed class CommandContext
/// regular chat message.
/// </param>
/// <returns>The message which was sent.</returns>
public async Task<IMessage> RespondAsync(string message, bool ephemeral = false)
public Task<Message> RespondAsync(string message, bool ephemeral = false)
{
return ephemeral
? await Avatar.SendMessageAsync(Client.CurrentAvatar?.Name, message, FontStyle.Regular, Color.Black)
.ConfigureAwait(false)
: await Client.SendMessageAsync(message).ConfigureAwait(false);
? Avatar.SendMessageAsync(Client.CurrentAvatar?.Name, message, FontStyle.Regular, Color.Black)
: Client.SendMessageAsync(message);
}
}

4
VpSharp.Commands/CommandsExtension.cs
View File

@ -176,14 +176,14 @@ public sealed class CommandsExtension : VirtualParadiseClientExtension
}
/// <inheritdoc />
protected internal override Task OnMessageReceived(IMessage message)
protected internal override Task OnMessageReceived(Message message)
{
if (message is null)
{
throw new ArgumentNullException(nameof(message));
}
if (message is IUserMessage)
if (message.Type != MessageType.ChatMessage)
{
return base.OnMessageReceived(message);
}

2
VpSharp.IntegrationTests/src/Program.cs
View File

@ -45,7 +45,7 @@ Console.WriteLine(@"Entering world");
World world = await client.EnterAsync("Mutation");
Console.WriteLine(@"Entered world!");
IAvatar avatar = client.CurrentAvatar!;
Avatar avatar = client.CurrentAvatar!;
Console.WriteLine($@"My name is {avatar.Name} and I am at {avatar.Location}");
Console.WriteLine($@"Entered {world.Name} with size {world.Size}");

4
VpSharp/src/ClientExtensions/VirtualParadiseClientExtension.cs
View File

@ -26,8 +26,8 @@ public abstract class VirtualParadiseClientExtension
/// <summary>
/// Called when a chat message is received.
/// </summary>
/// <param name="message">The message which was received.</param>
protected internal virtual Task OnMessageReceived(IMessage message)
/// <param name="args">An object containing event data.</param>
protected internal virtual Task OnMessageReceived(Message message)
{
return Task.CompletedTask;
}

23
VpSharp/src/Entities/Avatar.cs
View File

@ -10,10 +10,10 @@ namespace VpSharp.Entities;
/// <summary>
/// Represents an avatar within a world.
/// </summary>
public sealed class Avatar : IEquatable<Avatar>, IAvatar
public sealed class Avatar : IEquatable<Avatar>
{
private readonly VirtualParadiseClient _client;
private IUser? _user;
private User? _user;
internal Avatar(VirtualParadiseClient client, int session)
{
@ -172,7 +172,7 @@ public sealed class Avatar : IEquatable<Avatar>, IAvatar
/// Gets the user associated with this avatar.
/// </summary>
/// <returns>The user.</returns>
public async Task<IUser> GetUserAsync()
public async Task<User> GetUserAsync()
{
_user ??= await _client.GetUserAsync(UserId).ConfigureAwait(false);
return _user;
@ -196,7 +196,7 @@ public sealed class Avatar : IEquatable<Avatar>, IAvatar
/// -or-
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
public Task<IConsoleMessage> SendMessageAsync(string message, FontStyle fontStyle, Color color)
public Task<Message> SendMessageAsync(string message, FontStyle fontStyle, Color color)
{
return SendMessageAsync(null, message, fontStyle, color);
}
@ -221,7 +221,7 @@ public sealed class Avatar : IEquatable<Avatar>, IAvatar
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
/// <remarks>Passing <see langword="null" /> to <paramref name="name" /> will hide the name from the recipient.</remarks>
public Task<IConsoleMessage> SendMessageAsync(string? name, string message, FontStyle fontStyle, Color color)
public Task<Message> SendMessageAsync(string? name, string message, FontStyle fontStyle, Color color)
{
if (message is null)
{
@ -233,7 +233,7 @@ public sealed class Avatar : IEquatable<Avatar>, IAvatar
throw new ArgumentException(ExceptionMessages.ValueCannotBeEmpty, nameof(message));
}
IAvatar avatar;
Avatar avatar;
lock (_client.Lock)
{
@ -267,12 +267,13 @@ public sealed class Avatar : IEquatable<Avatar>, IAvatar
avatar = _client.CurrentAvatar!;
}
return Task.FromResult((IConsoleMessage)new ConsoleMessage(
avatar,
avatar.Name,
return Task.FromResult(new Message(
MessageType.ConsoleMessage,
name,
message,
color,
fontStyle
avatar,
fontStyle,
color
));
}

30
VpSharp/src/Entities/ConsoleMessage.cs
View File

@ -1,30 +0,0 @@
using System.Drawing;
namespace VpSharp.Entities;
/// <summary>
/// Represents a chat message that was sent by a user.
/// </summary>
public sealed class ConsoleMessage : Message, IConsoleMessage
{
/// <summary>
/// Initializes a new instance of the <see cref="UserMessage" /> class.
/// </summary>
/// <param name="author">The author of the message.</param>
/// <param name="name">The apparent sender's name of the message.</param>
/// <param name="content">The content of the message.</param>
/// <param name="color">A <see cref="System.Drawing.Color" /> value representing the color of the message.</param>
/// <param name="fontStyle">A <see cref="FontStyle" /> value representing the font style of the message.</param>
public ConsoleMessage(IAvatar author, string name, string content, Color color, FontStyle fontStyle)
: base(author, name, content)
{
Color = color;
Style = fontStyle;
}
/// <inheritdoc />
public Color Color { get; }
/// <inheritdoc />
public FontStyle Style { get; }
}

184
VpSharp/src/Entities/IAvatar.cs
View File

@ -1,184 +0,0 @@
using System.Drawing;
namespace VpSharp.Entities;
public interface IAvatar
{
/// <summary>
/// Gets the details of the application this avatar is using.
/// </summary>
/// <value>The avatar's application details.</value>
Application Application { get; }
/// <summary>
/// Gets a value indicating whether this avatar is a bot.
/// </summary>
/// <value><see langword="true" /> if this avatar is a bot; otherwise, <see langword="false" />.</value>
bool IsBot { get; }
/// <summary>
/// Gets the location of this avatar.
/// </summary>
/// <value>The location of this avatar.</value>
Location Location { get; }
/// <summary>
/// Gets the name of this avatar.
/// </summary>
/// <value>The name of this avatar.</value>
string Name { get; }
/// <summary>
/// Gets the session ID of this avatar.
/// </summary>
/// <value>The session ID.</value>
int Session { get; }
/// <summary>
/// Gets the type of this avatar.
/// </summary>
/// <value>The type of this avatar.</value>
int Type { get; }
/// <summary>
/// Gets the user ID associated with this avatar.
/// </summary>
/// <value>The user ID.</value>
int UserId { get; }
/// <summary>
/// Clicks this avatar.
/// </summary>
/// <param name="clickPoint">The position at which the avatar should be clicked.</param>
/// <exception cref="InvalidOperationException">
/// <para>The action cannot be performed on the client's current avatar.</para>
/// -or-
/// <para>An attempt was made to click an avatar outside of a world.</para>
/// </exception>
Task ClickAsync(Vector3d? clickPoint = null);
/// <summary>
/// Determines if two <see cref="Avatar" /> instances are equal.
/// </summary>
/// <param name="other">The other instance.</param>
/// <returns>
/// <see langword="true" /> if this instance is equal to <paramref name="other" />; otherwise, <see langword="false" />.
/// </returns>
bool Equals(Avatar? other);
/// <summary>
/// Gets the user associated with this avatar.
/// </summary>
/// <returns>The user.</returns>
Task<IUser> GetUserAsync();
/// <summary>
/// Sends a console message to the avatar with no name.
/// </summary>
/// <param name="message">The message to send.</param>
/// <param name="fontStyle">The font style of the message.</param>
/// <param name="color">The text color of the message.</param>
/// <returns>The message which was sent.</returns>
/// <exception cref="ArgumentNullException"><paramref name="message" /> is <see langword="null" />.</exception>
/// <exception cref="InvalidOperationException">
/// <para>An attempt was made to send a message while not connected to a world.</para>
/// -or-
/// <para>An attempt was made to send a message to an avatar that is not in the world.</para>
/// </exception>
/// <exception cref="ArgumentException">
/// <para><paramref name="message" /> is empty, or consists of only whitespace.</para>
/// -or-
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
Task<IConsoleMessage> SendMessageAsync(string message, FontStyle fontStyle, Color color);
/// <summary>
/// Sends a console message to the avatar.
/// </summary>
/// <param name="name">The apparent author of the message.</param>
/// <param name="message">The message to send.</param>
/// <param name="fontStyle">The font style of the message.</param>
/// <param name="color">The text color of the message.</param>
/// <returns>The message which was sent.</returns>
/// <exception cref="ArgumentNullException"><paramref name="message" /> is <see langword="null" />.</exception>
/// <exception cref="InvalidOperationException">
/// <para>An attempt was made to send a message while not connected to a world.</para>
/// -or-
/// <para>An attempt was made to send a message to an avatar that is not in the world.</para>
/// </exception>
/// <exception cref="ArgumentException">
/// <para><paramref name="message" /> is empty, or consists of only whitespace.</para>
/// -or-
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
/// <remarks>Passing <see langword="null" /> to <paramref name="name" /> will hide the name from the recipient.</remarks>
Task<IConsoleMessage> SendMessageAsync(string? name, string message, FontStyle fontStyle, Color color);
/// <summary>
/// Sends a URI to this avatar.
/// </summary>
/// <param name="uri">The URI to send.</param>
/// <param name="target">The URL target. See <see cref="UriTarget" /> for more information.</param>
/// <exception cref="InvalidOperationException">The action cannot be performed on the client's current avatar.</exception>
/// <exception cref="ArgumentNullException"><paramref name="uri" /> is <see langword="null" />.</exception>
Task SendUriAsync(Uri uri, UriTarget target = UriTarget.Browser);
/// <summary>
/// Modifies the world settings for this avatar.
/// </summary>
/// <param name="action">The builder which defines parameters to change.</param>
/// <exception cref="ArgumentNullException"><paramref name="action" /> is <see langword="null" />.</exception>
/// <exception cref="UnauthorizedAccessException">The client does not have permission to modify world settings.</exception>
Task SendWorldSettings(Action<WorldSettingsBuilder> action);
/// <summary>
/// Teleports the avatar to another world.
/// </summary>
/// <param name="world">The name of the world to which this avatar should be teleported.</param>
/// <param name="position">The position to which this avatar should be teleported.</param>
/// <exception cref="ArgumentNullException"><paramref name="world" /> is <see langword="null" />.</exception>
Task TeleportAsync(World world, Vector3d position);
/// <summary>
/// Teleports the avatar to another world.
/// </summary>
/// <param name="world">The name of the world to which this avatar should be teleported.</param>
/// <param name="position">The position to which this avatar should be teleported.</param>
/// <param name="rotation">The rotation to which this avatar should be teleported.</param>
/// <exception cref="ArgumentNullException"><paramref name="world" /> is <see langword="null" />.</exception>
Task TeleportAsync(World world, Vector3d position, Rotation rotation);
/// <summary>
/// Teleports the avatar to another world.
/// </summary>
/// <param name="world">The name of the world to which this avatar should be teleported.</param>
/// <param name="position">The position to which this avatar should be teleported.</param>
Task TeleportAsync(string world, Vector3d position);
/// <summary>
/// Teleports the avatar to another world.
/// </summary>
/// <param name="world">The name of the world to which this avatar should be teleported.</param>
/// <param name="position">The position to which this avatar should be teleported.</param>
/// <param name="rotation">The rotation to which this avatar should be teleported.</param>
Task TeleportAsync(string world, Vector3d position, Rotation rotation);
/// <summary>
/// Teleports the avatar to a new position within the current world.
/// </summary>
/// <param name="position">The position to which this avatar should be teleported.</param>
Task TeleportAsync(Vector3d position);
/// <summary>
/// Teleports the avatar to a new position and rotation within the current world.
/// </summary>
/// <param name="position">The position to which this avatar should be teleported.</param>
/// <param name="rotation">The rotation to which this avatar should be teleported</param>
Task TeleportAsync(Vector3d position, Rotation rotation);
/// <summary>
/// Teleports this avatar to a new location, which may or may not be a new world.
/// </summary>
/// <param name="location">The location to which this avatar should be teleported.</param>
Task TeleportAsync(Location location);
}

21
VpSharp/src/Entities/IConsoleMessage.cs
View File

@ -1,21 +0,0 @@
using System.Drawing;
namespace VpSharp.Entities;
/// <summary>
/// Represents a console message.
/// </summary>
public interface IConsoleMessage : IMessage
{
/// <summary>
/// Gets the color of the message.
/// </summary>
/// <value>A <see cref="System.Drawing.Color" /> value representing the color.</value>
Color Color { get; }
/// <summary>
/// Gets the font style of the message.
/// </summary>
/// <value>A <see cref="FontStyle" /> value representing the font style.</value>
FontStyle Style { get; }
}

25
VpSharp/src/Entities/IMessage.cs
View File

@ -1,25 +0,0 @@
namespace VpSharp.Entities;
/// <summary>
/// Represents a message.
/// </summary>
public interface IMessage
{
/// <summary>
/// Gets the author of the message.
/// </summary>
/// <value>The avatar which authored the message.</value>
IAvatar Author { get; }
/// <summary>
/// Gets the content of the message.
/// </summary>
/// <value>The content.</value>
string Content { get; }
/// <summary>
/// Gets the apparent sender's name of the message.
/// </summary>
/// <value>The sender's name.</value>
string Name { get; }
}

71
VpSharp/src/Entities/IUser.cs
View File

@ -1,71 +0,0 @@
using VpSharp.Exceptions;
namespace VpSharp.Entities;
public interface IUser
{
/// <summary>
/// Gets the email address of this user.
/// </summary>
/// <value>The email address of this user.</value>
string EmailAddress { get; }
/// <summary>
/// Gets the ID of this user.
/// </summary>
/// <value>The user's ID.</value>
int Id { get; }
/// <summary>
/// Gets the date and time at which this user was last online.
/// </summary>
/// <value>A <see cref="DateTimeOffset" /> representing the date and time this user was last online.</value>
DateTimeOffset LastLogin { get; }
/// <summary>
/// Gets the name of this user.
/// </summary>
/// <value>The user's name.</value>
string Name { get; }
/// <summary>
/// Gets the duration for which this user has been online.
/// </summary>
/// <value>A <see cref="TimeSpan" /> representing the duration for which this user has been online.</value>
TimeSpan OnlineTime { get; }
/// <summary>
/// Gets the date and time at which this user was registered.
/// </summary>
/// <value>A <see cref="DateTimeOffset" /> representing the date and time this user was registered.</value>
DateTimeOffset RegistrationTime { get; }
/// <summary>
/// Determines if two <see cref="User" /> instances are equal.
/// </summary>
/// <param name="other">The other instance.</param>
/// <returns>
/// <see langword="true" /> if this instance is equal to <paramref name="other" />; otherwise, <see langword="false" />.
/// </returns>
bool Equals(User? other);
/// <summary>
/// Invites this user to a specified location.
/// </summary>
/// <param name="location">
/// The invitation location. If <see langword="null" />, the client's current location is used.
/// </param>
Task<InviteResponse> InviteAsync(Location? location = null);
/// <summary>
/// Sends a to join request to the user.
/// </summary>
/// <param name="suppressTeleport">
/// If <see langword="true" />, the client's avatar will not teleport to the requested location automatically.
/// Be careful, there is no way to retrieve
/// </param>
/// <returns>The result of the request.</returns>
/// <exception cref="UserNotFoundException">This user is invalid and cannot be joined.</exception>
/// <exception cref="InvalidOperationException">An unexpected error occurred trying to join the user.</exception>
Task<JoinResult> JoinAsync(bool suppressTeleport = false);
}

6
VpSharp/src/Entities/IUserMessage.cs
View File

@ -1,6 +0,0 @@
namespace VpSharp.Entities;
/// <summary>
/// Represents a chat message that was sent by a user.
/// </summary>
public interface IUserMessage : IMessage;

68
VpSharp/src/Entities/Message.cs
View File

@ -1,29 +1,67 @@
namespace VpSharp.Entities;
using System.Drawing;
namespace VpSharp.Entities;
/// <summary>
/// Represents a message.
/// </summary>
public abstract class Message : IMessage
public sealed class Message
{
/// <summary>
/// Initializes a new instance of the <see cref="Message" /> class.
/// </summary>
/// <param name="author">The author of the message.</param>
/// <param name="name">The apparent sender's name of the message.</param>
/// <param name="content">The content of the message.</param>
protected Message(IAvatar author, string name, string content)
internal Message(
MessageType type,
string? name,
string content,
Avatar author,
FontStyle style,
Color color)
{
Author = author;
Type = type;
Name = string.IsNullOrWhiteSpace(name) ? null : name;
Content = content;
Name = name;
Author = author;
Style = style;
Color = color;
}
/// <inheritdoc />
public IAvatar Author { get; }
/// <summary>
/// Gets the message author.
/// </summary>
/// <value>The message author.</value>
public Avatar Author { get; }
/// <inheritdoc />
/// <summary>
/// Gets the message content.
/// </summary>
/// <value>The message content.</value>
public string Content { get; }
/// <summary>
/// Gets the message name.
/// </summary>
/// <value>The message name. This will always be equal to the name of the <see cref="Author" /> for chat messages.</value>
public string? Name { get; }
/// <summary>
/// Gets the message color.
/// </summary>
/// <value>The message color. This will always be <see cref="System.Drawing.Color.Black" /> for chat messages.</value>
public Color Color { get; }
/// <summary>
/// Gets the message font style.
/// </summary>
/// <value>The message font style. This will always be <see cref="FontStyle.Regular" /> for chat messages.</value>
public FontStyle Style { get; }
/// <summary>
/// Gets the type of this message.
/// </summary>
/// <value>The type of this message.</value>
public MessageType Type { get; }
/// <inheritdoc />
public string Name { get; }
public override string ToString()
{
return $"Message {Author}; Type {Type}; Content {Content}";
}
}

4
VpSharp/src/Entities/ObjectBuilder.cs
View File

@ -43,7 +43,7 @@ public abstract class ObjectBuilder
/// This property may only be set during an object load, and will throw <see cref="InvalidOperationException" /> at
/// any other point.
/// </remarks>
public Option<IUser> Owner { get; set; }
public Option<User> Owner { get; set; }
/// <summary>
/// Gets or sets the position of the object.
@ -90,7 +90,7 @@ public abstract class ObjectBuilder
throw new InvalidOperationException("Owner can only be assigned during an object load.");
}
IUser oldOwner = TargetObject.Owner;
User oldOwner = TargetObject.Owner;
_ = vp_int_set(handle, ObjectUserId, Owner.ValueOr(oldOwner).Id);
}

2
VpSharp/src/Entities/User.cs
View File

@ -8,7 +8,7 @@ namespace VpSharp.Entities;
/// <summary>
/// Represents a Virtual Paradise user.
/// </summary>
public sealed class User : IEquatable<User>, IUser
public sealed class User : IEquatable<User>
{
private readonly VirtualParadiseClient _client;

17
VpSharp/src/Entities/UserMessage.cs
View File

@ -1,17 +0,0 @@
namespace VpSharp.Entities;
/// <summary>
/// Represents a chat message that was sent by a user.
/// </summary>
public sealed class UserMessage : Message, IUserMessage
{
/// <summary>
/// Initializes a new instance of the <see cref="UserMessage" /> class.
/// </summary>
/// <param name="author">The author of the message.</param>
/// <param name="content">The content of the message.</param>
public UserMessage(IAvatar author, string content)
: base(author, author.Name, content)
{
}
}

2
VpSharp/src/Entities/VirtualParadiseObject.cs
View File

@ -51,7 +51,7 @@ public abstract class VirtualParadiseObject : IEquatable<VirtualParadiseObject>
/// Gets the owner of this object.
/// </summary>
/// <value>The owner of this object.</value>
public IUser Owner { get; internal set; } = null!;
public User Owner { get; internal set; } = null!;
internal byte[] Data { get; set; } = Array.Empty<byte>();

6
VpSharp/src/EventData/AvatarClickedEventArgs.cs
View File

@ -13,7 +13,7 @@ public sealed class AvatarClickedEventArgs : EventArgs
/// <param name="avatar">The avatar responsible for the click.</param>
/// <param name="clickedAvatar">The clicked avatar.</param>
/// <param name="clickPoint">The click point.</param>
public AvatarClickedEventArgs(IAvatar avatar, IAvatar clickedAvatar, Vector3d clickPoint)
public AvatarClickedEventArgs(Avatar avatar, Avatar clickedAvatar, Vector3d clickPoint)
{
Avatar = avatar;
ClickedAvatar = clickedAvatar;
@ -24,13 +24,13 @@ public sealed class AvatarClickedEventArgs : EventArgs
/// Gets the avatar responsible for the click.
/// </summary>
/// <value>The avatar responsible for the click.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the clicked avatar.
/// </summary>
/// <value>The clicked avatar.</value>
public IAvatar ClickedAvatar { get; }
public Avatar ClickedAvatar { get; }
/// <summary>
/// Gets the point at which the avatar clicked the object.

4
VpSharp/src/EventData/AvatarMovedEventArgs.cs
View File

@ -13,7 +13,7 @@ public sealed class AvatarMovedEventArgs : EventArgs
/// <param name="avatar">The avatar whose type was changed.</param>
/// <param name="locationAfter">The avatar's new location.</param>
/// <param name="locationBefore">The avatar's old location.</param>
public AvatarMovedEventArgs(IAvatar avatar, Location locationAfter, Location? locationBefore)
public AvatarMovedEventArgs(Avatar avatar, Location locationAfter, Location? locationBefore)
{
Avatar = avatar;
LocationAfter = locationAfter;
@ -24,7 +24,7 @@ public sealed class AvatarMovedEventArgs : EventArgs
/// Gets the avatar whose location was changed.
/// </summary>
/// <value>The avatar whose location was changed.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the avatar's location after the change.

4
VpSharp/src/EventData/AvatarTypeChangedEventArgs.cs
View File

@ -13,7 +13,7 @@ public sealed class AvatarTypeChangedEventArgs : EventArgs
/// <param name="avatar">The avatar whose type was changed.</param>
/// <param name="typeAfter">The avatar's new type.</param>
/// <param name="typeBefore">The avatar's old type.</param>
public AvatarTypeChangedEventArgs(IAvatar avatar, int typeAfter, int? typeBefore)
public AvatarTypeChangedEventArgs(Avatar avatar, int typeAfter, int? typeBefore)
{
Avatar = avatar;
TypeAfter = typeAfter;
@ -24,7 +24,7 @@ public sealed class AvatarTypeChangedEventArgs : EventArgs
/// Gets the avatar whose type was changed.
/// </summary>
/// <value>The avatar whose type was changed.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the avatar's type after the change.

4
VpSharp/src/EventData/ObjectBumpEventArgs.cs
View File

@ -13,7 +13,7 @@ public sealed class ObjectBumpEventArgs : EventArgs
/// <param name="avatar">The avatar.</param>
/// <param name="bumpedObject">The bumped object.</param>
/// <param name="phase">The bump phase.</param>
public ObjectBumpEventArgs(IAvatar avatar, VirtualParadiseObject bumpedObject, BumpPhase phase)
public ObjectBumpEventArgs(Avatar avatar, VirtualParadiseObject bumpedObject, BumpPhase phase)
{
Avatar = avatar;
BumpedObject = bumpedObject;
@ -24,7 +24,7 @@ public sealed class ObjectBumpEventArgs : EventArgs
/// Gets the avatar responsible for the bump.
/// </summary>
/// <value>The avatar responsible for the bump.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the object to which this event pertains.

4
VpSharp/src/EventData/ObjectChangedEventArgs.cs
View File

@ -14,7 +14,7 @@ public sealed class ObjectChangedEventArgs : EventArgs
/// <param name="objectBefore">The state of the object prior to the change.</param>
/// <param name="objectAfter">The object which was changed, containing updated values.</param>
public ObjectChangedEventArgs(
IAvatar avatar,
Avatar avatar,
VirtualParadiseObject? objectBefore,
VirtualParadiseObject objectAfter)
{
@ -27,7 +27,7 @@ public sealed class ObjectChangedEventArgs : EventArgs
/// Gets the avatar which changed the object.
/// </summary>
/// <value>The avatar which changed the object.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the object which was changed.

4
VpSharp/src/EventData/ObjectClickedEventArgs.cs
View File

@ -14,7 +14,7 @@ public sealed class ObjectClickedEventArgs : EventArgs
/// <param name="clickedObject">The clicked object.</param>
/// <param name="clickPoint">The click point.</param>
public ObjectClickedEventArgs(
IAvatar avatar,
Avatar avatar,
VirtualParadiseObject clickedObject,
Vector3d clickPoint)
{
@ -27,7 +27,7 @@ public sealed class ObjectClickedEventArgs : EventArgs
/// Gets the avatar responsible for the click.
/// </summary>
/// <value>The avatar responsible for the click.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the clicked object.

4
VpSharp/src/EventData/ObjectCreatedEventArgs.cs
View File

@ -12,7 +12,7 @@ public sealed class ObjectCreatedEventArgs : EventArgs
/// </summary>
/// <param name="avatar">The avatar responsible for the object being created.</param>
/// <param name="createdObject">The created object.</param>
public ObjectCreatedEventArgs(IAvatar avatar, VirtualParadiseObject createdObject)
public ObjectCreatedEventArgs(Avatar avatar, VirtualParadiseObject createdObject)
{
Avatar = avatar;
CreatedObject = createdObject;
@ -22,7 +22,7 @@ public sealed class ObjectCreatedEventArgs : EventArgs
/// Gets the avatar responsible for the object being created.
/// </summary>
/// <value>The avatar responsible for the object being created.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the object which was created.

4
VpSharp/src/EventData/ObjectDeletedEventArgs.cs
View File

@ -13,7 +13,7 @@ public sealed class ObjectDeletedEventArgs : EventArgs
/// <param name="avatar">The avatar responsible for the object being deleted.</param>
/// <param name="objectId">The ID of the deleted object.</param>
/// <param name="deletedObject">The deleted object.</param>
public ObjectDeletedEventArgs(IAvatar avatar, int objectId, VirtualParadiseObject deletedObject)
public ObjectDeletedEventArgs(Avatar avatar, int objectId, VirtualParadiseObject deletedObject)
{
Avatar = avatar;
ObjectId = objectId;
@ -24,7 +24,7 @@ public sealed class ObjectDeletedEventArgs : EventArgs
/// Gets the avatar responsible for the object being deleted.
/// </summary>
/// <value>The avatar responsible for the object being deleted.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the object which was deleted.

4
VpSharp/src/EventData/TeleportedEventArgs.cs
View File

@ -12,7 +12,7 @@ public sealed class TeleportedEventArgs : EventArgs
/// </summary>
/// <param name="avatar">The avatar which initiated the teleport.</param>
/// <param name="location">The target location of the teleport.</param>
public TeleportedEventArgs(IAvatar avatar, Location location)
public TeleportedEventArgs(Avatar avatar, Location location)
{
Avatar = avatar;
Location = location;
@ -22,7 +22,7 @@ public sealed class TeleportedEventArgs : EventArgs
/// Gets the avatar which initiated the teleport.
/// </summary>
/// <value>The avatar which initiated the teleport.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the target location of the teleport.

4
VpSharp/src/EventData/UriReceivedEventArgs.cs
View File

@ -13,7 +13,7 @@ public sealed class UriReceivedEventArgs : EventArgs
/// <param name="uri">The received URI.</param>
/// <param name="target">The URI target.</param>
/// <param name="avatar">The avatar who sent the URI.</param>
public UriReceivedEventArgs(Uri uri, UriTarget target, IAvatar avatar)
public UriReceivedEventArgs(Uri uri, UriTarget target, Avatar avatar)
{
Uri = uri;
Target = target;
@ -24,7 +24,7 @@ public sealed class UriReceivedEventArgs : EventArgs
/// Gets the avatar who sent the URI.
/// </summary>
/// <value>The avatar who sent the URI.</value>
public IAvatar Avatar { get; }
public Avatar Avatar { get; }
/// <summary>
/// Gets the URI target.

4
VpSharp/src/InviteRequest.cs
View File

@ -16,7 +16,7 @@ public sealed class InviteRequest : IEquatable<InviteRequest>
VirtualParadiseClient client,
int requestId,
string name,
IUser user,
User user,
Location location)
{
Name = name;
@ -42,7 +42,7 @@ public sealed class InviteRequest : IEquatable<InviteRequest>
/// Gets the user which sent the request.
/// </summary>
/// <value>The user which sent the request.</value>
public IUser User { get; }
public User User { get; }
/// <summary>
/// Returns a value indicating whether two <see cref="InviteRequest" /> instances are equal.

4
VpSharp/src/JoinRequest.cs
View File

@ -12,7 +12,7 @@ public sealed class JoinRequest : IEquatable<JoinRequest>
private readonly VirtualParadiseClient _client;
private readonly int _requestId;
internal JoinRequest(VirtualParadiseClient client, int requestId, string name, IUser user)
internal JoinRequest(VirtualParadiseClient client, int requestId, string name, User user)
{
Name = name;
User = user;
@ -30,7 +30,7 @@ public sealed class JoinRequest : IEquatable<JoinRequest>
/// Gets the user which sent the request.
/// </summary>
/// <value>The user which sent the request.</value>
public IUser User { get; }
public User User { get; }
/// <summary>
/// Returns a value indicating whether two <see cref="JoinRequest" /> instances are equal.

17
VpSharp/src/MessageType.cs Normal file
View File

@ -0,0 +1,17 @@
namespace VpSharp;
/// <summary>
/// An enumeration of message types.
/// </summary>
public enum MessageType
{
/// <summary>
/// A chat message sent by an avatar.
/// </summary>
ChatMessage,
/// <summary>
/// A console message sent by a bot.
/// </summary>
ConsoleMessage
}

2
VpSharp/src/VirtualParadiseClient.Avatars.cs
View File

@ -20,7 +20,7 @@ public sealed partial class VirtualParadiseClient
/// The avatar whose session is equal to <paramref name="session" />, or <see langword="null" /> if no match was
/// found.
/// </returns>
public IAvatar? GetAvatar(int session)
public Avatar? GetAvatar(int session)
{
_avatars.TryGetValue(session, out Avatar? avatar);
return avatar;

12
VpSharp/src/VirtualParadiseClient.Events.cs
View File

@ -7,13 +7,13 @@ namespace VpSharp;
public sealed partial class VirtualParadiseClient
{
private readonly Subject<AvatarClickedEventArgs> _avatarClicked = new();
private readonly Subject<IAvatar> _avatarJoined = new();
private readonly Subject<IAvatar> _avatarLeft = new();
private readonly Subject<Avatar> _avatarJoined = new();
private readonly Subject<Avatar> _avatarLeft = new();
private readonly Subject<AvatarMovedEventArgs> _avatarMoved = new();
private readonly Subject<AvatarTypeChangedEventArgs> _avatarTypeChanged = new();
private readonly Subject<InviteRequest> _inviteRequestReceived = new();
private readonly Subject<JoinRequest> _joinRequestReceived = new();
private readonly Subject<IMessage> _messageReceived = new();
private readonly Subject<Message> _messageReceived = new();
private readonly Subject<ObjectBumpEventArgs> _objectBump = new();
private readonly Subject<ObjectChangedEventArgs> _objectChanged = new();
private readonly Subject<ObjectClickedEventArgs> _objectClicked = new();
@ -35,7 +35,7 @@ public sealed partial class VirtualParadiseClient
/// <summary>
/// Occurs when an avatar has entered the vicinity of the client.
/// </summary>
public IObservable<IAvatar> AvatarJoined
public IObservable<Avatar> AvatarJoined
{
get => _avatarJoined;
}
@ -43,7 +43,7 @@ public sealed partial class VirtualParadiseClient
/// <summary>
/// Occurs when an avatar has left the vicinity of the client.
/// </summary>
public IObservable<IAvatar> AvatarLeft
public IObservable<Avatar> AvatarLeft
{
get => _avatarLeft;
}
@ -83,7 +83,7 @@ public sealed partial class VirtualParadiseClient
/// <summary>
/// Occurs when a chat message or console message has been received.
/// </summary>
public IObservable<IMessage> MessageReceived
public IObservable<Message> MessageReceived
{
get => _messageReceived;
}

45
VpSharp/src/VirtualParadiseClient.NativeEvents.cs
View File

@ -52,7 +52,7 @@ public sealed partial class VirtualParadiseClient
private void OnChatNativeEvent(nint sender)
{
IMessage message;
Message message;
lock (Lock)
{
@ -61,7 +61,6 @@ public sealed partial class VirtualParadiseClient
string content = vp_string(sender, StringAttribute.ChatMessage);
int type = vp_int(sender, IntegerAttribute.ChatType);
IAvatar avatar = GetAvatar(session)!;
Color color = Color.Black;
var style = FontStyle.Regular;
@ -73,12 +72,10 @@ public sealed partial class VirtualParadiseClient
int b = vp_int(sender, IntegerAttribute.ChatColorBlue);
color = Color.FromArgb(r, g, b);
style = (FontStyle)vp_int(sender, IntegerAttribute.ChatEffects);
message = new ConsoleMessage(avatar, name, content, color, style);
}
else
{
message = new UserMessage(avatar, content);
}
Avatar avatar = GetAvatar(session)!;
message = new Message((MessageType)type, name, content, avatar, style, color);
}
_messageReceived.OnNext(message);
@ -118,7 +115,7 @@ public sealed partial class VirtualParadiseClient
rotation = Rotation.CreateFromTiltYawRoll(pitch, yaw, 0);
}
var avatar = (Avatar)GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
if (type != avatar.Type)
{
int oldType = avatar.Type;
@ -148,7 +145,7 @@ public sealed partial class VirtualParadiseClient
session = vp_int(sender, IntegerAttribute.AvatarSession);
}
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
_avatars.TryRemove(session, out Avatar _);
_avatarLeft.OnNext(avatar);
}
@ -176,7 +173,7 @@ public sealed partial class VirtualParadiseClient
}
else
{
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
var args = new ObjectCreatedEventArgs(avatar, virtualParadiseObject);
_objectCreated.OnNext(args);
}
@ -193,7 +190,7 @@ public sealed partial class VirtualParadiseClient
session = vp_int(sender, IntegerAttribute.AvatarSession);
}
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
VirtualParadiseObject? cachedObject = null;
if (_objects.TryGetValue(objectId, out VirtualParadiseObject? virtualParadiseObject))
@ -229,7 +226,7 @@ public sealed partial class VirtualParadiseClient
session = vp_int(sender, IntegerAttribute.AvatarSession);
}
IAvatar avatar = GetAvatar(session)!;
Avatar? avatar = GetAvatar(session);
VirtualParadiseObject? virtualParadiseObject;
try
@ -243,7 +240,7 @@ public sealed partial class VirtualParadiseClient
_objects.TryRemove(objectId, out VirtualParadiseObject _);
var args = new ObjectDeletedEventArgs(avatar, objectId, virtualParadiseObject!);
var args = new ObjectDeletedEventArgs(avatar!, objectId, virtualParadiseObject!);
_objectDeleted.OnNext(args);
}
@ -264,7 +261,7 @@ public sealed partial class VirtualParadiseClient
clickPoint = new Vector3d(x, y, z);
}
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
try
{
VirtualParadiseObject virtualParadiseObject = await GetObjectAsync(objectId).ConfigureAwait(false);
@ -335,7 +332,7 @@ public sealed partial class VirtualParadiseClient
userId = vp_int(sender, IntegerAttribute.FriendUserId);
}
var user = (User)await GetUserAsync(userId).ConfigureAwait(false);
User user = await GetUserAsync(userId).ConfigureAwait(false);
_friends.AddOrUpdate(userId, user, (_, _) => user);
}
@ -426,8 +423,8 @@ public sealed partial class VirtualParadiseClient
clickPoint = new Vector3d(x, y, z);
}
IAvatar avatar = GetAvatar(session)!;
IAvatar clickedAvatar = GetAvatar(clickedSession)!;
Avatar avatar = GetAvatar(session)!;
Avatar clickedAvatar = GetAvatar(clickedSession)!;
var args = new AvatarClickedEventArgs(avatar, clickedAvatar, clickPoint);
_avatarClicked.OnNext(args);
}
@ -460,8 +457,8 @@ public sealed partial class VirtualParadiseClient
: await GetWorldAsync(worldName).ConfigureAwait(false))!;
var location = new Location(world, position, rotation);
((Avatar)CurrentAvatar!).Location = location;
IAvatar avatar = GetAvatar(session)!;
CurrentAvatar!.Location = location;
Avatar avatar = GetAvatar(session)!;
var args = new TeleportedEventArgs(avatar, location);
_teleported.OnNext(args);
}
@ -477,7 +474,7 @@ public sealed partial class VirtualParadiseClient
objectId = vp_int(sender, IntegerAttribute.ObjectId);
}
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
try
{
var vpObject = await GetObjectAsync(objectId).ConfigureAwait(false);
@ -508,7 +505,7 @@ public sealed partial class VirtualParadiseClient
return;
}
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
var uri = new Uri(url);
var args = new UriReceivedEventArgs(uri, target, avatar);
_uriReceived.OnNext(args);
@ -525,7 +522,7 @@ public sealed partial class VirtualParadiseClient
objectId = vp_int(sender, IntegerAttribute.ObjectId);
}
IAvatar avatar = GetAvatar(session)!;
Avatar avatar = GetAvatar(session)!;
try
{
var vpObject = await GetObjectAsync(objectId).ConfigureAwait(false);
@ -551,7 +548,7 @@ public sealed partial class VirtualParadiseClient
name = vp_string(NativeInstanceHandle, StringAttribute.JoinName);
}
IUser user = await GetUserAsync(userId).ConfigureAwait(false);
User user = await GetUserAsync(userId).ConfigureAwait(false);
var joinRequest = new JoinRequest(this, requestId, name, user);
_joinRequestReceived.OnNext(joinRequest);
}
@ -585,7 +582,7 @@ public sealed partial class VirtualParadiseClient
}
World world = (await GetWorldAsync(worldName).ConfigureAwait(false))!;
IUser user = await GetUserAsync(userId).ConfigureAwait(false);
User user = await GetUserAsync(userId).ConfigureAwait(false);
var location = new Location(world, position, rotation);
var request = new InviteRequest(this, requestId, avatarName, user, location);

2
VpSharp/src/VirtualParadiseClient.Users.cs
View File

@ -16,7 +16,7 @@ public sealed partial class VirtualParadiseClient
/// <returns>
/// The user whose ID is equal to <paramref name="userId" />, or <see langword="null" /> if no match was found.
/// </returns>
public async Task<IUser> GetUserAsync(int userId)
public async Task<User> GetUserAsync(int userId)
{
if (_users.TryGetValue(userId, out User? user))
{

40
VpSharp/src/VirtualParadiseClient.cs
View File

@ -66,7 +66,7 @@ public sealed partial class VirtualParadiseClient : IDisposable
/// Gets a read-only view of the cached avatars.
/// </summary>
/// <value>The cached avatars.</value>
public IReadOnlyList<IAvatar> Avatars
public IReadOnlyList<Avatar> Avatars
{
get => _avatars.Values.ToArray();
}
@ -77,15 +77,15 @@ public sealed partial class VirtualParadiseClient : IDisposable
/// <value>
/// An instance of <see cref="Avatar" />, or <see langword="null" /> if this client is not in a world.
/// </value>
public IAvatar? CurrentAvatar { get; internal set; }
public Avatar? CurrentAvatar { get; internal set; }
/// <summary>
/// Gets the current user to which this client is logged in.
/// </summary>
/// <value>
/// An instance of <see cref="IUser" />, or <see langword="null" /> if this client is not logged in.
/// An instance of <see cref="User" />, or <see langword="null" /> if this client is not logged in.
/// </value>
public IUser? CurrentUser { get; internal set; }
public User? CurrentUser { get; internal set; }
/// <summary>
/// Gets the world to which this client is currently connected.
@ -399,7 +399,7 @@ public sealed partial class VirtualParadiseClient : IDisposable
if (CurrentAvatar is not null)
{
// TODO why is this here? we reassign CurrentAvatar right below!
((Avatar)CurrentAvatar).Location = new Location(world);
CurrentAvatar.Location = new Location(world);
}
world.Size = new Size(size, size);
@ -565,7 +565,7 @@ public sealed partial class VirtualParadiseClient : IDisposable
/// -or-
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
public Task<IUserMessage> SendMessageAsync(string message)
public Task<Message> SendMessageAsync(string message)
{
if (message is null)
{
@ -593,9 +593,14 @@ public sealed partial class VirtualParadiseClient : IDisposable
}
}
return Task.FromResult((IUserMessage)new UserMessage(
CurrentAvatar!,
message
Avatar? avatar = CurrentAvatar;
return Task.FromResult(new Message(
MessageType.ChatMessage,
avatar!.Name,
message,
avatar,
FontStyle.Regular,
Color.Black
));
}
@ -615,7 +620,7 @@ public sealed partial class VirtualParadiseClient : IDisposable
/// -or-
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
public Task<IConsoleMessage> SendMessageAsync(string message, FontStyle fontStyle, Color color)
public Task<Message> SendMessageAsync(string message, FontStyle fontStyle, Color color)
{
return SendMessageAsync(null, message, fontStyle, color);
}
@ -637,7 +642,7 @@ public sealed partial class VirtualParadiseClient : IDisposable
/// -or-
/// <para><paramref name="message" /> is too long to send.</para>
/// </exception>
public Task<IConsoleMessage> SendMessageAsync(string? name, string message, FontStyle fontStyle, Color color)
public Task<Message> SendMessageAsync(string? name, string message, FontStyle fontStyle, Color color)
{
if (message is null)
{
@ -675,13 +680,14 @@ public sealed partial class VirtualParadiseClient : IDisposable
}
}
IAvatar avatar = CurrentAvatar!;
return Task.FromResult((IConsoleMessage)new ConsoleMessage(
avatar,
avatar.Name,
Avatar avatar = CurrentAvatar!;
return Task.FromResult(new Message(
MessageType.ConsoleMessage,
name,
message,
color,
fontStyle
avatar,
fontStyle,
color
));
}