@s2script/sdk 0.6.0 → 0.8.0

package/chat.d.ts

@@ -11,8 +11,13 @@ export declare const Chat: {
   /**
    * An opaque prefix prepended to every chat message (NOT rcon/console replies). Color is content the
    * caller owns (SourceMod-parity), so the engine-generic layer never picks one. A game/plugin sets this
-   * to a color control byte — e.g. `Chat.color = ChatColors.Green` from `@s2script/cs2`. `""` = send raw
-   * (CS2 needs a leading control byte for chat to render). A message may also embed its own colors.
+   * to a color control byte — e.g. `Chat.color = ChatColors.Green` from `@s2script/cs2`. `""` = no prefix.
+   * A message may also embed its own colors mid-string.
+   *
+   * You do NOT need a leading space for color to render: every chat line is auto-prefixed with an invisible
+   * zero-width space (U+200B) so a Source 2 chat box doesn't swallow the message's first color byte. Just
+   * write `Chat.toSlot(slot, ChatColors.Green + "hi")` — the green lands. (Idempotent: a line you already
+   * lead with a space or a ZWSP is passed through unchanged.)
    */
   color: string;
   /** Print to the chat of the client in `slot` (0-based). */

package/commands.d.ts

@@ -13,7 +13,16 @@ export type ReplySource = "server" | "console" | "chat";
 
 /**
  * The parsed invocation handed to a command callback: who called it, its arguments (multiple typed
- * accessors), and a caller-appropriate `reply` channel. Valid only for the duration of the callback.
+ * accessors), and a caller-appropriate `reply` channel. It is a plain object that captures no native
+ * handle, so it MAY be retained and used after an `await`/`.then` — a deferred `reply` (e.g. from
+ * inside `delay(...).then(...)` or an async DB/HTTP call) is safe to call once the awaited work
+ * completes.
+ *
+ * What it captures, though, is the caller's **slot** — not a stable identity. If the original caller
+ * disconnects before the deferred reply runs and a different player has since taken that slot, the
+ * reply routes to (or targets the console/chat channel of) whoever now occupies it, not the original
+ * caller. Prefer replying synchronously where the timing matters, or re-check the caller (e.g. via
+ * their user id) before trusting a slot held across a long-running await.
  */
 export interface CommandInvocation {
   /** 0-based caller slot, or -1 for the server console. */