Modding:Commands: Difference between revisions

From Vintage Story Wiki

Modding:Commands (view source)

Revision as of 17:04, 27 March 2024

439 bytes removed ,  1 month ago
m
Updated navbox to new code navbox.
No edit summary
m (Updated navbox to new code navbox.)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{GameVersion|1.15}}
<languages/>
 
{{GameVersion|1.19.3}}
<translate>
<!--T:1-->
Ever wanted to know how to add a command to the game? If yes, this is the right place to get an answer.
Ever wanted to know how to add a command to the game? If yes, this is the right place to get an answer.


== Preparations ==
== Preparations == <!--T:2-->


The idea is to add a command which makes it easier for your mates to locate you. Therefore we will spawn some particles alongside a playing sound, so others can see and hear where you are at the moment.
<!--T:3-->
The idea is to add a command which makes it easier for your friends to locate you. Therefore we will spawn some particles alongside a playing sound, so others can see and hear where you are at the moment.


You can download the required assets [https://wiki.vintagestory.at/images/1/16/Here_Assets.zip here]. Just extract them in your mods directory and you are good to go.
== Implementation == <!--T:7-->
 
As always, we need to create a class extending <code>ModSystem</code>:
== Implementation ==
 
First of all you need to add another mod to your workspace. I will use the modid <code>here</code>, so I will type in <code>add here</code> in modtools to create a new mod. Additionally I will create <code>Command.cs</code> in the <code>src</code> directory.
 
As always we need to create a class extending <code>ModSystem</code>:
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
public class CommandMod : ModSystem
public class CommandMod : ModSystem
{
{


<!--T:8-->
}
}
</syntaxhighlight>
</syntaxhighlight>


Commands are processed by the server, so our mod only needs to load on the server's side:
<!--T:9-->
We will be creating a server-side command, so our mod only needs to load on the server's side:
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
         public override bool ShouldLoad(EnumAppSide side)
         public override bool ShouldLoad(EnumAppSide side)
Line 29: Line 29:
</syntaxhighlight>
</syntaxhighlight>


Now we need to register the command itself:
<!--T:10-->
Now we need to create the command itself:
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
         public override void StartServerSide(ICoreServerAPI api)
         public override void StartServerSide(ICoreServerAPI api)
         {
         {
             base.StartServerSide(api);
             base.StartServerSide(api);
             api.RegisterCommand("here", "spawns particles around the player", "",
            AssetLocation sound = new AssetLocation("here", "sounds/partyhorn");
                (IServerPlayer player, int groupId, CmdArgs args) =>
             api.ChatCommands.Create("here")
                    {
            .WithDescription("spawns particles around the player")
 
            .RequiresPrivilege(Privilege.chat)
                    }, Privilege.chat);
            .RequiresPlayer();
         }
         }
</syntaxhighlight>
</syntaxhighlight>


<!--T:12-->
This command can be used by any player who is allowed to send a message (by default everyone). When a player types in <code>/here</code>, the command will be executed. Now we the only thing missing is the actual code to spawn particles and to play the sound.
This command can be used by any player who is allowed to send a message (by default everyone). When a player types in <code>/here</code>, the command will be executed. Now we the only thing missing is the actual code to spawn particles and to play the sound.


<!--T:13-->
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
         public override void StartServerSide(ICoreServerAPI api)
         public override void StartServerSide(ICoreServerAPI api)
         {
         {
             base.StartServerSide(api);
             base.StartServerSide(api);
             AssetLocation sound = new AssetLocation("here", "sounds/partyhorn"); // Create sound location
             AssetLocation sound = new AssetLocation("here", "sounds/partyhorn");
             api.RegisterCommand("here", "spawns particles around the player", "",
             api.ChatCommands.Create("here")
                (IServerPlayer player, int groupId, CmdArgs args) =>
            .WithDescription("spawns particles around the player")
                    {
            .RequiresPrivilege(Privilege.chat)
                        EntityPlayer byEntity = player.Entity;
            .RequiresPlayer()
                        byEntity.World.PlaySoundAt(sound, byEntity); // Play sound
            .HandleWith((args) =>
 
            {
                        Vec3d pos = byEntity.Pos.XYZ.Add(0, byEntity.EyeHeight, 0); // Setting up position to spawn particles
                var byEntity = args.Caller.Entity;
                        Random rand = new Random();
                byEntity.World.PlaySoundAt(sound, byEntity);
                        for (int i = 0; i < 100; i++) // Spawn 100 particles
                Vec3d pos = byEntity.Pos.XYZ.Add(0, byEntity.LocalEyePos.Y, 0);
                        {
                Random rand = new Random();
                            Vec3d realPos = pos.AddCopy(-0.1 + rand.NextDouble() * 0.2, 0, -0.1 + rand.NextDouble() * 0.2);
                for (int i = 0; i < 100; i++)
                            Vec3f velocity = new Vec3f(-0.2F + (float) rand.NextDouble() * 0.4F, 0.4F + (float) rand.NextDouble() * 2F, -0.2F + (float) rand.NextDouble() * 0.4F);
                {
                            byEntity.World.SpawnParticles(1, ColorUtil.ColorFromRgba(255, rand.Next(0, 255), rand.Next(0, 255), rand.Next(0, 255)),
                    Vec3d realPos = pos.AddCopy(-0.1 + rand.NextDouble() * 0.2, 0, -0.1 + rand.NextDouble() * 0.2);
                                realPos, realPos,
                    Vec3f velocity = new Vec3f(-0.2F + (float)rand.NextDouble() * 0.4F, 0.4F + (float)rand.NextDouble() * 2F, -0.2F + (float)rand.NextDouble() * 0.4F);
                                velocity, velocity, (float) rand.NextDouble()*1 + 1, 0.01F,
                    byEntity.World.SpawnParticles(1, ColorUtil.ToRgba(255, rand.Next(0, 255), rand.Next(0, 255), rand.Next(0, 255)),
                                1, EnumParticleModel.Cube);
                        realPos, realPos,
                        }
                        velocity, velocity, (float)rand.NextDouble() * 1 + 1, 0.01F,
                    }, Privilege.chat);
                        1, EnumParticleModel.Cube);
                }
                return TextCommandResult.Success();
            });
         }
         }
</syntaxhighlight>
</syntaxhighlight>


<!--T:15-->
If you want to learn more about how to use particles you can check out this [[Simple Particles|tutorial]].
If you want to learn more about how to use particles you can check out this [[Simple Particles|tutorial]].


== Testing ==
== Testing == <!--T:16-->


<!--T:17-->
Finally, we are ready to run our first test:
Finally, we are ready to run our first test:


<!--T:18-->
<youtube>XjHMtl6rSF4</youtube>
<youtube>XjHMtl6rSF4</youtube>
 
</translate>
== Download ==
{{Navbox/codemodding}}
 
Feel free to try it out yourself:
 
[https://wiki.vintagestory.at/images/4/47/Here_v1.1.zip Here_v1.1.zip]
 
{{Navbox/modding|Vintage Story}}
Nateonus
Confirmedusers
536

edits

Retrieved from "https://wiki.vintagestory.at/index.php/Special:MobileDiff/27783...175619"