/*
    * Copyright (c) 2021 Kaiserpfalz EDV-Service, Roland T. Lichti.
    *
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
    * the Free Software Foundation, either version 3 of the License, or
    * (at your option) any later version.
    *
    * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program.  If not, see <https://www.gnu.org/licenses/>.
   */
  
  package de.kaiserpfalzedv.rpg.torg.model.actors;
  
  import org.eclipse.microprofile.openapi.annotations.media.Schema;
  
  import com.fasterxml.jackson.annotation.JsonInclude;
  
  import de.kaiserpfalzedv.rpg.torg.model.core.Skill;
  import lombok.AllArgsConstructor;
  import lombok.Builder;
  import lombok.EqualsAndHashCode;
  import lombok.Getter;
  import lombok.ToString;
  import lombok.extern.jackson.Jacksonized;
  
  /**
   * SkillValue -- A single skill of a character/npc or threat.
   *
   * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
   * @since 1.2.0  2021-05-23
   */
  @Jacksonized
  @Builder(toBuilder = true)
  @AllArgsConstructor
  @Getter
  @ToString
  @EqualsAndHashCode
  @JsonInclude(JsonInclude.Include.NON_ABSENT)
  @Schema(description = "A single skill with its values")
  public class SkillValue {
      @Schema(description = "Name of the skill to use.")
      private final Skill name;
  
      @ToString.Exclude
      @Schema(description = "The adds of this skill", nullable = true)
      private final Integer adds;
  
      @ToString.Exclude
      @Schema(description = "The bonus to the skill", nullable = true)
      private final Integer bonus;
  
      @Schema(description = "The total value of this skill", nullable = true)
      private final Integer value;
  
      @Schema(description = "If the skill is favoured", nullable = true)
      private final Boolean favoured;
  }