activate_easter_egg

---

title: Activate Easter Egg description: published: true date: 2023-03-16T23:04:39.206Z tags: editor: markdown dateCreated: 2023-03-16T22:20:33.638Z

activateEasterEgg

The activateEasterEgg native AI script function calls the EGS function CCharacterControl::activateEasterEgg to activate an Easter Egg in the game world. It is used for the lootable items spawned by the Ryzom Ring scenario, not for the lootable item bags dropped by characters exiting a scenario session.

Syntax

()activateEasterEgg(easterEggId: f, sessionId: f, actId: f, items: s,
	x: f, y: f, z: f, heading: f, groupname: s, name: s, clientSheet: s)
  // activateEasterEgg_fffsffffsss_

Arguments

• easterEggId (float): The id of the Easter Egg to activate.
• sessionId (float): The session id of the scenario where the Easter Egg will be spawned.
• actId (float): The id of the action that will be associated with the Easter Egg.
• items (string): The sheet/quantity vector (a string of format "item1:qty1;item2:qty2;...").
• x (float): The X coordinate of the position where the Easter Egg will be spawned.
• y (float): The Y coordinate of the position where the Easter Egg will be spawned.
• z (float): The Z coordinate of the position where the Easter Egg will be spawned.
• heading (float): The heading angle of the Easter Egg in radians.
• groupname (string): The name of the group that will be associated with the Easter Egg.
• name (string): The name of the Easter Egg.
• clientSheet (string): The sheet name of the client effect that will be triggered with the Easter Egg.

Example

()activateEasterEgg(2, 1601, 4, "toto.sitem:2;tata.sitem:1;titi.sitem:3", 1247, 4627, 0, 0, "egg_group", "egg_name", "");

This example code activates an Easter Egg with an ID of 2, in session ID 1601, with act ID of 4, and a sheet/quantity vector of "toto.sitem:2;tata.sitem:1;titi.sitem:3". The Easter Egg will be spawned at position (1247, 4627, 0) with a heading angle of 0.0 radians. The group name is "egg_group", and name is "egg_name". The default client effect sheet name is used.