Skip to main content

Event Handler

1. Overview​

The file event_handler.yaml in exported package contains all the configuration of Event Handler module from exported title region. You can add, delete or update some items in the file and then re-import to the title region.

2. An Example of The File Content​

# AUTO-GENERATED FILE.
#
# Export information
# @export_time: Thu, 17 Mar 2022 07:26:50 GMT
#
# This file was automatically generated by PGOS Portal.
# Copyright 2022 Proxima Beta, Inc. All Rights Reserved.

event_handler:
  snapshot_tag: "20220317152639198"
  title_id: "5"
  title_region_id: d_5_812179_dev
  list:
    - identification:
        event_name: event_player_login_pgos
      handlers:
        - handler_name: handler1
          description: ""
          filters: {}
          action_list:
            - action_args: '{"args":1}'
              action_type: vsf
              action_entity:
                server_name: sample_economy
                function_name: grant_currency
            - action_args: '{"args":1}'
              action_type: webhook
              action_entity:
                webhook_name: will

3. Field Description​

  • identification: The unique identifier for the current resource, It contains multiple fields.
    • event_name: The name of event. Type: string.
  • handlers: The handler of event.
    • handler_name: The name of handler. Type: string. Length: 1-60.
    • description: The description of handler. Type: string. Length: 1-1000.
    • filters: The filter of handler. Type: json.
    • action_list
      • action_args: The args of action. Type: string.
      • action_type: The Type of action. Type: string, vsf / webhook.
      • action_entity
        • server_name (vsf only) : The name of virtual server. Type: string.
        • function_name (vsf only) : The function name of virtual server. Type: string.
        • webhook_name (webhook only): The name of webhook. Type: string.