Castle Game Engine

Class TAbstractScriptNode

Description
Hierarchy
Nested Types
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TAbstractScriptNode = class(TAbstractChildNode)

Description

Abstract node type for all scripting nodes.

Hierarchy

Overview

Nested Types

Published TScriptType = (...);

Methods

Protected procedure ExecuteScript(const FunctionName: string; ReceivedValue: TX3DField; const Time: TX3DTime);
Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public destructor Destroy; override;
Public procedure ResetLastEventTimes;
Public procedure CreateNode; override;
Public class function ClassX3DType: string; override;
Public procedure SetUrl(const Value: array of string); overload;
Public procedure SetUrl(const Value: TCastleStringList); overload;

Properties

Public property Initialized: boolean read FInitialized write SetInitialized default false;
Public property FdUrl: TMFString read FFdUrl;

Description

Nested Types

Published TScriptType = (...);
 
Values
  • stCompiled
  • stCastleScript

Methods

Protected procedure ExecuteScript(const FunctionName: string; ReceivedValue: TX3DField; const Time: TX3DTime);
 
Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
 
Public destructor Destroy; override;
 
Public procedure ResetLastEventTimes;

Clear the memory when the last events were generated from this script.

TCasScriptVRMLValuesList.ResetLastEventTimes

See also
TX3DRoute.ResetLastEventTime
Clear the memory when the last event passed through this route.
Public procedure CreateNode; override;

Automatically generated node properties.

Do not edit this file manually! To add new properties: - add them to the text files in tools/internal/x3d-nodes-to-pascal/nodes-specification/ , - and regenerate include files by running x3d-nodes-to-pascal

Public class function ClassX3DType: string; override;
 
Public procedure SetUrl(const Value: array of string); overload;
 
Public procedure SetUrl(const Value: TCastleStringList); overload;
 

Properties

Public property Initialized: boolean read FInitialized write SetInitialized default false;

Initialize / shutdown of the script. Read this to know current script state, write this is to actually initialize/shutdown if needed.

Note that the script node doesn't initialize itself at any point. Reason: there's no comfortable moment to do this: 1. in constructor some routes and such are not initialized yet, and we should initialize script after whole VRML graph is loaded. 2. tricks with BeforeTraverse, like used for TInlineNode, are not Ok, since scripts must work even when they are in the inactive part of VRML graph.

If you want scripts to work, you have to initialize them yourself. If you use TCastleSceneCore, this will be done for you automatically when you change TCastleSceneCore.ProcessEvents, so it's not a problem in practice.

Public property FdUrl: TMFString read FFdUrl;

Internal wrapper for property Url. This wrapper API may change, we advise to access simpler Url instead.

Generated by PasDoc 0.16.0.