Begin

Node Introduction

The Begin node is the starting point in EZMenu, where the menu logic begins. The Begin node has only one output, which connects to the main menu.

Inputs

• None

Outputs

• Start - Connects to the main menu.

Node Properties

The Begin node has many properties that determine how the menu operates. In the Begin node, you can set the project’s name, description, version, author, and other information. This information helps you better manage your project.

• Title - This is the name of the node, which can be customized. This property exists for every node and can be used to identify the node’s functionality. This property will not be further explained below.
• ProjectName - This is the name of the project, which can be customized. When exporting the project, the default project name is the value of this property. The generated script file will also be named after this property, and the value will be displayed in the generated script file.
• ProjectDescription - This is the description of the node, which can be customized. It helps you record relevant information about the project. It is recommended to fill in this property to better manage the project in the future.
• ProjectVersion - This is the version number of the project, which can be customized. It is used to identify the version of the project. When updating the script, you can use this property to mark the version number.
• ProjectAuthor - This is the author of the project, which can be customized. It is used to identify the author of the project. If you want to share the project with others, you can use this property to indicate the author.

The above are project properties. Next are the properties that determine the conditions for opening the menu. These may be a bit complex, and I will explain them in detail below, along with some example scenarios for setting them.

• RequiredTouch - Whether clicking the model opens the menu. If true, clicking the model opens the menu; if false, clicking the model does not open the menu.
• RequiredSit - Whether sitting on the model is required to open the menu. If true, sitting is required to open the menu; if false, sitting is not required to open the menu. When this is true, the following properties need to be set:
  • SitText - Sets the sit text on the model, which can be used to prompt players to sit.
  • SitTargetOffset - The position offset after sitting. This cannot be <0,0,0>, as it will prevent the Sit event from triggering.
  • ShowMenuOnSit - Whether the menu automatically opens after sitting. If true, the menu automatically opens after sitting; otherwise, it does not.
• RequiredAttach - Whether wearing the item is required to open the menu. For models that require wearing to use, set this property to true. If false, wearing is not required to open the menu. When this is true, you can set:
  • ShowMenuOnAttach - Whether the menu automatically opens after wearing. If true, the menu automatically opens after wearing; otherwise, it does not.
• EnabledWhileSitting - Whether the menu is available while sitting on the model. If true, the menu is available while sitting; if false, the menu is unavailable while sitting.

Remember

If you find these settings complex and are unsure how to configure them, you only need to consider whether you need to enable each feature. EZMenu will handle the rest. Alternatively, you can refer to the Example Scenarios below to understand how to set these properties.

• RememberLastMenu - Whether to remember the last opened menu. If true, the last opened menu is remembered, and the next time the menu is opened, it will automatically open the last menu. If false, the last menu is not remembered, and the main menu is opened every time.
• MenuExpireTime - Sets the expiration time of the menu in seconds. After the menu is opened, it will automatically expire after this time. If set to 0, the menu never expires.
• EnableDebugMode - Whether to enable debug mode. When enabled, some debug information will be output in the chat. This is useful for custom development and debugging. If you do not care about this information, set this property to false.

• Signature - This is the product’s signature information. If your product needs to be shared with others, you can obtain the signature information using the [EZMenu]setup script and fill it into this property. Then replace the [EZMenu]setup script with the [EZMenu]master script. The [EZMenu]setup script can only be used during the creation of material textures. It does not require a signature, but this script cannot be shared with others. Only after replacing [EZMenu]setup with [EZMenu]master can your product be shared with others.

Example Scenarios

Example Scenario 1: No sitting or wearing required, click to open the menu

RequiredTouch: true
RequiredSit: false
RequiredAttach: false
EnabledWhileSitting: true

Example Scenario 2: Sitting required, no wearing required, click to open the menu

RequiredTouch: true
RequiredSit: true
RequiredAttach: false
EnabledWhileSitting: true

Example Scenario 3: Wearing required, no sitting required, click to open the menu

RequiredTouch: true
RequiredSit: false
RequiredAttach: true

Example Scenario 4: No wearing or sitting required, click to open the menu, but menu is unavailable while sitting

RequiredTouch: true
RequiredSit: false
RequiredAttach: false
EnabledWhileSitting: false

Incorrect Settings Examples

Incorrect Example 1: All settings are false, no way to open the menu

RequiredTouch: false
RequiredSit: false
ShowMenuOnSit: false
RequiredAttach: false
ShowMenuOnAttach: false

Incorrect Example 2: Sitting required, but menu is unavailable while sitting (logical contradiction)

RequiredTouch: true
RequiredSit: true
EnabledWhileSitting: false