# SwayKickProps

> Talos 0.7 · Since 0.7

One entry of {@link SwayProps.kicks}: the shove, and what in the event steers and scales it.

## Signature

```ts
export interface SwayKickProps extends SwayKick {
  /**
   * A numeric field of the event's data, -1..1 (clamped), that the roll kick is multiplied by: which side
   * the hit came from. Named and absent or not a number in the event, the roll is not kicked; the pitch
   * and bob still are. Not named: the roll kick is used as it is.
   */
  side?: string
  /** A numeric field of the event's data, 0..1 (clamped), that the whole kick is multiplied by: how hard. Absent: 1. */
  scale?: string
  /**
   * Whose events count: `"carrier"` (default), the entity itself or one of its ancestors, its controller events
   * (`land`, `jump`) included; `"any"`, every sender, other entities' controller events included.
   */
  from?: "carrier" | "any"
}
```

Import: `import type { SwayKickProps } from "@argus/gameplay"`

## Members

| Member | Signature | Description |
|---|---|---|
| `side` | `side?: string` | A numeric field of the event's data, -1..1 (clamped), that the roll kick is multiplied by: which side the hit came from. Named and absent or not a number in the event, the roll is not kicked; the pitch and bob still are. Not named: the roll kick is used as it is. |
| `scale` | `scale?: string` | A numeric field of the event's data, 0..1 (clamped), that the whole kick is multiplied by: how hard. Absent: 1. |
| `from` | `from?: "carrier" \| "any"` | Whose events count: `"carrier"` (default), the entity itself or one of its ancestors, its controller events (`land`, `jump`) included; `"any"`, every sender, other entities' controller events included. |