# Nirvana2D [RCBasic Doc]

## Nirvana2D Sprite Editor

The sprite editor allows you to edit sprite definitions used to create sprites in the stage editor. A definition can have animations and the collider shapes uses in physics simulations.

At the far left of the screen there are 2 buttons:

- Load Sprite - Loads a sprite sheet into the definition list.
  - NOTE: This will also load any existing animation and collision data for the sheet as well.
- Delete Sprite - Removes a sprite definition from the editor.
  - NOTE: This will remove any sprites in the stage that use this definition.

At the top of the Sprite Editor is a text field labeled "Sprite ID" where you can change the name of the Sprite. To the right of the Sprite ID field, the dimensions of the sprite frame are shown.

## Animation Editor

#1 - Animation List - This is the list of animations for the selected Sprite. Above the list are buttons for adding an animation and removing the selected animation.

#2 - Animation ID - This is the name of the current selected animation. You can change it from this field.

#3 - Sprite Sheet - This is where you can view the current sprite sheet and select a sheet frame to set as the currently selected animation frame in the Animation Frames Panel (#4).

- Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet

#4 - Animation Frames - A horizontal layout of each frame in the animation.

- Setting a frame - To set a frame, first select the animation frame on the frame panel then select the desired frame on the sprite sheet
- Long Animations - If the number of frames in the animation exceed the viewable frames on the frame panel, use the buttons to the left and right of the panel to scroll the panel

#5 - Frame Count - Sets the number of frames in the current animation

#6 - Speed - Sets the number of frames per second the animation plays at

#7 - Preview - Plays the selected animation.

## Shape Editor

#1 - Editor Viewport - Here you can draw a polygon shape or move and resize box and circle shapes.

#2 - Tool Bar - Tools for editing the shape.

- Select - Selects a single point
  - NOTE: Hold Ctrl to keep previous points selected
- Box Select - Selects multiple points
- Select - Selects a single point
  - NOTE: Hold Ctrl to keep previous points selected
- Move - Moves the selected points
- Draw Polygon - When polygon shape is selected, this allows you to draw points

#3 - Shape Selection - Select the shape type

#4 - Shape Parameters - Change Parameters for the shape

- NOTE: Parameters are different depending on shape type