ScriptInstance.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883
  1. //
  2. // Copyright (c) 2008-2013 the Urho3D project.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. #include "Precompiled.h"
  23. #include "Context.h"
  24. #include "Log.h"
  25. #include "MemoryBuffer.h"
  26. #include "PhysicsEvents.h"
  27. #include "PhysicsWorld.h"
  28. #include "Profiler.h"
  29. #include "ResourceCache.h"
  30. #include "ResourceEvents.h"
  31. #include "Scene.h"
  32. #include "SceneEvents.h"
  33. #include "Script.h"
  34. #include "ScriptFile.h"
  35. #include "ScriptInstance.h"
  36. #include <angelscript.h>
  37. #include "DebugNew.h"
  38. namespace Urho3D
  39. {
  40. static const char* methodDeclarations[] = {
  41. "void Start()",
  42. "void Stop()",
  43. "void DelayedStart()",
  44. "void Update(float)",
  45. "void PostUpdate(float)",
  46. "void FixedUpdate(float)",
  47. "void FixedPostUpdate(float)",
  48. "void Load(Deserializer&)",
  49. "void Save(Serializer&)",
  50. "void ReadNetworkUpdate(Deserializer&)",
  51. "void WriteNetworkUpdate(Serializer&)",
  52. "void ApplyAttributes()",
  53. "void TransformChanged()"
  54. };
  55. ScriptInstance::ScriptInstance(Context* context) :
  56. Component(context),
  57. script_(GetSubsystem<Script>()),
  58. scriptObject_(0),
  59. fixedUpdateFps_(0),
  60. fixedUpdateInterval_(0.0f),
  61. fixedUpdateAcc_(0.0f),
  62. fixedPostUpdateAcc_(0.0f),
  63. subscribed_(false),
  64. subscribedPostFixed_(false)
  65. {
  66. ClearScriptMethods();
  67. ClearScriptAttributes();
  68. }
  69. ScriptInstance::~ScriptInstance()
  70. {
  71. ReleaseObject();
  72. }
  73. void ScriptInstance::RegisterObject(Context* context)
  74. {
  75. context->RegisterFactory<ScriptInstance>(LOGIC_CATEGORY);
  76. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BOOL, "Is Enabled", IsEnabled, SetEnabled, bool, true, AM_DEFAULT);
  77. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Delayed Method Calls", GetDelayedCallsAttr, SetDelayedCallsAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  78. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_RESOURCEREF, "Script File", GetScriptFileAttr, SetScriptFileAttr, ResourceRef, ResourceRef(ScriptFile::GetTypeStatic()), AM_DEFAULT);
  79. REF_ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_STRING, "Class Name", GetClassName, SetClassName, String, String::EMPTY, AM_DEFAULT);
  80. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_INT, "Fixed Update FPS", GetFixedUpdateFps, SetFixedUpdateFps, int, 0, AM_DEFAULT);
  81. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_FLOAT, "Time Accumulator", GetFixedUpdateAccAttr, SetFixedUpdateAccAttr, float, 0.0f, AM_FILE | AM_NOEDIT);
  82. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Data", GetScriptDataAttr, SetScriptDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  83. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Network Data", GetScriptNetworkDataAttr, SetScriptNetworkDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_NET | AM_NOEDIT);
  84. }
  85. void ScriptInstance::OnSetAttribute(const AttributeInfo& attr, const Variant& src)
  86. {
  87. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  88. {
  89. // The component / node to which the ID refers to may not be in the scene yet, and furthermore the ID must go through the
  90. // SceneResolver first. Delay searching for the object to ApplyAttributes
  91. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  92. idAttributes_[attrPtr] = src.GetUInt();
  93. }
  94. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  95. {
  96. Resource*& resourcePtr = *(reinterpret_cast<Resource**>(attr.ptr_));
  97. // Decrease reference count of the old object if any, then increment the new
  98. if (resourcePtr)
  99. resourcePtr->ReleaseRef();
  100. const ResourceRef& ref = src.GetResourceRef();
  101. resourcePtr = GetSubsystem<ResourceCache>()->GetResource(ref.type_, ref.name_);
  102. if (resourcePtr)
  103. resourcePtr->AddRef();
  104. }
  105. else
  106. Serializable::OnSetAttribute(attr, src);
  107. }
  108. void ScriptInstance::OnGetAttribute(const AttributeInfo& attr, Variant& dest) const
  109. {
  110. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  111. // Get ID's for node / component handle attributes
  112. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  113. {
  114. // If a cached ID value has been stored, return it instead of querying from the actual object
  115. // (the object handle is likely null at that point)
  116. HashMap<AttributeInfo*, unsigned>::ConstIterator i = idAttributes_.Find(attrPtr);
  117. if (i != idAttributes_.End())
  118. dest = i->second_;
  119. else if (attr.mode_ & AM_NODEID)
  120. {
  121. Node* node = *(reinterpret_cast<Node**>(attr.ptr_));
  122. unsigned nodeID = node ? node->GetID() : 0;
  123. dest = nodeID;
  124. }
  125. else
  126. {
  127. Component* component = *(reinterpret_cast<Component**>(attr.ptr_));
  128. unsigned componentID = component ? component->GetID() : 0;
  129. dest = componentID;
  130. }
  131. }
  132. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  133. {
  134. Resource* resource = *(reinterpret_cast<Resource**>(attr.ptr_));
  135. // If resource is non-null get its type and name hash. Otherwise get type from the default value
  136. dest = GetResourceRef(resource, attr.defaultValue_.GetResourceRef().type_);
  137. }
  138. else
  139. Serializable::OnGetAttribute(attr, dest);
  140. }
  141. void ScriptInstance::ApplyAttributes()
  142. {
  143. // Apply node / component ID attributes now (find objects from the scene and assign to the object handles)
  144. for (HashMap<AttributeInfo*, unsigned>::Iterator i = idAttributes_.Begin(); i != idAttributes_.End(); ++i)
  145. {
  146. AttributeInfo& attr = *i->first_;
  147. if (attr.mode_ & AM_NODEID)
  148. {
  149. Node*& nodePtr = *(reinterpret_cast<Node**>(attr.ptr_));
  150. // Decrease reference count of the old object if any, then increment the new
  151. if (nodePtr)
  152. nodePtr->ReleaseRef();
  153. nodePtr = GetScene()->GetNode(i->second_);
  154. if (nodePtr)
  155. nodePtr->AddRef();
  156. }
  157. else if (attr.mode_ & AM_COMPONENTID)
  158. {
  159. Component*& componentPtr = *(reinterpret_cast<Component**>(attr.ptr_));
  160. if (componentPtr)
  161. componentPtr->ReleaseRef();
  162. componentPtr = GetScene()->GetComponent(i->second_);
  163. if (componentPtr)
  164. componentPtr->AddRef();
  165. }
  166. }
  167. idAttributes_.Clear();
  168. if (scriptObject_ && methods_[METHOD_APPLYATTRIBUTES])
  169. scriptFile_->Execute(scriptObject_, methods_[METHOD_APPLYATTRIBUTES]);
  170. }
  171. void ScriptInstance::OnSetEnabled()
  172. {
  173. UpdateEventSubscription();
  174. }
  175. bool ScriptInstance::CreateObject(ScriptFile* scriptFile, const String& className)
  176. {
  177. className_ = String::EMPTY; // Do not create object during SetScriptFile()
  178. SetScriptFile(scriptFile);
  179. SetClassName(className);
  180. return scriptObject_ != 0;
  181. }
  182. void ScriptInstance::SetScriptFile(ScriptFile* scriptFile)
  183. {
  184. if (scriptFile == scriptFile_ && scriptObject_)
  185. return;
  186. ReleaseObject();
  187. // Unsubscribe from the reload event of previous script file (if any), then subscribe to the new
  188. if (scriptFile_)
  189. {
  190. UnsubscribeFromEvent(scriptFile_, E_RELOADSTARTED);
  191. UnsubscribeFromEvent(scriptFile_, E_RELOADFINISHED);
  192. }
  193. if (scriptFile)
  194. {
  195. SubscribeToEvent(scriptFile, E_RELOADSTARTED, HANDLER(ScriptInstance, HandleScriptFileReload));
  196. SubscribeToEvent(scriptFile, E_RELOADFINISHED, HANDLER(ScriptInstance, HandleScriptFileReloadFinished));
  197. }
  198. scriptFile_ = scriptFile;
  199. CreateObject();
  200. MarkNetworkUpdate();
  201. }
  202. void ScriptInstance::SetClassName(const String& className)
  203. {
  204. if (className == className_ && scriptObject_)
  205. return;
  206. ReleaseObject();
  207. className_ = className;
  208. CreateObject();
  209. MarkNetworkUpdate();
  210. }
  211. void ScriptInstance::SetFixedUpdateFps(int fps)
  212. {
  213. fixedUpdateFps_ = Max(fps, 0);
  214. fixedUpdateInterval_ = fixedUpdateFps_ ? (1.0f / fixedUpdateFps_) : 0.0f;
  215. fixedUpdateAcc_ = 0.0f;
  216. fixedPostUpdateAcc_ = 0.0f;
  217. MarkNetworkUpdate();
  218. }
  219. bool ScriptInstance::Execute(const String& declaration, const VariantVector& parameters)
  220. {
  221. if (!scriptObject_)
  222. return false;
  223. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  224. return scriptFile_->Execute(scriptObject_, method, parameters);
  225. }
  226. bool ScriptInstance::Execute(asIScriptFunction* method, const VariantVector& parameters)
  227. {
  228. if (!method || !scriptObject_)
  229. return false;
  230. return scriptFile_->Execute(scriptObject_, method, parameters);
  231. }
  232. void ScriptInstance::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  233. {
  234. if (!scriptObject_)
  235. return;
  236. DelayedCall call;
  237. call.period_ = call.delay_ = Max(delay, 0.0f);
  238. call.repeat_ = repeat;
  239. call.declaration_ = declaration;
  240. call.parameters_ = parameters;
  241. delayedCalls_.Push(call);
  242. // Make sure we are registered to the scene update event, because delayed calls are executed there
  243. if (!subscribed_)
  244. UpdateEventSubscription();
  245. }
  246. void ScriptInstance::ClearDelayedExecute(const String& declaration)
  247. {
  248. if (declaration.Empty())
  249. delayedCalls_.Clear();
  250. else
  251. {
  252. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End();)
  253. {
  254. if (declaration == i->declaration_)
  255. i = delayedCalls_.Erase(i);
  256. else
  257. ++i;
  258. }
  259. }
  260. }
  261. void ScriptInstance::AddEventHandler(StringHash eventType, const String& handlerName)
  262. {
  263. if (!scriptObject_)
  264. return;
  265. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  266. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  267. if (!method)
  268. {
  269. declaration = "void " + handlerName + "()";
  270. method = scriptFile_->GetMethod(scriptObject_, declaration);
  271. if (!method)
  272. {
  273. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  274. return;
  275. }
  276. }
  277. SubscribeToEvent(eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  278. }
  279. void ScriptInstance::AddEventHandler(Object* sender, StringHash eventType, const String& handlerName)
  280. {
  281. if (!scriptObject_)
  282. return;
  283. if (!sender)
  284. {
  285. LOGERROR("Null event sender for event " + String(eventType) + ", handler " + handlerName);
  286. return;
  287. }
  288. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  289. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  290. if (!method)
  291. {
  292. declaration = "void " + handlerName + "()";
  293. method = scriptFile_->GetMethod(scriptObject_, declaration);
  294. if (!method)
  295. {
  296. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  297. return;
  298. }
  299. }
  300. SubscribeToEvent(sender, eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  301. }
  302. void ScriptInstance::SetScriptFileAttr(ResourceRef value)
  303. {
  304. ResourceCache* cache = GetSubsystem<ResourceCache>();
  305. SetScriptFile(cache->GetResource<ScriptFile>(value.name_));
  306. }
  307. void ScriptInstance::SetDelayedCallsAttr(PODVector<unsigned char> value)
  308. {
  309. MemoryBuffer buf(value);
  310. delayedCalls_.Resize(buf.ReadVLE());
  311. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  312. {
  313. i->period_ = buf.ReadFloat();
  314. i->delay_ = buf.ReadFloat();
  315. i->repeat_ = buf.ReadBool();
  316. i->declaration_ = buf.ReadString();
  317. i->parameters_ = buf.ReadVariantVector();
  318. }
  319. if (scriptObject_ && delayedCalls_.Size() && !subscribed_)
  320. UpdateEventSubscription();
  321. }
  322. void ScriptInstance::SetFixedUpdateAccAttr(float value)
  323. {
  324. fixedUpdateAcc_ = value;
  325. fixedPostUpdateAcc_ = value;
  326. }
  327. void ScriptInstance::SetScriptDataAttr(PODVector<unsigned char> data)
  328. {
  329. if (scriptObject_ && methods_[METHOD_LOAD])
  330. {
  331. MemoryBuffer buf(data);
  332. VariantVector parameters;
  333. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  334. scriptFile_->Execute(scriptObject_, methods_[METHOD_LOAD], parameters);
  335. }
  336. }
  337. void ScriptInstance::SetScriptNetworkDataAttr(PODVector<unsigned char> data)
  338. {
  339. if (scriptObject_ && methods_[METHOD_READNETWORKUPDATE])
  340. {
  341. MemoryBuffer buf(data);
  342. VariantVector parameters;
  343. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  344. scriptFile_->Execute(scriptObject_, methods_[METHOD_READNETWORKUPDATE], parameters);
  345. }
  346. }
  347. ResourceRef ScriptInstance::GetScriptFileAttr() const
  348. {
  349. return GetResourceRef(scriptFile_, ScriptFile::GetTypeStatic());
  350. }
  351. PODVector<unsigned char> ScriptInstance::GetDelayedCallsAttr() const
  352. {
  353. VectorBuffer buf;
  354. buf.WriteVLE(delayedCalls_.Size());
  355. for (Vector<DelayedCall>::ConstIterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  356. {
  357. buf.WriteFloat(i->period_);
  358. buf.WriteFloat(i->delay_);
  359. buf.WriteBool(i->repeat_);
  360. buf.WriteString(i->declaration_);
  361. buf.WriteVariantVector(i->parameters_);
  362. }
  363. return buf.GetBuffer();
  364. }
  365. float ScriptInstance::GetFixedUpdateAccAttr() const
  366. {
  367. return fixedUpdateAcc_;
  368. }
  369. PODVector<unsigned char> ScriptInstance::GetScriptDataAttr() const
  370. {
  371. if (!scriptObject_ || !methods_[METHOD_SAVE])
  372. return PODVector<unsigned char>();
  373. else
  374. {
  375. VectorBuffer buf;
  376. VariantVector parameters;
  377. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  378. scriptFile_->Execute(scriptObject_, methods_[METHOD_SAVE], parameters);
  379. return buf.GetBuffer();
  380. }
  381. }
  382. PODVector<unsigned char> ScriptInstance::GetScriptNetworkDataAttr() const
  383. {
  384. if (!scriptObject_ || !methods_[METHOD_WRITENETWORKUPDATE])
  385. return PODVector<unsigned char>();
  386. else
  387. {
  388. VectorBuffer buf;
  389. VariantVector parameters;
  390. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  391. scriptFile_->Execute(scriptObject_, methods_[METHOD_WRITENETWORKUPDATE], parameters);
  392. return buf.GetBuffer();
  393. }
  394. }
  395. void ScriptInstance::OnMarkedDirty(Node* node)
  396. {
  397. // Script functions are not safe from worker threads
  398. Scene* scene = GetScene();
  399. if (scene && scene->IsThreadedUpdate())
  400. {
  401. scene->DelayedMarkedDirty(this);
  402. return;
  403. }
  404. if (scriptObject_ && methods_[METHOD_TRANSFORMCHANGED])
  405. scriptFile_->Execute(scriptObject_, methods_[METHOD_TRANSFORMCHANGED]);
  406. }
  407. void ScriptInstance::CreateObject()
  408. {
  409. if (!scriptFile_ || className_.Empty())
  410. return;
  411. PROFILE(CreateScriptObject);
  412. scriptObject_ = scriptFile_->CreateObject(className_);
  413. if (scriptObject_)
  414. {
  415. // Map script object to script instance with userdata
  416. scriptObject_->SetUserData(this);
  417. GetScriptMethods();
  418. GetScriptAttributes();
  419. UpdateEventSubscription();
  420. if (methods_[METHOD_START])
  421. scriptFile_->Execute(scriptObject_, methods_[METHOD_START]);
  422. }
  423. else
  424. LOGERROR("Failed to create object of class " + className_ + " from " + scriptFile_->GetName());
  425. }
  426. void ScriptInstance::ReleaseObject()
  427. {
  428. if (scriptObject_)
  429. {
  430. if (methods_[METHOD_STOP])
  431. scriptFile_->Execute(scriptObject_, methods_[METHOD_STOP]);
  432. PODVector<StringHash> exceptions;
  433. exceptions.Push(E_RELOADSTARTED);
  434. exceptions.Push(E_RELOADFINISHED);
  435. UnsubscribeFromAllEventsExcept(exceptions, false);
  436. if (node_)
  437. node_->RemoveListener(this);
  438. subscribed_ = false;
  439. subscribedPostFixed_ = false;
  440. ClearScriptMethods();
  441. ClearScriptAttributes();
  442. scriptObject_->SetUserData(0);
  443. scriptObject_->Release();
  444. scriptObject_ = 0;
  445. }
  446. }
  447. void ScriptInstance::ClearScriptMethods()
  448. {
  449. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  450. methods_[i] = 0;
  451. delayedCalls_.Clear();
  452. }
  453. void ScriptInstance::ClearScriptAttributes()
  454. {
  455. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  456. idAttributes_.Clear();
  457. }
  458. void ScriptInstance::GetScriptMethods()
  459. {
  460. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  461. methods_[i] = scriptFile_->GetMethod(scriptObject_, methodDeclarations[i]);
  462. }
  463. void ScriptInstance::GetScriptAttributes()
  464. {
  465. asIScriptEngine* engine = GetSubsystem<Script>()->GetScriptEngine();
  466. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  467. unsigned numProperties = scriptObject_->GetPropertyCount();
  468. for (unsigned i = 0; i < numProperties; ++i)
  469. {
  470. const char* name;
  471. int typeId;
  472. bool isPrivate, isHandle;
  473. scriptObject_->GetObjectType()->GetProperty(i, &name, &typeId, &isPrivate);
  474. // Hide private variables or ones that begin with an underscore
  475. if (isPrivate || name[0] == '_')
  476. continue;
  477. String typeName = engine->GetTypeDeclaration(typeId);
  478. isHandle = typeName.EndsWith("@");
  479. if (isHandle)
  480. typeName = typeName.Substring(0, typeName.Length() - 1);
  481. AttributeInfo info;
  482. info.mode_ = AM_FILE;
  483. info.name_ = name;
  484. info.ptr_ = scriptObject_->GetAddressOfProperty(i);
  485. if (!isHandle)
  486. {
  487. switch (typeId)
  488. {
  489. case asTYPEID_BOOL:
  490. info.type_ = VAR_BOOL;
  491. break;
  492. case asTYPEID_INT32:
  493. case asTYPEID_UINT32:
  494. info.type_ = VAR_INT;
  495. break;
  496. case asTYPEID_FLOAT:
  497. info.type_ = VAR_FLOAT;
  498. break;
  499. default:
  500. info.type_ = Variant::GetTypeFromName(typeName);
  501. break;
  502. }
  503. }
  504. else
  505. {
  506. // For a handle type, check if it's an Object subclass with a registered factory
  507. ShortStringHash typeHash(typeName);
  508. const HashMap<ShortStringHash, SharedPtr<ObjectFactory> >& factories = context_->GetObjectFactories();
  509. HashMap<ShortStringHash, SharedPtr<ObjectFactory> >::ConstIterator j = factories.Find(typeHash);
  510. if (j != factories.End())
  511. {
  512. // Check base class type. Node & Component are supported as ID attributes, Resource as a resource reference
  513. ShortStringHash baseType = j->second_->GetBaseType();
  514. if (baseType == Node::GetTypeStatic())
  515. {
  516. info.mode_ |= AM_NODEID;
  517. info.type_ = VAR_INT;
  518. }
  519. else if (baseType == Component::GetTypeStatic())
  520. {
  521. info.mode_ |= AM_COMPONENTID;
  522. info.type_ = VAR_INT;
  523. }
  524. else if (baseType == Resource::GetTypeStatic())
  525. {
  526. info.type_ = VAR_RESOURCEREF;
  527. info.defaultValue_ = ResourceRef(typeHash);
  528. }
  529. }
  530. }
  531. if (info.type_ != VAR_NONE)
  532. attributeInfos_.Push(info);
  533. }
  534. }
  535. void ScriptInstance::UpdateEventSubscription()
  536. {
  537. Scene* scene = GetScene();
  538. if (!scene)
  539. {
  540. LOGWARNING("Node is detached from scene, can not subscribe script object to update events");
  541. return;
  542. }
  543. bool enabled = scriptObject_ && IsEnabledEffective();
  544. if (enabled)
  545. {
  546. if (!subscribed_ && (methods_[METHOD_UPDATE] || methods_[METHOD_DELAYEDSTART] || delayedCalls_.Size()))
  547. {
  548. SubscribeToEvent(scene, E_SCENEUPDATE, HANDLER(ScriptInstance, HandleSceneUpdate));
  549. subscribed_ = true;
  550. }
  551. if (!subscribedPostFixed_)
  552. {
  553. if (methods_[METHOD_POSTUPDATE])
  554. SubscribeToEvent(scene, E_SCENEPOSTUPDATE, HANDLER(ScriptInstance, HandleScenePostUpdate));
  555. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  556. if (world)
  557. {
  558. if (methods_[METHOD_FIXEDUPDATE])
  559. SubscribeToEvent(world, E_PHYSICSPRESTEP, HANDLER(ScriptInstance, HandlePhysicsPreStep));
  560. if (methods_[METHOD_FIXEDPOSTUPDATE])
  561. SubscribeToEvent(world, E_PHYSICSPOSTSTEP, HANDLER(ScriptInstance, HandlePhysicsPostStep));
  562. }
  563. else
  564. {
  565. if (methods_[METHOD_FIXEDUPDATE] || methods_[METHOD_FIXEDPOSTUPDATE])
  566. LOGERROR("No physics world, can not subscribe script object to fixed update events");
  567. }
  568. subscribedPostFixed_ = true;
  569. }
  570. if (methods_[METHOD_TRANSFORMCHANGED])
  571. node_->AddListener(this);
  572. }
  573. else
  574. {
  575. if (subscribed_)
  576. {
  577. UnsubscribeFromEvent(scene, E_SCENEUPDATE);
  578. subscribed_ = false;
  579. }
  580. if (subscribedPostFixed_)
  581. {
  582. UnsubscribeFromEvent(scene, E_SCENEPOSTUPDATE);
  583. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  584. if (world)
  585. {
  586. UnsubscribeFromEvent(world, E_PHYSICSPRESTEP);
  587. UnsubscribeFromEvent(world, E_PHYSICSPOSTSTEP);
  588. }
  589. subscribedPostFixed_ = false;
  590. }
  591. if (methods_[METHOD_TRANSFORMCHANGED])
  592. node_->RemoveListener(this);
  593. }
  594. }
  595. void ScriptInstance::HandleSceneUpdate(StringHash eventType, VariantMap& eventData)
  596. {
  597. if (!scriptObject_)
  598. return;
  599. using namespace SceneUpdate;
  600. float timeStep = eventData[P_TIMESTEP].GetFloat();
  601. // Execute delayed calls
  602. for (unsigned i = 0; i < delayedCalls_.Size();)
  603. {
  604. DelayedCall& call = delayedCalls_[i];
  605. bool remove = false;
  606. call.delay_ -= timeStep;
  607. if (call.delay_ <= 0.0f)
  608. {
  609. if (!call.repeat_)
  610. remove = true;
  611. else
  612. call.delay_ += call.period_;
  613. Execute(call.declaration_, call.parameters_);
  614. }
  615. if (remove)
  616. delayedCalls_.Erase(i);
  617. else
  618. ++i;
  619. }
  620. // Execute delayed start before first update
  621. if (methods_[METHOD_DELAYEDSTART])
  622. {
  623. scriptFile_->Execute(scriptObject_, methods_[METHOD_DELAYEDSTART]);
  624. methods_[METHOD_DELAYEDSTART] = 0; // Only execute once
  625. }
  626. if (methods_[METHOD_UPDATE])
  627. {
  628. VariantVector parameters;
  629. parameters.Push(timeStep);
  630. scriptFile_->Execute(scriptObject_, methods_[METHOD_UPDATE], parameters);
  631. }
  632. }
  633. void ScriptInstance::HandleScenePostUpdate(StringHash eventType, VariantMap& eventData)
  634. {
  635. if (!scriptObject_)
  636. return;
  637. using namespace ScenePostUpdate;
  638. VariantVector parameters;
  639. parameters.Push(eventData[P_TIMESTEP]);
  640. scriptFile_->Execute(scriptObject_, methods_[METHOD_POSTUPDATE], parameters);
  641. }
  642. void ScriptInstance::HandlePhysicsPreStep(StringHash eventType, VariantMap& eventData)
  643. {
  644. if (!scriptObject_)
  645. return;
  646. using namespace PhysicsPreStep;
  647. if (!fixedUpdateFps_)
  648. {
  649. VariantVector parameters;
  650. parameters.Push(eventData[P_TIMESTEP]);
  651. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  652. }
  653. else
  654. {
  655. float timeStep = eventData[P_TIMESTEP].GetFloat();
  656. fixedUpdateAcc_ += timeStep;
  657. if (fixedUpdateAcc_ >= fixedUpdateInterval_)
  658. {
  659. fixedUpdateAcc_ = fmodf(fixedUpdateAcc_, fixedUpdateInterval_);
  660. VariantVector parameters;
  661. parameters.Push(fixedUpdateInterval_);
  662. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  663. }
  664. }
  665. }
  666. void ScriptInstance::HandlePhysicsPostStep(StringHash eventType, VariantMap& eventData)
  667. {
  668. if (!scriptObject_)
  669. return;
  670. using namespace PhysicsPostStep;
  671. if (!fixedUpdateFps_)
  672. {
  673. VariantVector parameters;
  674. parameters.Push(eventData[P_TIMESTEP]);
  675. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  676. }
  677. else
  678. {
  679. float timeStep = eventData[P_TIMESTEP].GetFloat();
  680. fixedPostUpdateAcc_ += timeStep;
  681. if (fixedPostUpdateAcc_ >= fixedUpdateInterval_)
  682. {
  683. fixedPostUpdateAcc_ = fmodf(fixedPostUpdateAcc_, fixedUpdateInterval_);
  684. VariantVector parameters;
  685. parameters.Push(fixedUpdateInterval_);
  686. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  687. }
  688. }
  689. }
  690. void ScriptInstance::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  691. {
  692. if (!IsEnabledEffective() || !scriptFile_ || !scriptObject_)
  693. return;
  694. asIScriptFunction* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  695. VariantVector parameters;
  696. if (method->GetParamCount() > 0)
  697. {
  698. parameters.Push(Variant((void*)&eventType));
  699. parameters.Push(Variant((void*)&eventData));
  700. }
  701. scriptFile_->Execute(scriptObject_, method, parameters);
  702. }
  703. void ScriptInstance::HandleScriptFileReload(StringHash eventType, VariantMap& eventData)
  704. {
  705. ReleaseObject();
  706. }
  707. void ScriptInstance::HandleScriptFileReloadFinished(StringHash eventType, VariantMap& eventData)
  708. {
  709. if (!className_.Empty())
  710. CreateObject();
  711. }
  712. Context* GetScriptContext()
  713. {
  714. return static_cast<Script*>(asGetActiveContext()->GetEngine()->GetUserData())->GetContext();
  715. }
  716. ScriptInstance* GetScriptContextInstance()
  717. {
  718. asIScriptContext* context = asGetActiveContext();
  719. asIScriptObject* object = context ? static_cast<asIScriptObject*>(context->GetThisPointer()) : 0;
  720. if (object)
  721. return static_cast<ScriptInstance*>(object->GetUserData());
  722. else
  723. return 0;
  724. }
  725. Node* GetScriptContextNode()
  726. {
  727. ScriptInstance* instance = GetScriptContextInstance();
  728. return instance ? instance->GetNode() : 0;
  729. }
  730. Scene* GetScriptContextScene()
  731. {
  732. Scene* scene = 0;
  733. Node* node = GetScriptContextNode();
  734. if (node)
  735. scene = node->GetScene();
  736. // If null, try to get the default scene
  737. if (!scene)
  738. scene = GetScriptContext()->GetSubsystem<Script>()->GetDefaultScene();
  739. return scene;
  740. }
  741. ScriptEventListener* GetScriptContextEventListener()
  742. {
  743. // If the context has an object and that object has user data set, try and get the ScriptInstance, otherwise try and get a ScriptFile.
  744. asIScriptContext* context = asGetActiveContext();
  745. if (context)
  746. {
  747. asIScriptObject* object = static_cast<asIScriptObject*>(context->GetThisPointer());
  748. if (object && object->GetUserData())
  749. return GetScriptContextInstance();
  750. else
  751. return GetScriptContextFile();
  752. }
  753. else
  754. return 0;
  755. }
  756. Object* GetScriptContextEventListenerObject()
  757. {
  758. return dynamic_cast<Object*>(GetScriptContextEventListener());
  759. }
  760. }