1. Epic GamesDeveloper
  3. Спецификаторы и атрибуты

Спецификаторы и атрибуты

Узнайте о спецификаторах и атрибутах, а также о том, как применить дополнительную семантику и поведение к коду Verse.

Спецификаторы и атрибуты

Спецификаторы в Verse описывают поведение, связанное с семантикой. Спецификаторы можно добавлять к идентификаторам и некоторым ключевым словам. Для спецификаторов используется синтаксис с угловыми скобками (< и >), между которыми располагается ключевое слово. Например, в IsPuzzleSolved()<decides><transacts>:void, "decides" и "transacts" являются спецификаторами.

Атрибуты в Verse описывают поведение, определяемое за рамками самого языка Verse (в отличие от спецификаторов, которые описывают семантику Verse). Их синтаксис подразумевает использование знака at (@), за которым идёт ключевое слово, например @editable.

Далее описаны все спецификаторы и атрибуты в Verse, а также то, когда их можно использовать.

Спецификаторы эффектов

Эффекты в Verse указывают категории поведения, допустимые для функции. Вы можете добавлять спецификаторы эффектов следующим образом:

  • К круглым скобкам () после имени в определении функции: name()<specifier>:type = codeblock.

  • К ключевому слову class: name := class<specifier>(){}.

Спецификатор Описание Пример

no_rollback

Это эффект, используемый по умолчанию, если не указан исключительный эффект. Эффект no_rollback указывает на то, что любые действия, выполняемые функцией, не могут быть отменены, и поэтому функция не может быть использована в контексте, допускающем неоднозначность. Этот эффект нельзя указать вручную.

name():type = codeblock

transacts

Эффект <transacts> представляет собой комбинацию <allocates>, <reads> и <writes>.  Эффект <transacts> нельзя сочетать с этими спецификаторами.

name()<transacts> : type = codeblock

# недопустимо, поскольку transacts подразумевает чтение

name()<transacts><reads>: type = codeblock

# недопустимо, поскольку transacts подразумевает запись

name()<transacts><writes>: type = codeblock

allocates

Этот эффект указывает на то, что функция может создавать экземпляр объекта в памяти. Если метод вызывается в контексте, который допускает неоднозначность и не выполняется, эффекты аннулируются.

name()<allocates> : type = codeblock

reads

Метод с этим эффектом может читать из изменяемого состояния.

name()<reads> : type = codeblock

writes

Метод с этим эффектом может записывать в изменяемое состояние. Если метод вызывается в контексте, который допускает неоднозначность и не выполняется, эффекты аннулируются.

name()<writes> : type = codeblock

computes

Метод <computes> гарантирует, что всегда будет возвращать один и тот же результат при любых входных данных. Метод <computes> не может быть <transacts>, <reads>, <writes> или <allocates>.

name()<computes>

converges

Этот эффект гарантирует не только отсутствие побочных эффектов при выполнении соответствующей функции, но и то, что функция завершится (без бесконечной рекурсии). Этот эффект может применяться только к функциям со спецификатором native, однако проверка компилятором на это не выполняется. Для этого эффекта необходим код, который используется для предоставления значений по умолчанию для полей класса или значений для глобальных переменных.

name()<converges> : type = codeblock

decides

Этот эффект указывает на то, что функция может завершиться ошибкой и что вызов этой функции является выражением с неоднозначным результатом. Поскольку функция <decides> может завершиться с ошибкой, она является взаимоисключающей с эффектом <suspends>. Можно объединить <decides> с эффектом <transacts> или <computes>, что позволит выполнить откат действий, выполняемых этой функцией (до состояния, когда эти действия ещё не выполнялись), если в какой-либо части функции произойдёт ошибка.

# допустимо

name()<decides><transacts> : type = codeblock

# допустимо

name()<decides><computes> : type = codeblock

# недопустимо, поскольку decides и suspends являются взаимоисключающими

name()<decides><suspends> : type = codeblock

suspends

Этот эффект указывает на то, что функция является асинхронной. Создаёт асинхронный контекст для тела функции. Взаимоисключающий эффект с эффектом <decides>.

name()<suspends> : type = codeblock

# недопустимо, поскольку decides и suspends являются взаимоисключающими

name()<decides><suspends> : type = codeblock

В любом случае, вызов функции, которая имеет определённый эффект, потребует от вызывающей функции наличия аналогичного эффекта.

