Javascript SharedObjects - Revision history

Marian at 10:41, 9 September 2024

2024-09-09T10:41:55Z

Marian at 10:41, 9 September 2024

2024-09-09T10:41:39Z

Marian at 10:39, 9 September 2024

2024-09-09T10:39:56Z

Marian: /* Methods */

2024-09-03T13:12:20Z

‎Methods

Marian: /* General */

2024-09-03T13:11:24Z

‎General

Marian: /* General */

2024-09-03T13:08:26Z

‎General

Marian: /* General */

2024-09-03T13:07:24Z

‎General

Marian: /* General */

2024-09-03T13:06:58Z

‎General

Marian: Created page with "== General == == Constructor == * '''new Engine.SharedObjects''' Create an object implementing the interface to shared objects. == Methods == * '''get(name)''' Retrieve a..."

2024-09-03T11:06:38Z

Created page with "== General == == Constructor == * '''new Engine.SharedObjects''' Create an object implementing the interface to shared objects. == Methods == * '''get(name)''' Retrieve a..."

New page

== General ==

== Constructor ==

* '''new Engine.SharedObjects'''
Create an object implementing the interface to shared objects.

== Methods ==

* '''get(name)'''
Retrieve a copy of a shared object. 
Parameters: 
'''name''' Object name. 
Return: 
Object or null if not found.

* '''set(name,obj[,persistent[,assignPropsFlags]])'''
* '''create(name,obj[,persistent[,assignPropsFlags]])'''
Set or create a shared object. 
''create'' does not replace an existing object. 
The shared objects list will always keep a copy of the given object. 
Parameters: 
'''name''' Object name. 
'''obj''' Object value. Must be a non null object. 
'''persistent''' Boolean. True if object is persistent (will not be deleted when script is unloaded). False to delete object when script is unloaded. Default: false. 
'''assignPropsFlags''' Integer. Flags to be passed to Object.assignProps() function. Object.AssignDeepCopy and Object.AssignFreezeCopy will be forced by javascript. 
Return: 
Numeric number of copied properties. Negative if not set/created.

* '''clear(name)'''
Parameters: 
'''name''' Object name. 

* '''clearAll([owned])'''
Clear all shared objects. 
Parameters: 
'''owned''' Boolean. True to clear owned objects only. False to clear all shared objects. 

* '''exists(name)'''
Parameters: 
'''name''' Object name. 
Return: 
True if object exists, false otherwise.

* '''description(name)'''
Retrieve the description of a shared object. 
Parameters: 
'''name''' Object name. 
Return: 
Object with variable description, null if not found. 

Description: 
'''name''' Object name. 
'''owned''' Boolean. True if calling script is owning the variable, false otherwise. 
'''persistent''' Boolean. True if variable is persistent (will not be deleted if script creating it is unloaded), false otherwise.

← Older revision		Revision as of 10:41, 9 September 2024
Line 7:		Line 7:

	See [[Javascript Object\|Object]].assignProps() function.		See [[Javascript Object\|Object]].assignProps() function.
		+

	== Constructor ==		== Constructor ==

@@ Line 67: / Line 67: @@
 '''owned''' Boolean. True if calling script is owning the variable, false otherwise.<br/>
 '''persistent''' Boolean. True if variable is persistent (will not be deleted if script creating it is unloaded), false otherwise.<br/>
 [[Category:Javascript]]

← Older revision		Revision as of 10:39, 9 September 2024
Line 67:		Line 67:
	'''owned''' Boolean. True if calling script is owning the variable, false otherwise.<br/>		'''owned''' Boolean. True if calling script is owning the variable, false otherwise.<br/>
	'''persistent''' Boolean. True if variable is persistent (will not be deleted if script creating it is unloaded), false otherwise.<br/>		'''persistent''' Boolean. True if variable is persistent (will not be deleted if script creating it is unloaded), false otherwise.<br/>
		+
		+
		+	[[Category:Javascript]]

@@ Line 21: / Line 21: @@
 '''name''' Object name.<br/>
 Return:<br/>
-Object or null if not found.
+Object (deep copy of existing) or null if not found.
@@ Line 28: / Line 28: @@
 Set or create a shared object.<br/>
 ''create'' does not replace an existing object.<br>
-The shared objects list will always keep a copy of the given object.<br/>
+The shared objects list will always keep a deep copy of the given object.<br/>
 Parameters:<br/>
 '''name''' Object name.<br/>

@@ Line 1: / Line 1: @@
 == General ==
-Shared objects are kept and returned copy
+When set the module keeps a copy of the value.<br/>
 See [[Javascript Object|Object]].assignProps() function.

@@ Line 3: / Line 3: @@
 Shared objects
-See [[Javascript Object|Object]] assignProps() function.
+See [[Javascript Object|Object]].assignProps() function.
 Constructor of an Object object.

← Older revision		Revision as of 13:06, 3 September 2024
Line 1:		Line 1:
	== General ==		== General ==
		+
		+	Shared objects
		+
		+	See [[Javascript Object\|Object]] assignProps() function.
		+	Constructor of an Object object.
		+
		+
		+	Constructor of an Object object.

	== Constructor ==		== Constructor ==