VgaGames 3 - Actionstack man-pages

[.. upper level ..]

VG3_actionstack_get()

[added in version 1.4]

Return top-most element of an actionstack.
SYNTAX
struct vg3_actionstack_elem VG3_actionstack_get(struct vg3_actionstack *astack)

FUNCTION PARAMETERS
astack Actionstack

RETURN VALUE
Returns top-most element of the actionstack.

DESCRIPTION
Return the top-most element of an actionstack. The return value of the struct vg3_actionstack_elem contains - in name_id the name-ID as passed with VG3_actionstack_push() - in stack_id the unique stack-ID, which may serve as parent-ID for later pushed elements - in hparm the element's parameter-hash If the actionstack is empty, the returned structure-element stack_id will be set to 0.

SEE ALSO
VG3_actionstack_new() VG3_actionstack_free() VG3_actionstack_push() VG3_actionstack_pop() VG3_actionstack_parent() VG3_actionstack_dump()