Спецификаторы доступа

Спецификаторы доступа определяют, что и как может взаимодействовать с составляющей. Спецификаторы обращения можно применять к следующим элементам:

  • К идентификатору составляющей: name<specifier> : type = value

  • К ключевому слову var для составляющей: var<specifier> name : type = value

У вас может быть спецификатор обращения как для идентификатора, так и для ключевого слова var для переменной, чтобы различать, какой элемент может только считывать переменную, а какой — записывать в неё. Например, следующая переменная MyInteger содержит спецификатор public в идентификаторе, поэтому считывать её значения может что угодно, но ключевое слово var имеет спецификатор protected, поэтому записывать в переменную могут только текущий класс и подтипы.

Verse 
var<protected> MyInteger<public>:int = 2
Спецификатор Описание Использование Пример

public

Идентификатор доступен из других частей кода.

Спецификатор можно использовать для следующих типов:

  • модуль (module)

  • класс

  • интерфейс (interface)

  • структура

  • перечисление

  • метод (method)

  • данные

Verse 
name<public> : type = value

protected

Идентификатор доступен только для текущего класса и любых подтипов.

Спецификатор можно использовать для следующих типов:

  • класс

  • интерфейс (interface)

  • структура

  • функции внутри класса

  • перечисление

  • немодульный метод

  • данные

Verse 
name<protected> : type = value

private

К идентификатору можно обращаться только в текущей, непосредственно охватывающие его области видимости (будь то модуль, класс, структура и т. д.).

Спецификатор можно использовать для следующих типов:

  • класс

  • интерфейс (interface)

  • структура

  • функции внутри класса

  • перечисление

  • немодульный метод

  • данные

Verse 
name<private> : type = value

internal

К идентификатору можно обращаться только в текущей, непосредственно охватывающей области видимости в пределах модуля. Это уровень обращения по умолчанию.

Спецификатор можно использовать для следующих типов:

  • модуль (module)

  • класс

  • интерфейс (interface)

  • структура

  • перечисление

  • метод (method)

  • данные

Verse 
name<internal> : type = value

scoped

К идентификатору можно обращаться только в текущей области видимости и всех охватывающих областях видимости. Любые ресурсы, выведенные в Verse и появившиеся в файле Assets.digest.Verse, будут иметь спецификатор <scoped>.

Спецификатор можно использовать для следующих типов:

  • модуль (module)

  • класс

  • интерфейс (interface)

  • функции

  • структура

  • перечисление

  • немодульный метод

  • данные

Verse 
# Enclosing scope for ModuleB and ModuleC.
ModuleA<public> := module:
    
    ModuleB<public> := module:

        # Internal to ModuleB.
        class_b1 := class{}

        # Allows access from anywhere inside ModuleA.
        class_b2<scoped{ModuleA}> := class {}

Спецификаторы класса

Спецификаторы классов определяют характеристики классов или их составляющих, например, возможность создавать подкласс класса.

Спецификатор Описание Пример

abstract

Когда класс или метод класса имеет спецификатор abstract, нельзя создать экземпляр такого класса. Абстрактные классы предназначены для использования в качестве суперкласса с частичной реализацией или в качестве общего интерфейса. Это полезно в тех случаях, когда экземпляры суперкласса не нужны, но необходимо дублировать свойства и поведение аналогичных классов.

Verse 
pet := class<abstract>():
    Speak() : void

cat := class(pet):
    Speak() : void = {}

castable

Указывает на то, что этот тип является динамическим приведением. Спецификатор <castable> имеет ограничение на использование обратной совместимости. После публикации класса или интерфейса атрибут <castable> нельзя ни добавить, ни удалить. Это может привести к небезопасному приведению типов, поэтому такое поведение невозможно.

Тип castable_subtype имеет функции, очень похожие на те, что имеет subtype, но требует, чтобы все используемые с ним типы также помечались <castable>. Это повышает безопасность кода в случаях, когда используются динамические приведения.

Verse 
my_base := class {}

my_castable_type := class<castable>(my_base) {}

my_child_type := class(my_castable_type) {}

MySubtypeFunction(t:castable_subtype(my_base)):void=
    return

Main()<decides>:void =

concrete

