The "vngen_char_create_ext" Function

Syntax#

vngen_char_create_ext(name, spr_body, spr_face_idle, spr_face_talk, xorig, yorig, x, y, z, face_x, face_y, scaling, flip, idle, transition, duration, ease);

Argument	Type	Description
`name`	string	The unique identifier to use for the new character
`spr_body`	sprite	The sprite to draw as a character body
`spr_face_idle`	sprite	The sprite to draw as an idle face (or keyword `none` for none)
`spr_face_talk`	sprite	The sprite to draw as a talking face (or keyword `none` for none)
`xorig`	real/macro	The horizontal sprite offset, or origin point, relative to the top-left corner
`yorig`	real/macro	The vertical sprite offset, or origin point, relative to the top-left corner
`x`	real	The horizontal position to display the character, relative to the global offset
`y`	real	The vertical position to display the character, relative to the global offset
`z`	real	The drawing depth of the character, relative to other characters only
`face_x`	real	The horizontal position to display the face, relative to the body sprite top-left corner
`face_y`	real	The vertical position to display the face, relative to the body sprite top-left corner
`scaling`	integer/macro	Sets the automatic scaling mode for the character
`flip`	boolean	Enables or disables horizontally flipping the character
`idle`	real	Sets the delay in seconds between loops of the idle face sprite animation, where 3 is default
`transition`	script	Sets the transition animation to perform
`duration`	real	Sets the duration of the transition animation, in seconds
`ease`	integer/macro	Sets the ease override for the transition script

Description#

Creates a new character with extra options which will be displayed until vngen_char_destroy is run. Multiple characters can exist simultaneously, however no two characters may share the same ID. Also note that unlike other entities, character IDs must be strings, not real numbers.

Note that using separate face sprites is optional. If only a body sprite is desired, spr_face_idle and spr_face_talk can be set to -1 or the keyword none to disable them.

See Included Animations and Macros & Keywords for a list of available keywords, origin points, scaling modes, transition animations, and ease modes.

Example#

vngen_event() {
   vngen_char_create_ext("John Doe", spr_body, spr_face, spr_talking, orig_left, orig_bottom, 0, view_hview[0], -1, 384, 128, scale_none, false, trans_slide_right, 2, ease_quad_out);
}