模组:常用方法

来自Stardew Valley Wiki
臭美香喷喷（讨论 | 贡献）2021年6月10日 (四) 05:08的版本
跳到导航 跳到搜索

← 目录

Robin building.png
“ “我这里还有很多事情需要处理。”
— 罗宾

不完整的翻译

本文或部分尚未完全翻译成中文。 欢迎您通过编辑帮助其建设。
最后编辑臭美香喷喷于2021-06-10 05:08:49.

此页面展示了制作SMAPI模组时常见的任务。在阅读时，请结合参考模组制作入门和游戏基本架构。

基础技巧

追踪一个值的变化

在写模组时，你可能常常需要了解一个值的变化（什么时候变，变化前后的值分别是多少，等等）。如果该值没有包括在SMAPI内置的事件 (event)中，那么你可以为该值创建一个私有变量，然后在SMAPI的update tick事件中刷新此变量，以达到追踪值变化的目的。

示例见：[模组:制作指南/APIs/Events#变化监控]

物品 (Items)

物品 代表那些能够放在背包里的东西，比如说工具、农作物等等。

创建一个物品 (Object) 的实例

Object中所有的构造函数： 

 public Object(Vector2 tileLocation, int parentSheetIndex, int initialStack);
 public Object(Vector2 tileLocation, int parentSheetIndex, bool isRecipe = false);
 public Object(int parentSheetIndex, int initialStack, bool isRecipe = false, int price = -1, int quality = 0);
 public Object(Vector2 tileLocation, int parentSheetIndex, string Givenname, bool canBeSetDown, bool canBeGrabbed, bool isHoedirt, bool isSpawnedObject);

参数parentSheetIndex表示该物品的ID（储存在 ObjectInformation.xnb 文件中）。

在地上生成物品

public virtual bool dropObject(Object obj, Vector2 dropLocation, xTile.Dimensions.Rectangle viewport, bool initialPlacement, Farmer who = null);

 // 调用：
 Game1.getLocationFromName("Farm").dropObject(new StardewValley.Object(itemId, 1, false, -1, 0), new Vector2(x, y) * 64f, Game1.viewport, true, (Farmer)null);

添加物品到背包 (Inventory)

// You can add items found in ObjectInformation using:
    Game1.player.addItemByMenuIfNecessary((Item)new StardewValley.Object(int parentSheetIndex, int initialStack, [bool isRecipe = false], [int price = -1], [int quality = 0]));

例2： 

// Add a weapon directly into player's inventory
    const int WEAP_ID = 19;                  // Shadow Dagger -- see Data/weapons
    Item weapon = new MeleeWeapon(WEAP_ID);  // MeleeWeapon is a class in StardewValley.Tools
    Game1.player.addItemByMenuIfNecessary(weapon);

    // Note: This code WORKS.

从背包移除物品

取决于你背包的具体情况。很少有情况需要你亲自来调用，因为相关的方法在Farmer类中已经有了。

在大多数情况下，仅需调用 .removeItemFromInventory(Item) 方法。

地点 (Locations)

见 游戏基本架构#地点。

获取所有地点

Game1.locations属性中虽然储存着主要的地点，但是不包括建筑的室内(constructed building interiors)。以下这个方法提供了主玩家的所有地点。 

/// <summary>Get all game locations.</summary>
public static IEnumerable<GameLocation> GetLocations()
{
    return Game1.locations
        .Concat(
            from location in Game1.locations.OfType<BuildableGameLocation>()
            from building in location.buildings
            where building.indoors.Value != null
            select building.indoors.Value
        );
}

遍历： 

foreach (GameLocation location in this.GetLocations())
{
   // ...
}

注意：在联机模式中，客机是拿不到上述所有地点的。要解决这一问题，见获取有效的地点。

编辑地图

见模组:地图数据。

玩家 (Player)

自定义精灵 (Custom Sprite)

位置 (Position)

角色(Character) 的位置(Position) 表示他在当前地点(Location) 的坐标。

相对于地图 (Map)

每个地点(location) 都有一个对应的xTile地图(map)。如果以像素(pixel) 为单位，地图左上角坐标代表(0, 0)，坐下角则代表(location.Map.DisplayWidth, location.Map.DisplayHeight)。 角色在当前地点的位置有两种表达方式：

  • 以像素(pixel) 为单位的绝对(absoulte) 坐标：Position.X与Position.Y。
  • 以图块(tile) 为单位的图块(tile) 坐标：getTileX()与getTileY()。

常量Game1.tileSize规定，游戏内每个图块(tile) 大小为64x64像素。于是有以下单位换算： 

// 绝对坐标 → 图块坐标
Math.Floor(Game1.player.Position.X / Game1.tileSize)
Math.Floor(Game1.player.Position.Y / Game1.tileSize)

// 图块坐标 → 绝对坐标
Game1.player.getTileX() * Game1.tileSize
Game1.player.getTileY() * Game1.tileSize

// 地图大小（以图块为单位）
Math.Floor(Game1.player.currentLocation.Map.DisplayWidth / Game1.tileSize)
Math.Floor(Game1.player.currentLocation.Map.DisplayHeight / Game1.tileSize)

相对于视野 (Viewport)

视野、视口、视窗(Viewport) 代表在当前屏幕上的区域。若以像素计算，其宽高应该与游戏的屏幕分辨率相等，分别为Game1.viewport.Width和Game1.viewport.Height。

玩家相对于视野的位置（像素）可表示为： 

Game1.player.Position.X - Game1.viewport.X
Game1.player.Position.Y - Game1.viewport.Y

NPC

自定义NPC

想要自定义NPC，你得修改或添加以下文件： 格式： 具体操作：（往）目标文件夹或文件名

  • 添加新文件：Characters\Dialogue\<文件名>
  • 添加新文件：Characters\schedules\<文件名>
  • 添加新文件：Portraits\<文件名>
  • 添加新文件：Characters\<文件名>
  • 在已有文件中添加新的条目：Data\EngagementDialogue（可结婚NPC）
  • 在已有文件中添加新的条目：Data\NPCDispositions
  • 在已有文件中添加新的条目：Data\NPCGiftTastes
  • 在已有文件中添加新的条目：Characters\Dialogue\rainy
  • 在已有文件中添加新的条目：Data\animationDescriptions（在行程(schedule) 中增加自定义的动画）

以上所有的操作都可以通过IAssetLoaders/IAssetEditors或者Content Patcher做到。 最后，你需要调用NPC的构造器来创建实例。 

 public NPC(AnimatedSprite sprite, Vector2 position, int facingDir, string name, LocalizedContentManager content = null);
 public NPC(AnimatedSprite sprite, Vector2 position, string defaultMap, int facingDir, string name, Dictionary<int, int[]> schedule, Texture2D portrait, bool eventActor);
 public NPC(AnimatedSprite sprite, Vector2 position, string defaultMap, int facingDirection, string name, bool datable, Dictionary<int, int[]> schedule, Texture2D portrait);

 // 调用：
 Game1.getLocationFromName("Town").addCharacter(npc);
取自“https://zh.stardewvalleywiki.com/mediawiki/index.php?title=模组:常用方法&oldid=19795”