SigRequire

Requirement module

특정한 요구 사항을 나타내는 클래스 입니다. 메시지와 Icon를 포함합니다.

Usage

• SigRequire.of(YamlNode)

• SigRequire.isMatch(Player)

public class RequirementExample {
    public void example() {
        Player player = Bukkit.getPlayerExact("qsef1256");
        YamlNode node = YamlNode.empty(); // assume provided
        SigRequire requirement = SigRequire.of(node);
        
        SigRequireResult result = requirement.isMatch(player);
        boolean isSuccess = result.isSuccess();
        SigNotice notice = result.getNotice();
        
        result.notice(player);
    }
}

Yaml Format

requirement:
  id: "SIG_SIG_REQUIREMENT"
  icon:
    material: DIAMOND
    name: "시그시그 요구사항"
    desc:
      - "Test Desc"
      - "Test Desc2"
      - "{descriptions}" # 하위 requirement의 desc들
  success: # SigNotice
    - "&a성공!"
    - "{successes}" # 하위 true 요구사항 메시지
  failure: # SigNotice
    - "&c이 요구사항을 만족하려면 다음 요구 사항이 필요합니다."
    - "{failures}" # 하위 false 요구사항 메시지
  
  list:
    test_permission:
      permission: "siglib.test.permission"
      icon: 
        desc:
          - "테스트 펄미션"
      success: 
        - "테스트 펄미션이 필요합니다."
    test_expression:
      expression: "{siglib.test.placeholder} >= 10"
      icon:
        desc:
          - "테스트 표현식"
      success:
        - "테스트 표현식이 필요합니다."

Feature

Implementation

getIcon(Player), getSuccessNotice(Player), getFailureNotice(Player) 를 Override 할 수 있습니다. 이는 최종 결과로 반영 됩니다.

Register

SigRequireController#register() 를 통해 Requirement를 등록할 수 있습니다.

    public void init() {
        register("list", SigRequire::new);
        register("permission", PermissionRequire::new);
        register("expression", ExpressionRequire::new);
    }

등록된 Requirement는 SigRequire 역직렬화 과정에 반영됩니다.

Programmatic Usage

        SigRequire requirement = new SigRequire();
        requirement.setFailureMessage("{failures}");

        Requirement perm = new PermissionRequire("test_perm", "test.permission");
        Requirement expr = new ExpressionRequire("test_expr", SigExpressionApi
                .getInstance()
                .getExpression("{test.expression} > 10"));

        requirement.addRequire(perm);
        requirement.addRequire(expr);

        SigRequireResult result = requirement.isMatch(player);
        assertFalse(result.isSuccess());
        assertEquals(
                List.of("test_perm required.", "test_expr required."),
                result.getMessages());
        assertEquals(perm.getIcon(player), requirement.getIcon(player));

Element

PermRequire

펄미션을 가지고 있는지 확인합니다.

test_permission:
  permission: "siglib.test.permission"

ExpressionRequire

제공된 SigExpression 을 만족하는지 확인합니다.

test_expression:
  expression: "{siglib.test.placeholder} >= 10"