# @rbxts/character-viewport

> Character viewport for roblox-ts

Latest version **1.0.1** (published 2021-03-17) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install @rbxts/character-viewport
pnpm add @rbxts/character-viewport
yarn add @rbxts/character-viewport
bun add @rbxts/character-viewport
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-03-17 |
| First published | 2021-03-17 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | xethlyx |

## Links

- npm: https://www.npmjs.com/package/@rbxts/character-viewport
- Homepage: https://github.com/synergence/rbxts-character-viewport#readme
- Issues: https://github.com/synergence/rbxts-character-viewport/issues
- npm.io page: https://npm.io/package/@rbxts/character-viewport

## Dependencies (1)

- [@rbxts/roact](https://npm.io/package/@rbxts/roact.md) ^1.3.0-ts.10

## Recent versions

- 1.0.1 (latest) — 2021-03-17

## README

# @rbxts/character-viewport

A live-updating character viewport, which shows animations.

![Example](example.png)

To use:
```tsx
import { CharacterViewport } from '@rbxts/character-viewport';

const Players = game.GetService('Players');

// inside your Roact code
<CharacterViewport Player={Players.LocalPlayer}>
```

It's suggested that you unmount the component when not in use for performance reasons.

There are also static functions to trigger a re-render of a player's viewport locally:
```ts
import { CharacterViewport } from '@rbxts/character-viewport';

const Players = game.GetService('Players');

CharacterViewport.updatePlayer(Players.LocalPlayer);
```

_Based off of boatbomber's [character viewport](https://devforum.roblox.com/t/rendering-the-character-with-a-viewportframe/241369/31?u=xethlyx). I've changed a couple things, such as converting the Heartbeat functions to use a batch array, and adding Roact lifecycle hooks, but I suspect that boatbomber spent more time than his than mine, so this message exists as a head-nod._

---
_Source: https://npm.io/package/@rbxts/character-viewport · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._