SigNotice

Notice module

유저에게 전달/안내 될 수 있는 알림을 나타냅니다.

이 페이지에 대한 설명은 기본적으로 SigSingleNotice를 기준으로 합니다.

Usage

• Programmatic Usage

SigNotice.of()
    .addMessage("Hello, World!")
    .notice(player);

SigNotice.of()
    .addMessage("placeholder: %test%")
    .notice(player, SigStringEditor.ofReplace("%test%", "10")); // formatter example

• Yaml Deserialize

YamlNode node;

new SigNotice(node); // or use fromYaml(YamlNode)

Yaml Format

• 메시지(message)

message:
  content:
    - "Message"
  send_to: # Optional
    player: # 플레이어 한테 전송
    server: # 실행된 서버에 전송
    bungee: # 번지에 연결된 전체 서버에 전송

message:
  - "Alternative format" # 이 경우 send_to는 기본값 고정

- "Alternative format" # 이 경우 send_to는 기본값 고정

{player}, {nickname}, {uuid} 의 기본 placeholder를 지원합니다.

• Component(component)

MiniMessage 포맷을 따릅니다.

component: "<color:yellow>Hello <color:blue>World</color:blue>!" # MiniMessage

component:
  - "<color:yellow>Hello " # MiniMessage
  - "<color:blue>World</color:blue>!" # List로 전달해도 합쳐서 MiniMessage로 만듬

component:
  content:
    - "<color:yellow>Hello <color:blue>World</color:blue>!"

• 타이틀(title)

title: # 하위 항목 들은 Optional
  main_title: "title"
  sub_title: "sub title"
  fade_in: 20 # Tick 단위, 정수
  fade_out: 20
  stay: 60
  send_to: # send_to가 지정되지 않을 경우 기본값
    - "player"

• 소리(sound)

sound:
  entity.player.levelup: # 하위 항목 들은 Optional
    volume: 1.0
    pitch: 1.0
    source: MUSIC
    location:
      from: SENDER
          # SENDER: 보낸 플레이어 위치 중심 (플레이어가 아닐 경우 WORLD 사용)
          # PLAYER: 듣는 플레이어 위치 중심
          # WORLD: 월드 좌표 절댓값 기준
      x: 0
      y: 0
      z: 0
  minecraft:another.sound:
    volume: 1.0 # volume 값 입력 권장

sound의 key 값으로 namespace:value 형식의 Key 와 ENTITY_PLAYER_LEVELUP 형식의 Sound enum 값을 사용할 수 있습니다.

send_to Yaml Format

send_to 포맷은 SigNotice를 보낼 대상을 지정합니다. 지정되지 않을 경우 기본 값으로 설정됩니다.

• 기본 값

send_to:
  player:
    - "%sender%"

• 전체 포맷

send_to: # Optional
  player: # 특정 플레이어 한테 전송
    - "%sender%" # Notice를 일으킨 플레이어, placeholder
    - "qsef1256"
    # or 추후에 특정 펄미션 등에게 전송으로 확장 가능
  world: # 특정 월드에 전송
    - "%sender%" # sender의 월드 사용
    - "world"
  server:
    - "%sender%" # sender의 서버 사용
    - "%bungee%" # 번지 전체 실행
    - "lobby" # 실행된 서버에 전송
  console: # 가능한 정보를 콘솔로 전송

• 단축 포맷

만약에 이 포맷을 사용할 경우 아래에 적힌 값만 사용 가능합니다.

send_to: 
  - "player" # sender 에게 전송
  - "world" # sender의 월드에게 전송
  - "server" # sender의 서버에게 전송
  - "bungee" # 번지 전체 서버에게 실행
  - "console" # 콘솔에게 전송

Feature

• SigNotice를 보여주지 않거나, 메모리에 따로 저장하는 등 추가 처리를 진행할 수 있습니다.

• SigNoticeResult: message 대신 SigNotice를 가지고 있는 TaskResult 입니다. message만 가지고 있는 TaskResult 보다 다양한 안내가 가능합니다.

• SigNotice#notice의 반환 TaskResult값을 통해 성공적으로 메시지가 표시 되었는지 확인할 수 있습니다. 그러나 이를 확인하기 어려운 경우 역시 다수 존재하므로 참고 용으로만 사용되어야 합니다.