SS13 для опытных программистов
Похожие руководства: Структура кода SS13 и Руководство по маппингу
Значит, вы знаете, как писать программный код на других языках и хотите краткое руководство для понимания кода SS13? Этот гайд для вас. Вероятно, здесь представлена не вся информация, которую вам следует знать, но для начала её будет достаточно.
Синтаксис
- Точка с запятой в конце строки не является обязательной,
- Циклы, процедуры, объекты, переменные и т.п. блоки определяются отступами (сходство с Python). Примеры:
/obj var i1 i2 i3
идентично коду: (Крайне рекомендуется использовать подобный вариант разметки, для упрощения поиска объявлений переменных и процедур в дальнейшем)
/obj var/i1 var/i2 var/i3
что в свою очередь эквивалентно:
/obj/var/i1 /obj/var/i2 /obj/var/i3
- Руководство использует термин объект для любых определенных типов (см. Типы переменных), и obj для производных
atom/obj
, все из которых являются объектами, которые могут быть размещены на игровой карте. - Руководство использует термин 'подконтрольный ИИ' для описания поведения, связанного с игроком в роли ИИ, контролирующего предмет. Термин 'подконтрольный игре' используется, отсылаясь к поведению, которое определяет сам скрипт. (Существ с подобным поведением обычно называют существами, подконтрольными ИИ, или NPC)
- Все унаследовано от родительских объектов. Если переменная определена в
/obj/item
, её не нужно будет (на самом деле, нельзя) определять в/obj/item/weapon
.
Переменные (Источник)
Переменные - это база. В BYOND переменные общие, не существует большой разницы при определении строковых, числовых, булевых и т.д. (Как в PHP)
Предопределенные переменные (Источник)
В BYOND существует большое количество предопределенных переменных, самые основные из них:
- src - эквивалентна объекту, содержащему процедуру или переменную. При определении принимает тот же тип, что и этот объект. (Аналогично
this
из Java или C++) - usr - переменная сущности (моба) (
var/mob/usr
), содержит сущность игрока, исполнившего текущий оператор или чье действие в конечном счете вызвало текущую процедуру. Хорошее правило из практики: никогда не помещатьusr
в процедуру. Еслиsrc
не будет верным выбором, лучше отправить другой аргумент в процедуру с необходимой информацией. - args - список аргументов, принятых в процедуре или операторе.
- vars - список переменных-объектов. Если использовать имя переменной в качестве индекса списка, возвращает значение этой переменной.
Больше переменных описано здесь: Предназначение основных переменных в коде SS13
Определение переменных
Базовое определение
var/j var/i = 4 var/a, b, c
Комплексное определение
Основной синтаксис: var/type/variable_name = value
(из источника)
Примеры:
var/obj/item/I = new/obj/item I.name = "Some item"
Определение блока данных (datum) и объявление переменной этого типа данных (test_datum):
datum/test_datum var/test_variable = 0 //объявляем переменную test_variable proc/set_as(var/i) //объявление процедуры в рамках test_datum test_variable = i //присваиваем test_variable значение из аргумента var/datum/test_datum/TD = new/datum/test_datum //TD будет указателем на блок данных типа test_datum TD.test_variable = 4 //Byond не знает о приватных переменных, так что можно присваивать им значение таким образом world << TD.test_variable //вернет 4 всем подключенным пользователям TD.set_as(10) //Вызовет процедуру set_as в блоке данных TD с аргументом 10 TD.test_variable //вернет 10 всем подключенным пользователям
Битовый флаг
Битовые флаги (Bitflags) - это переменные, использующие биты вместо чисел для определения условий. Битовые операторы: & (поразрядное И) и | (Поразрядное ИЛИ). Данные операторы используют двоичную систему счисления для определения результата. Таким образом, 13 & 3 вернет 1. (1101 & 0011 = 0001) и 13 | 3 = 15 (1101 | 0011 = 1111) (см. #IF (ЕСЛИ))
Типы переменных
- datum - обычный тип объекта (классы из Java)
- atom - атомарные переменные, превращаются в obj, turf, mob и area
- turf - плитки, составляющие полов, стен и космоса в SS13
- area - зоны, сгруппированные локации. Объединяют множество turf с похожими свойствами. Определяют электроснабжение, атмосферу и т.п.
- mob - живое существо, контролируемое игрой или игроком.
- obj - объекты, которые могут быть размещены на карте.
- client - объект клиента, создаваемый при подключении игрока
- list - список элементов. Первый элемент списка L определяется как L[1]
- world - переменная, в которой могут быть определены глобальные переменные игрового мира. Переменные в world содержат все атомарные переменные, присутствующие в игровом мире.
Вывод сообщений
Самым простым способом вывода сообщений является использование оператора <<.
world << "Hello World!" //Выводит сообщение всем клиентам, подключенным к миру. usr << "Hello usr" //Выводит сообщение только для пользователя, который вызвал процедуру с данным оператором.
Вывод значений переменных
var/s1 = "Привет" var/s2 = "Мир" var/i = 2011 var/j = 2022 world << "[s1] [s2], руководство написано в [i], переведено в [j]" //Возвращает "Привет Мир, руководство написано в 2011, переведено в 2022"
Определение типов переменных в коде
Процедура istype() вам пригодится.
Пример:
var/obj/item/weapon/W = new/obj/item/weapon/baton if(istype(W,/obj/item/weapon/baton)) world << "Это - baton!"
Второй аргумент необязателен, если опущен, переменная будет проверена на соответствие объявленному типу:
var/obj/item/weapon/W = new/obj/item/weapon/baton if(istype(W)) world << "Это - weapon!"
Стандартный код для получения аргументов из переменных, которые имеют тип, являющийся подклассом типа, с которым их обрабатывает текущая процедура (см. пример любой процедуры Attackby()). Обратите внимание, что приведенный ниже пример относится к процедуре, которая определена глобально и не привязана к объекту. Не имеет смысла делать это так, но это работает в рамках примера. Объекты /obj не имеют переменной 'amount', она определена в /obj/item/stack (как показано в упрощенном определении классов ниже. Также обратите внимание, где var/ используется, а где нет).
/obj var/name = "Object" /obj/item name = "Item" /obj/item/stack name = "Stack" var/amount = 50 proc/get_amount(var/obj/O) if(istype(O,/obj/item/stack)) var/obj/item/stack/S = O return S.amount
Другой способ проделать такое. Он существует исключительно для демонстрации.
proc/get_aount(var/obj/S) if(istype(O,/obj/item/stack)) return O:amount
Оператор двоеточия (:) в примере выше сообщает компилятору: "Я знаю, что делаю, не обращай внимание на тот факт, что объект не имеет этой переменной. Я сам проверю, что оно работает." Проблема в том, что люди будут использовать ваш код так, как вы никогда не планировали. Это значит, что что-то может заставить 0:amount выдать исключение в виде ошибки Runtime Error. Некоторые переменные, возможно, в конечном итоге потребуется удалить или заменить, и это будет невозможно, когда они используются с object:variable, поскольку компилятор не выдаст ошибку при удалении переменной. Ошибка станет очевидной только после того, как игра будет запущена на реальном сервере, что может привести к ее сбою. Так что никогда не используйте этот метод.
Вот вам еще несколько источников:
istype() proc:
isarea(variable) = istype(variable, /area)
isicon(variable) = istype(variable, /icon)
ismob(variable) = istype(variable, /mob)
isobj(variable) = istype(variable, /obj)
isturf(variable) = istype(variable, /turf)
isloc(variable) = ismob(variable) || isobj(variable) || isturf(variable) || isarea(variable)
Переключение между типами переменных
Предопределены BYOND:
ascii2text
file2text
list2params
num2text
params2list
text2ascii
text2file
text2num
text2path
time2text
Определены в SS13:
text2dir(direction)
dir2text(direction)
dd_file2list(file_path, separator)
dd_text2list(text, separator, var/list/withinList)
dd_text2List(text, separator, var/list/withinList)
dd_list2text(var/list/the_list, separator)
angle2dir(var/degree)
angle2text(var/degree)
Больше полезных процедур:
code/defines/procs/helpers.dm
code/game/objects/items/helper_procs.dm
IF (ЕСЛИ)
If обычно проверяет на истинность условия, если не указано иное. За ложность в других типах переменных принимаются такие значения, как empty
, 0
или отсутствие значения (null
).
if(condition) action_true() else action_false()
Поведение переменных в операторе If
Тип переменной | Ложно когда | Истина когда |
---|---|---|
String (Text/ASCII) | "" или null | Все остальное |
Int, Real | 0 или null | Все остальное |
datum, atom | null | Все остальное |
Логические операторы
Стандарт:
! (НЕ) //НЕ выражение1 && (И) //выражение1 И выражение2 || (ИЛИ) //выражение1 ИЛИ выражение2 == (РАВНО) //выражение1 РАВНО выражению2 != (НЕ РАВНО) //выражение1 НЕ РАВНО выражению2 < (МЕНЬШЕ) (<= (НЕ БОЛЬШЕ)) //1 меньше или равно 2 > (БОЛЬШЕ) (>= (НЕ МЕНЬШЕ)) //1 больше или равно 2 & (Поразрядное И) //13 & 3 = 1 (1101 & 0011 = 0001) | (Поразрядное ИЛИ) //13 | 3 = 15 (1101 | 0011 = 1111)
BYOND не распознает оператор === (эквивалентность).
Больше операторов: Источник (левое меню)
While
BYOND совершит выход из цикла, как только он достигнет определенного числа повторов (итераций) и выдаст runtime ошибку из опасений попасть в бесконечный цикл. То же относится к рекурсиям. Также, как и везде:
while(condition) action1()
Все циклы понимают команды continue
и break
For
For объединяет for-циклы и foreach-циклы:
For цикл
for(var/i = 1; i <= 10; i++) world << i //Выведет в каждой строке числа 1 2 3 4 5 6 7 8 9 10
For each цикл
for(var/obj/item/weapon/baton/B in world) //итерации над каждым объектом из world.contents (все атомы игрового мира) и берет для обработки только объекты типа /obj/item/weapon/baton
B.name = "Smelly baton" //Присвоит новое имя предмету "baton" в текущей итерации
Do..While
Оператор Do..while обычно не используется в коде SS13, хотя BYOND его поддерживает.
var/i = 3 do world << i-- while(i)
Определение объектов
Неважно, хотите ли вы создать datum или atom-объект, определение объектов этих двух типов одинаково просто:
/obj/item/weapon/item1 //создаст новый объект типа obj.
var/item_property = 5 //определяет новый тип переменных для всех объектов item1
name = "Testing Item" //переменная name уже определена в родительских объектах, поэтому в этой строке только присваивается новое значение
/obj/item/weapon/item1/New() //Конструктор процедуры New()
..() //всегда присутствует в процедуре New(), см. ..()
item_property = 3 //выполняемое действие в конструкторе объекта.
Procs (Методы, функции, процедуры)
Вы привыкли к стандартным функциям и методам, верно? Ну, procs опускают несколько аспектов. Их можно сравнивать с методами Java, поскольку связаны с конкретными объектами. Они не могут быть определены как static-, private-, public-методы. Статичные методы можно написать, однако компилятор не будет наказывать за вызов функции нестатическим способом или в нестатической среде. То же применимо к нестатичным методам
proc/proc_name(var/argument1, var/argument2) world << "[argument1] [argument2]"
Код выше определяет глобальнукю процедуру. Если вы хотите привязать его на конкретный уровень
..()
То же самое, что и super()
из Java. Вызывает процедуру родительского класса с тем же именем и параметрами.
Пример:
/obj/item name = "Item" /obj/item/New() //New() вызывается при создании объекта данного типа. Конструктор, если угодно. src.name = "It's an item!" /obj/item/stack name = "Stack" /obj/item/stack/New() src.name = "It's a stack!" ..()
При наличии кода, похожего на пример выше и создании нового объекта типа /obj/item/stack
, сначала в мире появится объект с именем "Stack", поскольку это определено по умолчанию. Следом сразу будет вызвана процедура New(). Это изменит имя объекта на "It's a Stack!" но вызов New() родительского типа командой ..() назначит имя "It's an item!". В конце концов, объект получит имя "It's an item!". Команда ..() важна во многих ситуациях, когда что-то определено только в процедуре New() родителя. В Del(), процедуре, которая вызывается преимущественно при удалении объекта, от кода потребуется перейти к корневому Del(), даже чтобы удалить его. Примеры Del() можно найти в коде.
Важные процедуры
New()
Процедура вызывается каждый раз, когда создается экземпляр объекта. При необходимости можно присвоить аргументы. Должна вызвать ..() где это применимо, чтобы сработали родительские конструкторы.
Если у вас возникла необходимость в процедуре New() для atoms с отдельым набором аргументов, убедитесь, что первый аргумент определяет локацию объекта. Пример:
obj/item/weapon/my_item/New(var/location, var/i) ..() //Код и все, что он делает
Для создания основного объекта
new /datum/test_datum
Для создания atom (обычно имеет локацию)
new /obj/item/weapon(src.loc)
Для создания своего объекта из примера выше, код будет выглядеть так: цифра 5 - пример значения, примененного к var/i в конструкторе.
new /obj/item/weapon/my_item(src.loc, 5)
где src - владелец процедуры, содержит строку выше. src.loc - локация объекта src.
Del()
Процедура, вызываемая перед удалением объекта. Она ДОЛЖНА вызвать ..() в конце, поскольку само удаление происходит в корневой процедуре Del().
Объект удаляется при вызове del(O), где O - объект, подлежащий удалению.
attack_hand(mob/M as mob)
Вызывается, когда user (M) нажимает на объект пустой активной рукой
attack_paw(mob/M as mob)
Вызывается, когда monkey (M) нажимает на объект пустой активной рукой
Если своей вариации attack_paw(mob/user) для atom не было расписано, по умолчанию вызовется attack_hand(user)
attack_ai(mob/user)
Вызывается, когда ИИ/киборг нажимает на объект пустой активной рукой
Если своей вариации attack_ai(mob/user) для atom не было расписано, по умолчанию вызовется attack_hand(user)
attack(mob/M as mob, mob/user as mob)
Вызывается, когда объект использовался для атаки моба M со стороны user
attackby(obj/item/W, mob/user)
Вызывается, когда объект атакован user при помощи W (Пример: клик по проводам кусачками)
ex_act(severity)
Определяет реакцию объекта на взрыв (severity=1-3, 1 - наиболее разрушительный).
blob_act()
Определяет реакцию предмета на атаку блоба (магмы)
emp_act(severity)
Определяет реакцию предмета на ЭМИ (severity=1-2, 1 - более мощные последствия).
Topic(href, href_list)
Вызывается при нажатии на ссылку во всплывающем окне. Пример: увеличение выходной мощности на ячейках SMES. Переменная href_list важна, поскольку является проанализированной версией аргументов, которые вы добавляете в ссылку. Для создания ссылки во всплывающем окне, добавьте в отображаемый текст следующее:
dat += text("<A href='?src=\ref[src];select=[i]'>[src.name]</a><br>")
Примеры использования ищите в коде.
process()
Вызывается для всех объектов в каждом тике. Избегайте использования данной процедуры, если возможно, поскольку сильно грузит процессор, однако для некоторых механик избежать её использования нельзя.
SS13 common variable meanings
Datum
Datums have the smallest number of pre-defined variables. These are present in all objects in the game:
type //The type of an object. If your object is of type /obj/item/weapon/shovel writing the following: new src.type(src.loc) will make another shovel in the same tile. parent_type //Parent type of /obj/item/weapon/shovel is /obj/item/weapon... seems streight-foward enough. tag //The tag is used to help you identify things when using several instances. It has to be set manually for each instance tho. Lazy coders and mappers resulted in not many tags being used. Instances in the map editor are sorted by tag. vars //List of object vars the datum has defined
Atom
These variables are shared by all areas, mobs, objs and turfs.
contents //List of contents. Closets store their contents in this var as do all storage items. All the items on a turf are in the turf's contents var. density //If density is at 0, you can walk over the object, if it's set to 1, you can't. desc //Description. When you right-click and examine an object, this will show under the name. dir //Object direction. Sprites have a direction variable which can have 8 'legal' states. gender //not used icon //The dmi file where the sprite is saved. Must be written in single quotations (Example: 'items.dmi') icon_state //The name of the sprite in the dmi file. If it's not a valid name or is left blank, the sprite without a name in the dmi file will be used. If such a sprite doesn't exist it will default to being blank. invisibility //Invisibility is used to determine what you can and what you can't see. Check the code or wait for someone who knows how exactly this works to write it here. infra_luminosity //Only mecha use this underlays //List of images (see image() proc) which are underlayed under the current sprite overlays //List of images (see image() proc) which are overlayed over the current sprite loc //Contains a reference to the turf file where the object currently is. layer //A numerical variable which determins how objects are layered. Tables with a layer of 2.8 are always under most items which have a layer of 3.0. Layers go up to 20, which is reserved for HUD items. luminosity //How much the item will glow. Note that the picking up and dropping of luminous items needs to be specially handled. See flashlight code for an example. mouse_over_pointer //not used mouse_drag_pointer //(almost) not used mouse_drop_pointer //not used mouse_drop_zone //not used mouse_opacity //Used in a few places. Check the description in the reference page name //The name of the object which is displayed when you right click the object and in the bottom left of the screen when you hover your mouse over it. opacity //Whether you can see through/past it (glass, floor) when set to 0 or whether you can't (walls, mecha) when set to 1. pixel_x //How many pixels in the x direction should the sprite be offset from the starting set. See the APC's New() proc for an example and how fire alarms are defined on the map. pixel_x = -5 will move it 5 pixels to the left and pixel_x = 5 will move it 5 pixels to the right pixel_y //Same as pixel_y but in the y direction. Positive values move it to the north, negative to the south. pixel_z //Used in isometric maps, so it's not used in SS13 suffix //Rarely used. See the reference page for more information text //How to represent the object on text clients. Not used. type //The type of the object vars //See Datum above verbs //The verbs you can use with the item. Verbs are the options in the right click menu. x //X position, read only. Set the loc variable to move it or use the inbulit functions. y //Y position, read only. z //Z position (Which z-level it's on), read only.
Area
var/requires_power = 1 //Areas which are to work without an APC (Such as centcom areas) should have this at 0. All other areas should have it at 1. var/music = null //Music to be played when you enter the area. luminosity = 0 //Areas which should be lit at all times (such as space and centcom) should have this at 1 as well as the sd_lighting var at 0 var/sd_lighting = 0 //This var determines whether dynamic lighting is to be calculated for the area's tiles. Turn this to off only for areas which have the luminosity var set to 1
Most other variables exist only for technical reasons and should not be messed with unless done through existing procs, they are defined in:
code/game/area/Space Station 13 areas.dm
Mob
There is a huge amount of variables for mobs. Take a look at the following files:
code/defines/mob/mob.dm code/defines/mob/dead/observer.dm code/defines/mob/living/living.dm code/defines/mob/living/carbon/carbon.dm code/defines/mob/living/carbon/human.dm code/defines/mob/living/carbon/monkey.dm code/defines/mob/living/silicon/silicon.dm code/defines/mob/living/silicon/ai.dm code/defines/mob/living/silicon/robot.dm
There are also additional files for aliens, larva, facehuggers and more there, but the files above will have most of the variables you might need.
Obj
var/m_amt = 0 // How much metal the item has. Used to determine how much metal you get when feeding it into an autolathe and how much it costs to produce it at the lathe var/g_amt = 0 // How much glass the item has. Used to determine how much glass you get when feeding it into an autolathe and how much it costs to produce it at the lathe var/w_amt = 0 // waster amounts. Not used var/origin_tech = null //Used by R&D to determine what research bonuses it grants. See examples in item definitions in code. var/reliability = 100 //Used by SOME devices to determine how reliable they are. The number represents the percentual chance for them to work properly. var/unacidable = 0 //universal "unacidabliness" var, objects with this set to 1 cannot be destroyed by acids. var/throwforce = 0 //The amount of damage applies to a target when they're hit by the item.
More variables are defined in:
code/defines/obj.dm
Item
Items are objs which can be picked up. They're divided into several categories according to their function.
/obj/item is defined in the following file:
code/defines/obj.dm
It adds the following variables (Look at the file for more, but these are the more important ones):
var/force = null //This determins how much damage the target takes when they're attacked by the item in hand. Small items usually have it at 0, medium ones between 5 and 10, rare and powerful items around 10-15 and two-handed items at 15 and more. Syndicate items have it even higher at 40 and more. var/item_state = null //This it the var that determines which sprite will be used for the item from icons/mob/items_lefthand.dmi and items_righthand.dmi. var/damtype = "brute" //Determines what damage type the item produces. var/health = null //Some items use this to determine when they'll break from use or damage. Not common tho. var/hitsound = null //Sound that's played when you hit something with the item. Not commonly used. var/w_class = 3.0 //Weight class. // w_class = 1 means it's an item that can fit in a pocket (diskette, pen, cigarette packet) // w_class = 2 means the item can't fit in pockets but can fit in a box (clipboard, analyzer, cleaner) // w_class = 3 means the item can't fit in a box but can fit in backpacks (box, rods, metal) // w_class = 4 means the item can't even fit in a backpack (packpack, pickaxe, fireaxe) // w_class = 5 is used but not for weight classes. var/wielded = 0 //Used for double-handed items which can be carried in one hand but needs to be wielded by two hands before they can be used. This is determined by code when wielding and unwielding. All items should start with this at 0. var/twohanded = 0 ///Set this to 1 if your item is two-handed. flags = FPRINT | TABLEPASS //Flags
Machinery
Defined in:
code/defines/obj/machinery.dm
Machinery are objs which cannot be picked up and generally require power to operate. They have the following vars defined for all of them:
var/use_power = 0 //Determines if and how much power the machine will use each tick. //use_power = 0 - no power is used //use_power = 1 - idle power is used //use_power = 2 - active power is used var/idle_power_usage = 0 //How many watts of power the machine will use each tick when use_power is set to 1 var/active_power_usage = 0 //How many watts of power the machine will use each tick when use_power is set to 2 var/power_channel = EQUIP //Determines which APC power category the device falls under. EQUIP, ENVIRON or LIGHT var/list/component_parts = null //A list of parts needed to construct the machine from a machine frame.
Turf
var/intact = 1 //This determines if the turf will hide pipes, cable and such. Set to 1 to hide and to 0 to not hide them. Only pipes and wire with level set to 1 will be hidden. Set their level var to 2 to keep them from being hidden. var/blocks_air = 0 //Determines if the turf prevents air from passing (walls) if set to 1.
Other variables exist but they're tied to atmospherics code which is not to be touched as whenever anything is changed in it it results in a million things breaking.
code/defines/turf.dm
Simulated
Simulated floors are tiles which simulate air movement and temperature. The station is made entirely from these while centcom is made from unsimulated floors to prevent massive and unneeded lag.
var/wet = 0 //If this it a positive number, it is wet and you'll slip on it if you run. var/thermite = 0 //Will be set to 1 when thermite is poured on it.
Simulated floors
var/icon_regular_floor = "floor" //Determines what icon the steel version of the floor should have. Determined at floor creation (New() proc). If the icon_state of the floor at that point is one from the global icons_to_ignore_at_floor_init var, then this variable is assigned the value "floor". The icons_to_ignore_at_floor_init list contains broken, plating, burnt and non-steel icon_states from icons/turf/floors.dmi heat_capacity = 10000 //When a fire (hotspot) on the tile exceeds this number, the floor has a chance of melting. The more the number is exceeded, the higher the chance of melting. var/broken = 0 //This mostly only determins if you'll get the tile back when you use the crowbar var/burnt = 0 //This mostly only determins if you'll get the tile back when you use the crowbar var/obj/item/stack/tile/floor_tile = new/obj/item/stack/tile/steel //What floor tile is on the tile
Simulated floors are defined in:
code/game/turf.dm
Simulated walls
Doesn't really contain any special new variables.
Defined in:
code/defines/turf.dm
Как внести свой вклад? | |
---|---|
Общее | Руководство по разработке |
Сервер | Настройка базы данных, Запуск локального сервера |
Код | Структура кода SS13, SS13 для опытных программистов, Форматирование текста, Как делать перевод игры |
Маппинг | Руководство по маппингу |
Спрайтинг | Руководство по спрайтингу |
Вики | Руководство по редактированию вики |