Package pragma

Class PragmaOptions

java.lang.Object
pragma.PragmaOptions

public final class PragmaOptions extends Object
  • Field Details

    • PRAGMA_MESSAGE_TYPE_FIELD_NUMBER

      public static final int PRAGMA_MESSAGE_TYPE_FIELD_NUMBER
      See Also:
    • pragmaMessageType

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MessageOptions,PragmaOptions.PragmaMessageType> pragmaMessageType
       Use with any type meant to be sent over the wire.
       Example usage:
       option (pragma_message_type) = REQUEST;
       
      extend .google.protobuf.MessageOptions { ... }
    • PRAGMA_SESSION_TYPE_FIELD_NUMBER

      public static final int PRAGMA_SESSION_TYPE_FIELD_NUMBER
      See Also:
    • pragmaSessionType

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MessageOptions,PragmaOptions.PragmaSessionType> pragmaSessionType
       Defines which Session a message belongs to.
       Only valid for REQUEST, RESPONSE, or NOTIFICATION message types.
       Example usage:
       option (pragma_session_type) = PLAYER;
       
      extend .google.protobuf.MessageOptions { ... }
    • UNREAL_TYPE_NAME_FIELD_NUMBER

      public static final int UNREAL_TYPE_NAME_FIELD_NUMBER
      See Also:
    • unrealTypeName

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MessageOptions,String> unrealTypeName
       Defines the name of the type as it should appear in the Unreal SDK.
       Note that this name will still be prepended with FPragma_.
       Example usage:
       option (unreal_type_name) = PlatformError;
       Result:
       FPragma_PlatformError
       
      extend .google.protobuf.MessageOptions { ... }
    • UNREAL_ENUM_NAME_FIELD_NUMBER

      public static final int UNREAL_ENUM_NAME_FIELD_NUMBER
      See Also:
    • unrealEnumName

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.EnumOptions,String> unrealEnumName
       Defines the name of the type as it should appear in the Unreal SDK.
       Note that this name will still be prepended with EPragma_.
       Example usage:
       option (unreal_enum_name) = "PlatformError";
       Result:
       EPragma_PlatformError
       
      extend .google.protobuf.EnumOptions { ... }
    • UNREAL_NAMESPACE_FIELD_NUMBER

      public static final int UNREAL_NAMESPACE_FIELD_NUMBER
      See Also:
    • unrealNamespace

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FileOptions,String> unrealNamespace
       Similar to built-in csharp_namespace, this value is used to namespace Unreal types. Unreal doesn't play nice
       with actual C++ namespaces, so we instead namespace in the type name. By default, types will use the leaf node
       of the package for this value, but can be overridden to make it nicer.
       Set to "null" to force no namespace to be used (e.g. FPragma_Fixed128).
       Example usage:
       package pragma.mygreetings;
       option (unreal_namespace) = "Greetings";
       message Hello {}
       Result without option: FPragma_Mygreetings_Hello
       Result with option:    FPragma_Greetings_Hello
       
      extend .google.protobuf.FileOptions { ... }
    • BACKEND_TYPE_FIELD_NUMBER

      public static final int BACKEND_TYPE_FIELD_NUMBER
      See Also:
    • backendType

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FileOptions,PragmaOptions.PragmaBackendType> backendType
       This value determines what backend generated service code communicates with.
       Defaults to PragmaBackendType.Game.
       Example usage:
       option (backend_type) = PragmaBackendType.Social;
       
      extend .google.protobuf.FileOptions { ... }
  • Method Details

    • registerAllExtensions

      public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)
    • registerAllExtensions

      public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
    • getDescriptor

      public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()