Когда класс имеет спецификатор concrete, вы можете создать экземпляр класса с пустым архетипом, что означает, что каждое поле класса должно иметь значение по умолчанию. Каждый подкласс класса concrete также неявно относится к категории concrete. Класс со спецификатором concrete может наследоваться непосредственно от абстрактного класса только в том случае, если оба класса определены в одном и том же модуле.

Verse 
cat := class<concrete>():
     # field must be initialized because the class is concrete
    Name : string = "Cat"

unique

Уникальному классу в Verse присваивается уникальный идентификатор для каждого экземпляра. Это означает, что, даже если два экземпляра одного и того же уникального класса имеют одинаковые значения полей, они не равны, поскольку являются разными экземплярами. Это позволяет определить, одинаковы экземпляры уникальных классов или нет, сравнивая их идентификаторы. Классы без спецификатора unique не имеют таких идентификаторов, поэтому их можно оценивать на эквивалентность только на основе значений их полей. Это означает, что уникальные классы можно сравнивать с помощью операторов = и <> и они являются подтипами типа comparable.

Verse 
unique_class := class<unique>:
    Field : int

Main()<decides> : void =
    X := unique_class{Field := 1}
    X = X # X is equal to itself
    Y := unique_class{Field := 1}
    X <> Y # X and Y are unique and therefore not equal

final

Спецификатор final можно использовать только для классов и составляющих классов со следующими ограничениями:

  • Когда у класса есть спецификатор final, невозможно создать его подкласс.

  • Если спецификатор final указан для поля, вы не сможете переопределить это поле в подклассе.

  • Когда метод имеет спецификатор `final`, невозможно переопределить метод в подклассе.

Verse 
cat := class<final>():

final_super

Спецификатор final_super применяется только к определениям классов и требует, чтобы определение класса наследовалось от родительского класса или интерфейса. Этот спецификатор ограничивает совместимость в будущем — заданный класс всегда будет напрямую наследоваться от родительского для этой и всех будущих опубликованных версий определения этого класса.

Это необходимо в Scene Graph для непосредственных подтипов component, чтобы ограничить количество экземпляров точно нулём или одним экземпляром на модуль Scene Graph. Это ограничение распространяется также на подтипы этих типов.

Verse 
component := class {}
my_final_class := class<final_super>(component) {}

# Not allowed since my_final_class has the final_super specifier.
my_subclass_type := class(my_final_class) {}

Спецификатор сохранения данных

Когда пользовательский тип, например класс, имеет спецификатор <persistable>, это означает, что вы можете использовать его в переменных weak_map, входящих в область видимости модуля, и его значения будут сохраняться в течение всех игровых сеансов. Подробнее о сохраняемых элементах в Verse см. в статье Использование сохраняемых данных в Verse.

Спецификатор persistable можно использовать со следующими типами. Переходите по ссылкам, чтобы узнать о них подробнее.

Спецификаторы open и closed

В настоящее время их можно использовать только с перечислениями. Спецификаторы <open> и <closed> задают, как можно изменять определение перечисления после публикации острова.

Спецификаторы open и closed можно использовать со следующими типами. Переходите по ссылкам, чтобы узнать о них подробнее.

Спецификатор Описание Пример

Open

Спецификатор, который в настоящее время применяется только к перечислениям.

Вы можете добавлять или изменять порядок значений в открытом перечислении или заменить его на <closed> (закрытое) перечисление.

Открытые перечисления лучше использовать, если в дальнейшем количество значений в них увеличится. Пример: перечисление типов оружия.

Verse 
# Enums are <closed> by default so you must explicitly define the enum as an open enum with the <open> specifier
my_enum := enum<open>{Value1, Value2, Value3}

Закрытые

Спецификатор, который в настоящее время применяется только к перечислениям.

Перечисления по умолчанию являются закрытыми.

Закрытое перечисление лучше использовать в случаях, когда значения должны оставаться постоянными, например для дней недели.

Verse 
# Enums are <closed> by default so the specifier is not required.
my_enum := enum{Value1, Value2, Value3}

# You can also explicitly define the enum as closed by adding the <closed> specifier
my_enum := enum<closed>{Value1, Value2, Value3}

Спецификаторы реализации

Использование спецификаторов реализации при написании кода невозможно, однако вы увидите их при просмотре API UEFN.

Спецификатор Описание Пример

native

Указывает, что детали определения элемента реализованы на C++. Определения в Verse со спецификатором native автоматически генерируют определения на C++. Verse-разработчик может позднее добавить в них собственную реализацию. Вы можете увидеть, что этот спецификатор используется для следующих типов:

  • класс

  • интерфейс (interface)

  • перечисление

  • метод (method)

  • данные

