Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyServerTaskRequest

Description

Modify server task request. If there is a trigger in this task, the trigger internal state will be reset (e.g. if the trigger should end after 10 occurrences, after calling RpcModifyServerTaskRequest, there will be new 10 occurrences, regardless of how many times the trigger was fired before)

Properties

Name JsonSchemaType Description
serverTaskConfiguration reference to Era.Common.DataDefinition.Task.ServerTaskConfiguration New task configuration. It is not allowed to change the task type.
serverTriggerConfiguration reference to Era.Common.DataDefinition.Trigger.ServerTriggerConfiguration Trigger configuration. This trigger replaces the original trigger. If not provided, trigger is removed from the task.
staticObjectData reference to Era.Common.DataDefinition.StaticObject.StaticObjectData New task data.
staticObjectIdentification reference to Era.Common.DataDefinition.StaticObject.StaticObjectIdentification ID of the task to modify.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyServerTaskResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyServerTaskRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyServerTaskRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyServerTaskRequest": {
            "$ref": "#/definitions/RpcModifyServerTaskRequest"
        }
    },
    "definitions": {
        "RpcModifyServerTaskRequest": {
            "additionalProperties": false,
            "required": [
                "serverTaskConfiguration",
                "staticObjectData",
                "staticObjectIdentification"
            ],
            "type": "object",
            "properties": {
                "serverTaskConfiguration": {
                    "$ref": "Era.Common.DataDefinition.Task.ServerTaskConfiguration#/definitions/ServerTaskConfiguration"
                },
                "serverTriggerConfiguration": {
                    "$ref": "Era.Common.DataDefinition.Trigger.ServerTriggerConfiguration#/definitions/ServerTriggerConfiguration"
                },
                "staticObjectData": {
                    "$ref": "Era.Common.DataDefinition.StaticObject.StaticObjectData#/definitions/StaticObjectData"
                },
                "staticObjectIdentification": {
                    "$ref": "Era.Common.DataDefinition.StaticObject.StaticObjectIdentification#/definitions/StaticObjectIdentification"
                }
            }
        }
    }
}