Modding:World Access: Difference between revisions

<languages/>

<translate>

Let's Take our basic mod init code for a server mod

<syntaxhighlight lang="c#">

     public class SampleMod : ModSystem

         ICoreServerAPI api;

         {

             return side == EnumAppSide.Server;

         {

             this.api = api;

</syntaxhighlight>

With this you can already start placing or reading blocks using the api object. Please note that mods are loaded before the world is loaded, so you cannot immediately access the world. Depending on what you want to achieve, you have to register to the appropriate event. For some examples in order to do something...

* after the world has loaded you could register to the RunGame phase: <code>api.Event.ServerRunPhase(EnumServerRunPhase.RunGame, OnRunGame);</code>

* when a player joins the game: <code>api.Event.PlayerJoin += OnPlayerJoin;</code>

Let's register to the player join event.  

<syntaxhighlight lang="c#">

         public override void StartServerSide(ICoreServerAPI api)

         }

         {

              

</syntaxhighlight>

Let's do 2 simple things whenever a player joins:

* Always place some fire clay bricks just below his feet

* Count the amount log blocks around the player in a 3 block radius

Now, blocks are always uniquely identified by a number of characters called the block code. If you want to find out a blocks code, a simple way of doing it is to start the game, enable the debug info mode via the command <code>.edi</code> and look at a block in the creative inventory:

[[File:Blockcode.png]]

So the code of a fire brick block is game:claybricks-fire. The first part before the colon is the domain, for the default domain 'game' we can usually ignore it.

We now have to retrieve it's number identifier for this particular world in order to get or set it. We do this as followed:

<syntaxhighlight lang="c#">

         private void OnPlayerJoin(IServerPlayer byPlayer)

</syntaxhighlight>

Now all we have to do is set the block right below the players position through the IBlockAccessor interface.

<syntaxhighlight lang="c#">

             BlockPos plrpos = byPlayer.Entity.Pos.AsBlockPos;

</syntaxhighlight>

We're using <code>plrpos.DownCopy()</code> to keep the original player position for later use and to move the position down by 1 for placing the block below the player.

And finally let's count the number of log blocks around the player and inform him via chat message.  

<syntaxhighlight lang="c#">

             // Check a 7x7x7 area for logs

                         Block block = api.World.BlockAccessor.GetBlock(plrpos.X + x, plrpos.Y + y, plrpos.Z + z);

                         {

                             quantityLogs++;

             }

</syntaxhighlight>

Alternatively we could also use a shorthand method to have more elegant code.

<syntaxhighlight lang="c#">

             int quantityLogs = 0;

             );

</syntaxhighlight>

And the complete code and final result:

<syntaxhighlight lang="c#">

         private void OnPlayerJoin(IServerPlayer byPlayer)

             BlockPos plrpos = byPlayer.Entity.Pos.AsBlockPos;

             ushort blockId = firebrickblock.BlockId;

             api.World.BlockAccessor.SetBlock(blockId, plrpos.DownCopy());

             int quantityLogs = 0;

             api.World.BlockAccessor.WalkBlocks(

             );

         }

</syntaxhighlight>

[[File:SetblockTut.png|500px]]

   

I hope this taught you the basics of accessing the world. More ways to access blocks and entities will be added here in the future.

</translate>