插件,脚本和命令

目录

  1. 入门

    1. 插件基础
    2. 您的第一个插件
    3. 开发环境
    4. 调试
    5. Action API
    6. 发布插件
  2. 高级

    1. 插件捆绑
    2. 插件,脚本和命令
    3. 插件位置
    4. 更多关于CocoaScript
    5. SketchTool

Sketch中的插件定义了一个或多个命令,其中Sketch将显示菜单项。

这些命令中的每一个实际上都是作为一个JavaScript函数实现的(我们称之为处理程序),位于该包中的脚本文件中。

每个脚本可以包含尽可能多的处理程序,并且每个命令都可以由不同的处理程序实现,因此,无论您是按照每个命令安排一个脚本,还是将所有命令处理程序放在单个脚本文件中,都由您决定。

因此,要了解如何制作插件,首先需要了解如何编写Sketch脚本。

教你如何编写JavaScript代码超出了这些页面的范围,所以我们假设你已经知道了这一点。如果没有,互联网上有很多好的学习资源

脚本语法

Sketch中的脚本使用CocoaScript编写。

这是一个桥梁,可让您编写可调用本机Objective-C / Cocoa的JavaScript脚本。

使用它,你可以用JavaScript编写你的插件的逻辑,但是当你想让它做某事时,可以调用实现Sketch的实际类和方法。

基础如下:

  • 你会像往常一样编写JavaScript代码
  • 使用桥接器,您可以从主机应用程序(在本例中为Sketch)或从系统本身获取Objective-C对象
  • 基本的Objective-C对象具有等同的JavaScript(如字符串和数字),通常可以以与JS版本相同的方式使用
  • 您可以像在JS中一样读取和写入自定义Objective-C对象的属性
  • 您可以使用熟悉的JavaScript语法或Objective-C方括号语法来调用自定义Objective-C对象的方法。

(有关更多详细信息,请参阅更多关于CocoaScript页面。)

当您的脚本被Sketch调用时,您会传递一些上下文,包括表示当前Sketch文档和选择的Objective-C对象。

然后,您可以读取属性,执行计算并调用这些对象的方法,以完成脚本的目的。

脚本上下文

当用户选择插件菜单命令时,Sketch会查找要调用的处理程序(CocoaScript函数)以及调用它的脚本文件。

当处理程序被调用时,它会传递一个上下文变量。这包含一些重要的属性,您可以使用它们访问您需要的对象。

例如,selection属性为您提供当前文档中选定图层的列表:

var onRun = function(context) {
  var selection = context.selection
  for (var i = 0; i < selection.count(); i++) {
    var layer = selection[i]
    log('layer ' + layer.name + ' is selected.')
  }
}

Sketch中的所有插件都可以访问以下默认变量:

  • commandMSPluginCommand表示当前正在执行的脚本命令的对象
  • 文档MSDocument代表当前文档的对象
  • pluginMSPluginBundle表示包含当前正在执行的脚本的插件包的对象
  • scriptPathNSString包含当前正在执行的脚本的完整路径
  • scriptURL:与scriptPath类似,但是作为NSURL对象
  • 选择NSArray当前文档中选择的一个或多个图层; 这个数组中的每一项都是一个MSLayer对象

尝试脚本

尝试简单脚本的最简单方法是通过插件>自定义插件...菜单项。

这给你一个文本字段,你可以输入你的脚本。

点击运行按钮将执行脚本并在下面板显示任何输出或错误。

您可以使用此界面进行探索和实验。

创建一个插件

一旦你有一个你想要开发成适当的插件的脚本,你可以使用Run Custom Script ...表单中的Save ...按钮。

这将创建一个Plugin文件夹(称为Plugin Bundle)并将脚本保存到其中。

生成的插件将具有单个命令和单个脚本文件。执行该命令将调用onRun脚本中的函数,该函数将包含您输入的代码。

从这个起点开始,您可以通过直接编辑文件夹中的文件来扩展您的插件。

你可以添加更多的代码到你的onRun函数,添加更多的功能,甚至更多的脚本文件。

通过编辑manifest.json插件文件夹中的文件,您可以自定义命令的名称,输入描述,甚至可以展开插件以定义多个命令。

有关更多信息,请参阅插件包

原文:https://developer.sketchapp.com/guides/plugin-scripts/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355