Verse 
GetCreativeObjectsWithTag<native><public>(Tags:tag)<transacts>:[]creative_object_interface

native_callable

Указывает на то, что метод экземпляра относится к категории native (т. е. реализован на C++) и может быть вызван кодом C++ из другого места. Вы можете увидеть, что этот спецификатор используется для метода экземпляра. Этот спецификатор не распространяется на подклассы, поэтому его не нужно добавлять к определению при переопределении метода, имеющего этот спецификатор

Verse 
creative_device<native><public> := class<concrete>:
    OnBegin<public>()<suspends>:void = external {}

    OnEnd<native_callable><public>():void = external {}

Свойства

Атрибуты в Verse описывают поведение, определяемое за рамками самого языка Verse (в отличие от спецификаторов, которые описывают семантику Verse). Их можно добавлять в строку, предшествующую коду с дальнейшим определением.

Их синтаксис подразумевает использование знака (@), за которым идёт ключевое слово.

Свойство Описание Пример

editable

Указывает на то, что это поле является выведенным свойством, которое может быть изменено непосредственно в UEFN, поэтому нет необходимости вносить изменения в код Verse, чтобы изменить его значение. Более подробно это описано в разделе Настройка свойств устройства.

Verse 
@editable
Platform : color_changing_tiles_device = color_changing_tiles_device{}

editable_text_box

Редактируемая строка, которая отображается в виде текстового поля в редакторе. В настоящее время редактируемые текстовые поля не поддерживают всплывающие подсказки и категории.  Подробнее: Настройка свойств устройства.  

Verse 
# An editable string that displays as a text box in the editor.
# Editable text boxes currently do not support tooltips or categories.
@editable_text_box:
    # Whether this text can span multiple lines.
    MultiLine := true

    # The maximum amount of characters this text block can display.
    MaxLength := 32
MessageBox:string = "This is a short message!"

editable_slider

Редактируемый ползунок, который использует тип float. Вы можете перетаскивать ползунок в редакторе, чтобы увеличить или уменьшить значение. Подробнее: Настройка свойств устройства.  

Verse 
# An editable slider that uses the float type. You can drag the slider in the editor to increase
# or decrease the value.
@editable_slider(float):
    # The categories this editable belongs to.
    Categories := array{FloatsCategory}

    # The tool tip for this editable.
    ToolTip := SliderTip

    # The minimum value of each component. You cannot set an editable value for this number lower

editable_number

Редактируемое число с минимальным и максимальным значениями.  Подробнее: Настройка свойств устройства.  

Verse 
# An editable number with minimum and maximum
@editable_number(int):

    # The tool tip for this editable.
    ToolTip := EditableIntTip

    # The category this editable belongs to.
    Categories := array{IntsCategory}

    # The minimum value of each component. You cannot set an editable value for this number lower

editable_vector_slider

Редактируемый векторный ползунок. Значения каждого из компонентов вектора можно изменить перетаскиванием.  Подробнее: Настройка свойств устройства.  

Verse 
# An editable vector slider. You can drag to change the values of each of the vector components.
@editable_vector_slider(float):
    # The tool tip for this editable.
    ToolTip := VectorSliderTip

    # The categories this editable belongs to.
    Categories := array{FloatsCategory}

    # Shows the option to preserve the ratio between vector values in the editor.
    ShowPreserveRatio := true

editable_vector_number

Редактируемый номер вектора, может быть vector2, vector2i или vector3.  Подробнее: Настройка свойств устройства.  

Verse 
# An editable vector number, which can be a vector2, vector2i, or vector3.
@editable_vector_number(float):

    # The categories this editable belongs to.
    Categories := array{FloatsCategory}

    # The tool tip for this editable.
    ToolTip := VectorFloatTip

    # Shows the option to preserve the ratio between vector values in the editor.

editable_container

Редактируемый контейнер значений. В настоящее время поддерживает только массивы.  Подробнее: Настройка свойств устройства.  

Verse 
An editable container of values. Currently, this only supports arrays.
@editable_container:

    # The category this editable belongs to.
    Categories := array{IntsCategory}

    # The tool tip for this editable.
    ToolTip := IntArrayTip

    # Whether dragging elements to reorder this container is allowed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page