{"id":151,"date":"2019-06-25T14:13:09","date_gmt":"2019-06-25T14:13:09","guid":{"rendered":"http:\/\/www.shmupcreator.com\/doc\/?docs=shmupcreator\/objects-and-entities\/player"},"modified":"2026-06-25T13:30:41","modified_gmt":"2026-06-25T13:30:41","slug":"player","status":"publish","type":"docs","link":"https:\/\/www.shmupcreator.com\/doc\/?docs=shmupcreator\/objects-and-entities\/player","title":{"rendered":"Player"},"content":{"rendered":"\n

Click on the player to select it and open the Player Editor<\/strong>.<\/p>\n\n\n

\"\"<\/p>\n

WHAT IT’S FOR:<\/strong>
The player is the entity controlled by the (human) player.<\/p>\n

PROPERTIES<\/h5>\n

\"\"\u00a0SETTINGS TAB<\/strong><\/p>\n

\"\"\u00a0Name <\/strong>text field:\u00a0The player’s name
\"\"\u00a0Choose player <\/strong>button:\u00a0<\/strong>Open the player box, where you can choose the player model or sprite.
\"\"\u00a0Orientation <\/strong>buttons:<\/strong> The orientation of the player (to the right, top\u2026). Can be different per level.
\"\" \"\" Y Asset rotation<\/strong> buttons: rotate the asset (3D mesh or sprite) 90 degrees on the Y axis. Useful if the item graphic is not in the right direction. This is not the orientation of the player object, but the orientation of its graphic representation.
\"\" \"\" Side Asset rotation<\/strong> buttons: rotate the asset (3D mesh only) 90 degrees on its side axis. Useful if the item graphic is not in the right direction.
\"\" Asset symmetry <\/strong>button:\u00a0<\/strong>Flip the 3D mesh or sprite.
\"\"\u00a0Cast shadow <\/strong>checkbox:\u00a0<\/strong>If checked, the object will cast a shadow on other objects.<\/p>\n

MOVE<\/strong>
\"\"Speed <\/strong>spinner:\u00a0<\/strong>The speed of the player. The bigger the number the faster the player.
\"\"<\/strong> Only lateral<\/strong>: if checked, the player will only move laterally. Useful for old-school games, like Galaga-type games. Can be different per level.
\"\"Bank <\/strong>checkbox:\u00a0<\/strong>If checked, the player object will bank a little when it turns if the player object is 3D.
\u00a0\u00a0\u00a0\u00a0 \"\" roll <\/strong>spinner: <\/strong>the amount of roll rotation
\u00a0\u00a0\u00a0\u00a0 \"\" pitch <\/strong>spinner: <\/strong>the amount of pitch rotation
\u00a0\u00a0\u00a0\u00a0 \"\" speed <\/strong>spinner: <\/strong>the banking speed<\/p>\n

PHYSICS<\/strong>
\"\"Use physics<\/strong> checkbox: By default, the player translation is very basic, like it should be in shmups. However, for some kinds of games (euro-shmup style), you’ll want to add some physics to the player’s motion.
\"\"\u00a0Acceleration <\/strong>spinner:\u00a0<\/strong>The player will accelerate to full speed
\"\"\u00a0Friction <\/strong>spinner:\u00a0<\/strong>The player will decelerate if he doesn’t move
\"\"\u00a0Gravity <\/strong>spinner:\u00a0<\/strong>Gravity will occur and push the player to the bottom of the screen.<\/p>\n

\"\"<\/strong> Mouse<\/strong> checkbox: if checked, the player position is controlled by the mouse.<\/p>\n

ORIENTATION MODE<\/strong>
\"\"No orientation <\/strong>radio button:\u00a0<\/strong>The player keeps its orientation, like in most old-school shmups.
\"\"Flip <\/strong>radio button:\u00a0<\/strong>The player will flip in the translation direction. In horizontal shoot’ em-ups, for instance, the player will orient to the left if he goes to the left and to the right if he goes to the right.
\"\"Orient with right stick <\/strong>radio button:\u00a0<\/strong>The right stick orients the player, and the left one moves the player on the screen, like in twin-stick shooters.
\u00a0\u00a0\u00a0\u00a0\u00a0 \"\" Rotation speed <\/strong>spinner: <\/strong>if the player is oriented with the right stick or the mouse, you can modify the player’s rotation speed.
\"\"Orient with mouse <\/strong>radio button:\u00a0<\/strong>The keyboard moves the player, and the player orients itself in the direction of the mouse pointer.
\u00a0\u00a0\u00a0\u00a0\u00a0 \"\" Rotation speed <\/strong>spinner: <\/strong>if the player is oriented with the right stick or the mouse, you can modify the player’s rotation speed.<\/p>\n

FOCUS\/CHANGE SPEED<\/strong>
Focus mode allows users to slow down the player when they press a button. When the user releases the button, the player speed is back to normal.
This mode can also change the Weapon set and swap the current weapon with a more focused version (or a completely different weapon).
\"\"Focus<\/strong> checkbox:\u00a0 enable the focus mode
\"\" Assign button<\/strong> menu: the button activating the focus
\"\" Speed<\/strong> spinner: the new player’s speed during focus
Weapon set number<\/strong>: the focus weapon set. You can choose “keep current set” if you don’t wish to change the player’s weapons.<\/p>\n

\"\"\u00a0COLLISIONS TAB<\/h5>\n

\"\" Add <\/strong>button: Add a new collision shape
\"\" Delete <\/strong>button: Delete the current collision shape
\"\" navigation<\/strong> arrows: Navigate between the different collision shapes
\"\"Invincible<\/strong> checkbox: if checked, the current collision shape will be invincible to bullets and enemies
\"\"Used for out-of-screen bounds limit<\/strong> checkbox: Does this collision shape stop the player from going out of screen bounds
\"\"Collide with enemies<\/strong> checkbox: If checked, the collision shape will collide with enemies
\"\"Collide with backgrounds <\/strong>checkbox: If checked, the collision shape will collide with backgrounds
\"\"Collide with items <\/strong>checkbox: If checked, the collision shape will collide with items. Note that the Hitbox always collides with items.
\"\" Reset <\/strong>button:<\/strong> Reset the collision shape
\"\" Auto collision<\/strong> button: the tool tries to create a shape following the picture contours.
\"\"Collision window<\/strong>: move the points to build the shape of your collision
\"\"<\/strong>Point position x \/ y<\/strong> edit boxes: allow to move precisely the selected point.<\/p>\n\n\n

Notes:<\/strong>\n. The collision shape is always convex, so you can't create any shape. This is why sometimes you need to add several collision shapes to create the right shape.\n. You don't always need a super precise shape. It's a shmup: think gameplay first, and try to not add too many collision shapes to an object!<\/pre>\n\n\n
GAMEPLAY TAB<\/h5>\n
HEALTH POINTS<\/strong>
\"\"\u00a0Start:<\/strong> When the game starts, how much HP does the player have
\"\"\u00a0Max:<\/strong> The maximum HP the player can gain with items
\"\"\u00a0Lives:<\/strong> The number of lives of the player<\/p>\n
COLLISION
<\/strong>\"\"slide on background sprites
\"\"<\/strong>:Damage by<\/strong> background<\/strong>: how many HP will be removed from the player
 \"\" Damage to enemy<\/strong>: how much HP will be removed from the enemy
\"\" Sound<\/strong>: the impact sound
\"\" Particle system<\/strong>: the particle system spawned when the player collide 
(note: the particle system position is not very precise right now)<\/em><\/p>\n
INTRO<\/strong>
\"\"MOVE <\/strong>checkbox: You can add a small translation animation when the player spawns.
\u00a0 \u00a0\u00a0 \u00a0 \"\"<\/strong>:Direction<\/strong>: the translation direction, in degrees.
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"\" Distance<\/strong>: the transition distance
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"\" Duration<\/strong>: the translation duration. The smaller the number, the faster the animation.
\"\" Invincibility duration:<\/strong> the player can be invincible during the player’s introduction on screen.
<\/strong><\/p>\n
HIT
\"\" Invincibility duration<\/strong>: when the player is hit by a bullet or an enemy, he can be invincible for a short amount of time.
\"\" sound: when the payer is hit by a gameplay element, it loses energy and plays this sound.
\"\"Particle system: <\/strong>the particle system is spawned when the player is hit.<\/p>\n
DEATH
<\/strong>\"\" Allow choosing the explosion preset for the player(see explosion editor<\/a>)
\"\"\u00a0Explosions number:<\/strong> How many explosions are spawned on death
 \"\"\u00a0Explosions radius:<\/strong> The size of the circle where the explosion is spawned
 \"\"\u00a0Explosions scale:<\/strong> The scale of the explosion.<\/p>\n
RESPAWN
\"\" Delay<\/strong>: you can add a small delay after the player dies and before he respawns.
\"\" Enemies hold fire<\/strong>: you can disable all enemy weapons for a short amount of time when the player respawns.
\"\"Bullets are canceled: <\/strong>checkbox:<\/strong> Cancel or not the bullets when the player respawns.<\/p>\n
\"\"\u00a0WEAPONRY TAB<\/h5>\n
\"\"\u00a0Open\u00a0Weapon editor<\/strong> button:<\/strong> Open the weapon editor (see weapon editor<\/a> for more)
Weapon sets are collections of weapons. For more on this, see “weapons<\/a>“.<\/p>\n
WEAPON SETS<\/strong>
\"\"\u00a0New weapon Set<\/strong> button: Add a new weapon set. It will copy the weapons from the current weapon set by default.
\"\" Duplicate weapon Set<\/strong> button: duplicate the current weapon set
\"\"\u00a0Delete weapon Set<\/strong> button: Delete the current weapon set
\"\"\u00a0Rename weapon Set<\/strong> button: Rename the weapon set
\"\"<\/strong>Arrows:<\/strong> Navigate between weapon sets
\"\"\u00a0Name <\/strong>text field:<\/strong> The name of the weapon set<\/p>\n\n\n
Note:<\/strong> maximum weapon sets number is 64<\/pre>\n\n\n
WEAPON LOCATORS<\/strong>
\"\"\u00a0New weapon<\/strong> locator<\/strong> button: Add a new weapon locator to the current weapon set
\"\"\u00a0Delete weapon<\/strong> locator<\/strong> button: Delete the selected weapon locator from the current weapon set
\"\"<\/strong>Arrows: Navigate between the weapon locators of the current<\/p>\n
\"\"\u00a0ANIMATION TAB<\/h5>\n
Animation settings in this tab have only an effect on sprites, not 3D objects.
SPRITE<\/strong>
\"\"\u00a0Animation speed <\/strong>spinner:<\/strong> If the texture contains several frames, this setting allows you to choose the animation speed
\"\"\u00a0Columns <\/strong>spinner:<\/strong> Set the number of columns of the texture atlas
\"\"\u00a0Rows <\/strong>spinner:<\/strong> Set the number of rows of the texture atlas (see “animating sprites<\/a>” section for more information)<\/p>\n
\"\" PARTICLE LOCATOR TAB<\/h5>\n
This is where you can add particle effects to the player.
\"\"\u00a0Add<\/strong> a particle locator<\/strong> button: Add a new particle emitter
\"\"\u00a0Delete a particle locator<\/strong> button: delete the current particle emitter
\"\"Arrows:<\/strong> Navigate between the different particle locators<\/p>\n
PARTICLE SYSTEM
<\/strong> \"\" Choose a particle system<\/p>\n
EMISSION<\/strong>
\"\"All the time <\/strong>radio button:\u00a0<\/strong>The particle effect will always be alive
\"\"When moving <\/strong>radio button:\u00a0<\/strong>The particle effect will be alive when the player moves and stop when he stops. Useful for reactors, for instance.
\"\"Scale <\/strong>spinner:\u00a0<\/strong>You can scale the particle effect. Please note that although the engine will try to scale the particle size as well as the speed as much as he can, it will not be as accurate as modifying the particle effect script directly.<\/p>","protected":false},"featured_media":0,"parent":136,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-151","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/docs\/151","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=151"}],"version-history":[{"count":108,"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/docs\/151\/revisions"}],"predecessor-version":[{"id":3032,"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/docs\/151\/revisions\/3032"}],"up":[{"embeddable":true,"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/docs\/136"}],"next":[{"title":"Backgrounds","link":"https:\/\/www.shmupcreator.com\/doc\/?docs=shmupcreator\/objects-and-entities\/backgrounds","href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=\/wp\/v2\/docs\/152"}],"wp:attachment":[{"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=151"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.shmupcreator.com\/doc\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=151"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}